Mercurial > hg > octave-lyh

annotate scripts/plot/xlim.m @ 13083:0e231bbd78bc

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
codesprint: demos for xlim, ylim, and zlim * xlim.m, ylim.m, zlim.m: New demos. Mark as tested.
author John W. Eaton <jwe@octave.org>
date Sat, 03 Sep 2011 17:27:15 -0400
parents c792872f8942
children 5553412c6614
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
11523
fd0a3ac60b0e update copyright notices
John W. Eaton <jwe@octave.org>
parents: 11189
diff changeset
1 ## Copyright (C) 2007-2011 David Bateman
7050
bd56a0609c4f [project @ 2007-10-23 12:02:17 by dbateman]
dbateman
parents:
diff changeset
2 ##
bd56a0609c4f [project @ 2007-10-23 12:02:17 by dbateman]
dbateman
parents:
diff changeset
3 ## This file is part of Octave.
bd56a0609c4f [project @ 2007-10-23 12:02:17 by dbateman]
dbateman
parents:
diff changeset
4 ##
bd56a0609c4f [project @ 2007-10-23 12:02:17 by dbateman]
dbateman
parents:
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
bd56a0609c4f [project @ 2007-10-23 12:02:17 by dbateman]
dbateman
parents:
diff changeset
6 ## under the terms of the GNU General Public License as published by
bd56a0609c4f [project @ 2007-10-23 12:02:17 by dbateman]
dbateman
parents:
diff changeset
7 ## the Free Software Foundation; either version 3 of the License, or (at
bd56a0609c4f [project @ 2007-10-23 12:02:17 by dbateman]
dbateman
parents:
diff changeset
8 ## your option) any later version.
bd56a0609c4f [project @ 2007-10-23 12:02:17 by dbateman]
dbateman
parents:
diff changeset
9 ##
bd56a0609c4f [project @ 2007-10-23 12:02:17 by dbateman]
dbateman
parents:
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
bd56a0609c4f [project @ 2007-10-23 12:02:17 by dbateman]
dbateman
parents:
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
bd56a0609c4f [project @ 2007-10-23 12:02:17 by dbateman]
dbateman
parents:
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
bd56a0609c4f [project @ 2007-10-23 12:02:17 by dbateman]
dbateman
parents:
diff changeset
13 ## General Public License for more details.
bd56a0609c4f [project @ 2007-10-23 12:02:17 by dbateman]
dbateman
parents:
diff changeset
14 ##
bd56a0609c4f [project @ 2007-10-23 12:02:17 by dbateman]
dbateman
parents:
diff changeset
15 ## You should have received a copy of the GNU General Public License
bd56a0609c4f [project @ 2007-10-23 12:02:17 by dbateman]
dbateman
parents:
diff changeset
16 ## along with Octave; see the file COPYING. If not, see
bd56a0609c4f [project @ 2007-10-23 12:02:17 by dbateman]
dbateman
parents:
diff changeset
17 ## <http://www.gnu.org/licenses/>.
bd56a0609c4f [project @ 2007-10-23 12:02:17 by dbateman]
dbateman
parents:
diff changeset
18
bd56a0609c4f [project @ 2007-10-23 12:02:17 by dbateman]
dbateman
parents:
diff changeset
19 ## -*- texinfo -*-
10793
be55736a0783 Grammarcheck the documentation from m-files.
Rik <octave@nomad.inbox5.com>
parents: 9245
diff changeset
20 ## @deftypefn {Function File} {@var{xl} =} xlim ()
7050
bd56a0609c4f [project @ 2007-10-23 12:02:17 by dbateman]
dbateman
parents:
diff changeset
21 ## @deftypefnx {Function File} {} xlim (@var{xl})
bd56a0609c4f [project @ 2007-10-23 12:02:17 by dbateman]
dbateman
parents:
diff changeset
22 ## @deftypefnx {Function File} {@var{m} =} xlim ('mode')
bd56a0609c4f [project @ 2007-10-23 12:02:17 by dbateman]
dbateman
parents:
diff changeset
23 ## @deftypefnx {Function File} {} xlim (@var{m})
bd56a0609c4f [project @ 2007-10-23 12:02:17 by dbateman]
dbateman
parents:
diff changeset
24 ## @deftypefnx {Function File} {} xlim (@var{h}, @dots{})
9209
923c7cb7f13f Simplify TeXinfo files by eliminating redundant @iftex followed by @tex construction.
Rik <rdrider0-list@yahoo.com>
parents: 9040
diff changeset
25 ## Get or set the limits of the x-axis of the current plot. Called without
923c7cb7f13f Simplify TeXinfo files by eliminating redundant @iftex followed by @tex construction.
Rik <rdrider0-list@yahoo.com>
parents: 9040
diff changeset
26 ## arguments @code{xlim} returns the x-axis limits of the current plot.
923c7cb7f13f Simplify TeXinfo files by eliminating redundant @iftex followed by @tex construction.
Rik <rdrider0-list@yahoo.com>
parents: 9040
diff changeset
27 ## If passed a two element vector @var{xl}, the limits of the x-axis are set
7050
bd56a0609c4f [project @ 2007-10-23 12:02:17 by dbateman]
dbateman
parents:
diff changeset
28 ## to this value.
bd56a0609c4f [project @ 2007-10-23 12:02:17 by dbateman]
dbateman
parents:
diff changeset
29 ##
9209
923c7cb7f13f Simplify TeXinfo files by eliminating redundant @iftex followed by @tex construction.
Rik <rdrider0-list@yahoo.com>
parents: 9040
diff changeset
30 ## The current mode for calculation of the x-axis can be returned with a
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
31 ## call @code{xlim ('mode')}, and can be either 'auto' or 'manual'. The
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
32 ## current plotting mode can be set by passing either 'auto' or 'manual'
7050
bd56a0609c4f [project @ 2007-10-23 12:02:17 by dbateman]
dbateman
parents:
diff changeset
33 ## as the argument.
bd56a0609c4f [project @ 2007-10-23 12:02:17 by dbateman]
dbateman
parents:
diff changeset
34 ##
11189
a3cb42b394eb Fix typos in docstring and demo string.
Rik <octave@nomad.inbox5.com>
parents: 10793
diff changeset
35 ## If passed a handle as the first argument, then operate on this handle
7050
bd56a0609c4f [project @ 2007-10-23 12:02:17 by dbateman]
dbateman
parents:
diff changeset
36 ## rather than the current axes handle.
bd56a0609c4f [project @ 2007-10-23 12:02:17 by dbateman]
dbateman
parents:
diff changeset
37 ## @seealso{ylim, zlim, set, get, gca}
bd56a0609c4f [project @ 2007-10-23 12:02:17 by dbateman]
dbateman
parents:
diff changeset
38 ## @end deftypefn
bd56a0609c4f [project @ 2007-10-23 12:02:17 by dbateman]
dbateman
parents:
diff changeset
39
bd56a0609c4f [project @ 2007-10-23 12:02:17 by dbateman]
dbateman
parents:
diff changeset
40 function retval = xlim (varargin)
7208
a730e47fda4d [project @ 2007-11-28 02:32:41 by jwe]
jwe
parents: 7050
diff changeset
41 ret = __axes_limits__ ("xlim", varargin{:});
7050
bd56a0609c4f [project @ 2007-10-23 12:02:17 by dbateman]
dbateman
parents:
diff changeset
42
bd56a0609c4f [project @ 2007-10-23 12:02:17 by dbateman]
dbateman
parents:
diff changeset
43 if (! isempty (ret))
bd56a0609c4f [project @ 2007-10-23 12:02:17 by dbateman]
dbateman
parents:
diff changeset
44 retval = ret;
bd56a0609c4f [project @ 2007-10-23 12:02:17 by dbateman]
dbateman
parents:
diff changeset
45 endif
bd56a0609c4f [project @ 2007-10-23 12:02:17 by dbateman]
dbateman
parents:
diff changeset
46 endfunction
13083
0e231bbd78bc codesprint: demos for xlim, ylim, and zlim
John W. Eaton <jwe@octave.org>
parents: 11587
diff changeset
47
0e231bbd78bc codesprint: demos for xlim, ylim, and zlim
John W. Eaton <jwe@octave.org>
parents: 11587
diff changeset
48 %!demo
0e231bbd78bc codesprint: demos for xlim, ylim, and zlim
John W. Eaton <jwe@octave.org>
parents: 11587
diff changeset
49 %! clf ();
0e231bbd78bc codesprint: demos for xlim, ylim, and zlim
John W. Eaton <jwe@octave.org>
parents: 11587
diff changeset
50 %! line ();
0e231bbd78bc codesprint: demos for xlim, ylim, and zlim
John W. Eaton <jwe@octave.org>
parents: 11587
diff changeset
51 %! xlim ([0.2, 0.8]);
0e231bbd78bc codesprint: demos for xlim, ylim, and zlim
John W. Eaton <jwe@octave.org>
parents: 11587
diff changeset
52 %! title ("xlim is [0.2, 0.8]");
0e231bbd78bc codesprint: demos for xlim, ylim, and zlim
John W. Eaton <jwe@octave.org>
parents: 11587
diff changeset
53 %! assert (xlim (), [0.2, 0.8]);
0e231bbd78bc codesprint: demos for xlim, ylim, and zlim
John W. Eaton <jwe@octave.org>
parents: 11587
diff changeset
54
0e231bbd78bc codesprint: demos for xlim, ylim, and zlim
John W. Eaton <jwe@octave.org>
parents: 11587
diff changeset
55 %!demo
0e231bbd78bc codesprint: demos for xlim, ylim, and zlim
John W. Eaton <jwe@octave.org>
parents: 11587
diff changeset
56 %! clf ();
0e231bbd78bc codesprint: demos for xlim, ylim, and zlim
John W. Eaton <jwe@octave.org>
parents: 11587
diff changeset
57 %! line ();
0e231bbd78bc codesprint: demos for xlim, ylim, and zlim
John W. Eaton <jwe@octave.org>
parents: 11587
diff changeset
58 %! xlim ('auto');
0e231bbd78bc codesprint: demos for xlim, ylim, and zlim
John W. Eaton <jwe@octave.org>
parents: 11587
diff changeset
59 %! title ("xlim is auto");
0e231bbd78bc codesprint: demos for xlim, ylim, and zlim
John W. Eaton <jwe@octave.org>
parents: 11587
diff changeset
60 %! assert (xlim ("mode"), "auto");
0e231bbd78bc codesprint: demos for xlim, ylim, and zlim
John W. Eaton <jwe@octave.org>
parents: 11587
diff changeset
61
0e231bbd78bc codesprint: demos for xlim, ylim, and zlim
John W. Eaton <jwe@octave.org>
parents: 11587
diff changeset
62 %!demo
0e231bbd78bc codesprint: demos for xlim, ylim, and zlim
John W. Eaton <jwe@octave.org>
parents: 11587
diff changeset
63 %! clf ();
0e231bbd78bc codesprint: demos for xlim, ylim, and zlim
John W. Eaton <jwe@octave.org>
parents: 11587
diff changeset
64 %! plot3 ([0,1], [0,1], [0,1]);
0e231bbd78bc codesprint: demos for xlim, ylim, and zlim
John W. Eaton <jwe@octave.org>
parents: 11587
diff changeset
65 %! xlim ([0.2, 0.8]);
0e231bbd78bc codesprint: demos for xlim, ylim, and zlim
John W. Eaton <jwe@octave.org>
parents: 11587
diff changeset
66 %! title ("xlim is [0.2, 0.8]");
0e231bbd78bc codesprint: demos for xlim, ylim, and zlim
John W. Eaton <jwe@octave.org>
parents: 11587
diff changeset
67 %! assert (xlim (), [0.2, 0.8]);
0e231bbd78bc codesprint: demos for xlim, ylim, and zlim
John W. Eaton <jwe@octave.org>
parents: 11587
diff changeset
68
0e231bbd78bc codesprint: demos for xlim, ylim, and zlim
John W. Eaton <jwe@octave.org>
parents: 11587
diff changeset
69 %!demo
0e231bbd78bc codesprint: demos for xlim, ylim, and zlim
John W. Eaton <jwe@octave.org>
parents: 11587
diff changeset
70 %! clf ();
0e231bbd78bc codesprint: demos for xlim, ylim, and zlim
John W. Eaton <jwe@octave.org>
parents: 11587
diff changeset
71 %! plot3 ([0,1], [0,1], [0,1]);
0e231bbd78bc codesprint: demos for xlim, ylim, and zlim
John W. Eaton <jwe@octave.org>
parents: 11587
diff changeset
72 %! xlim ('auto');
0e231bbd78bc codesprint: demos for xlim, ylim, and zlim
John W. Eaton <jwe@octave.org>
parents: 11587
diff changeset
73 %! title ("xlim is auto");
0e231bbd78bc codesprint: demos for xlim, ylim, and zlim
John W. Eaton <jwe@octave.org>
parents: 11587
diff changeset
74 %! assert (xlim ("mode"), "auto");
0e231bbd78bc codesprint: demos for xlim, ylim, and zlim
John W. Eaton <jwe@octave.org>
parents: 11587
diff changeset
75
0e231bbd78bc codesprint: demos for xlim, ylim, and zlim
John W. Eaton <jwe@octave.org>
parents: 11587
diff changeset
76 ## Remove from test statistics. No real tests possible.
0e231bbd78bc codesprint: demos for xlim, ylim, and zlim
John W. Eaton <jwe@octave.org>
parents: 11587
diff changeset
77 %!assert (1)