annotate scripts/plot/stem.m @ 14245:4506eade9f04

Use Matlab coding conventions for demos in plot/ directory. * contrast.m, axis.m, clabel.m, colorbar.m, comet.m, contour.m, contour3.m, cylinder.m, daspect.m, errorbar.m, ezplot.m, fplot.m, grid.m, hold.m, isosurface.m, legend.m, loglog.m, loglogerr.m, pareto.m, patch.m, pbaspect.m, pie.m, pie3.m, plot3.m, plotmatrix.m, plotyy.m, quiver.m, quiver3.m, rectangle.m, refreshdata.m, scatter.m, scatter3.m, semilogx.m, semilogxerr.m, semilogy.m, semilogyerr.m, shading.m, stem.m, subplot.m, text.m, title.m, trimesh.m, triplot.m, trisurf.m, uigetdir.m, uigetfile.m, uimenu.m, uiputfile.m, waitbar.m, xlim.m, ylim.m, zlim.m: Use Matlab coding conventions for demos so that compare plots scripts will function.
author Rik <octave@nomad.inbox5.com>
date Sun, 22 Jan 2012 07:31:32 -0800
parents 11949c9795a0
children ce2b59a6d0e5
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
14138
72c96de7a403 maint: update copyright notices for 2012
John W. Eaton <jwe@octave.org>
parents: 14092
diff changeset
1 ## Copyright (C) 2006-2012 Michel D. Schmid
6303
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
2 ##
6440
98ee80702bca [project @ 2007-03-23 15:13:19 by jwe]
jwe
parents: 6303
diff changeset
3 ## This file is part of Octave.
98ee80702bca [project @ 2007-03-23 15:13:19 by jwe]
jwe
parents: 6303
diff changeset
4 ##
98ee80702bca [project @ 2007-03-23 15:13:19 by jwe]
jwe
parents: 6303
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
6303
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
6 ## under the terms of the GNU General Public License as published by
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 7001
diff changeset
7 ## the Free Software Foundation; either version 3 of the License, or (at
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 7001
diff changeset
8 ## your option) any later version.
6303
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
9 ##
6440
98ee80702bca [project @ 2007-03-23 15:13:19 by jwe]
jwe
parents: 6303
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
6303
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
13 ## General Public License for more details.
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
14 ##
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
15 ## You should have received a copy of the GNU General Public License
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 7001
diff changeset
16 ## along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 7001
diff changeset
17 ## <http://www.gnu.org/licenses/>.
6303
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
18
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
19 ## -*- texinfo -*-
10687
a8ce6bdecce5 Improve documentation strings.
Rik <octave@nomad.inbox5.com>
parents: 9245
diff changeset
20 ## @deftypefn {Function File} {} stem (@var{x})
a8ce6bdecce5 Improve documentation strings.
Rik <octave@nomad.inbox5.com>
parents: 9245
diff changeset
21 ## @deftypefnx {Function File} {} stem (@var{x}, @var{y})
a8ce6bdecce5 Improve documentation strings.
Rik <octave@nomad.inbox5.com>
parents: 9245
diff changeset
22 ## @deftypefnx {Function File} {} stem (@var{x}, @var{y}, @var{linespec})
a8ce6bdecce5 Improve documentation strings.
Rik <octave@nomad.inbox5.com>
parents: 9245
diff changeset
23 ## @deftypefnx {Function File} {} stem (@dots{}, "filled")
a8ce6bdecce5 Improve documentation strings.
Rik <octave@nomad.inbox5.com>
parents: 9245
diff changeset
24 ## @deftypefnx {Function File} {@var{h} =} stem (@dots{})
9040
dbd0c77e575e Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents: 8920
diff changeset
25 ## Plot a stem graph from two vectors of x-y data. If only one argument
8052
961d4c52ffae Convert stem and stem3 to use stem series objects
David Bateman <dbateman@free.fr>
parents: 7245
diff changeset
26 ## is given, it is taken as the y-values and the x coordinates are taken
9040
dbd0c77e575e Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents: 8920
diff changeset
27 ## from the indices of the elements.
6303
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
28 ##
8052
961d4c52ffae Convert stem and stem3 to use stem series objects
David Bateman <dbateman@free.fr>
parents: 7245
diff changeset
29 ## If @var{y} is a matrix, then each column of the matrix is plotted as
9040
dbd0c77e575e Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents: 8920
diff changeset
30 ## a separate stem graph. In this case @var{x} can either be a vector,
8052
961d4c52ffae Convert stem and stem3 to use stem series objects
David Bateman <dbateman@free.fr>
parents: 7245
diff changeset
31 ## the same length as the number of rows in @var{y}, or it can be a
961d4c52ffae Convert stem and stem3 to use stem series objects
David Bateman <dbateman@free.fr>
parents: 7245
diff changeset
32 ## matrix of the same size as @var{y}.
961d4c52ffae Convert stem and stem3 to use stem series objects
David Bateman <dbateman@free.fr>
parents: 7245
diff changeset
33 ##
10687
a8ce6bdecce5 Improve documentation strings.
Rik <octave@nomad.inbox5.com>
parents: 9245
diff changeset
34 ## The default color is @code{"b"} (blue). The default line style is
9040
dbd0c77e575e Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents: 8920
diff changeset
35 ## @code{"-"} and the default marker is @code{"o"}. The line style can
8052
961d4c52ffae Convert stem and stem3 to use stem series objects
David Bateman <dbateman@free.fr>
parents: 7245
diff changeset
36 ## be altered by the @code{linespec} argument in the same manner as the
10846
a4f482e66b65 Grammarcheck more of the documentation.
Rik <octave@nomad.inbox5.com>
parents: 10687
diff changeset
37 ## @code{plot} command. For example,
6303
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
38 ##
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
39 ## @example
8052
961d4c52ffae Convert stem and stem3 to use stem series objects
David Bateman <dbateman@free.fr>
parents: 7245
diff changeset
40 ## @group
6303
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
41 ## x = 1:10;
8052
961d4c52ffae Convert stem and stem3 to use stem series objects
David Bateman <dbateman@free.fr>
parents: 7245
diff changeset
42 ## y = ones (1, length (x))*2.*x;
10687
a8ce6bdecce5 Improve documentation strings.
Rik <octave@nomad.inbox5.com>
parents: 9245
diff changeset
43 ## stem (x, y, "r");
8052
961d4c52ffae Convert stem and stem3 to use stem series objects
David Bateman <dbateman@free.fr>
parents: 7245
diff changeset
44 ## @end group
6303
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
45 ## @end example
8052
961d4c52ffae Convert stem and stem3 to use stem series objects
David Bateman <dbateman@free.fr>
parents: 7245
diff changeset
46 ##
6303
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
47 ## @noindent
10687
a8ce6bdecce5 Improve documentation strings.
Rik <octave@nomad.inbox5.com>
parents: 9245
diff changeset
48 ## plots 10 stems with heights from 2 to 20 in red;
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
49 ##
14001
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
50 ## The optional return value @var{h} is a vector of "stem series" graphics
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
51 ## handles with one handle per column of the variable @var{y}. The
8052
961d4c52ffae Convert stem and stem3 to use stem series objects
David Bateman <dbateman@free.fr>
parents: 7245
diff changeset
52 ## handle regroups the elements of the stem graph together as the
961d4c52ffae Convert stem and stem3 to use stem series objects
David Bateman <dbateman@free.fr>
parents: 7245
diff changeset
53 ## children of the "stem series" handle, allowing them to be altered
10846
a4f482e66b65 Grammarcheck more of the documentation.
Rik <octave@nomad.inbox5.com>
parents: 10687
diff changeset
54 ## together. For example,
6303
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
55 ##
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
56 ## @example
8052
961d4c52ffae Convert stem and stem3 to use stem series objects
David Bateman <dbateman@free.fr>
parents: 7245
diff changeset
57 ## @group
10687
a8ce6bdecce5 Improve documentation strings.
Rik <octave@nomad.inbox5.com>
parents: 9245
diff changeset
58 ## x = [0 : 10]';
8052
961d4c52ffae Convert stem and stem3 to use stem series objects
David Bateman <dbateman@free.fr>
parents: 7245
diff changeset
59 ## y = [sin(x), cos(x)]
961d4c52ffae Convert stem and stem3 to use stem series objects
David Bateman <dbateman@free.fr>
parents: 7245
diff changeset
60 ## h = stem (x, y);
961d4c52ffae Convert stem and stem3 to use stem series objects
David Bateman <dbateman@free.fr>
parents: 7245
diff changeset
61 ## set (h(2), "color", "g");
961d4c52ffae Convert stem and stem3 to use stem series objects
David Bateman <dbateman@free.fr>
parents: 7245
diff changeset
62 ## set (h(1), "basevalue", -1)
961d4c52ffae Convert stem and stem3 to use stem series objects
David Bateman <dbateman@free.fr>
parents: 7245
diff changeset
63 ## @end group
6303
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
64 ## @end example
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
65 ##
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
66 ## @noindent
8052
961d4c52ffae Convert stem and stem3 to use stem series objects
David Bateman <dbateman@free.fr>
parents: 7245
diff changeset
67 ## changes the color of the second "stem series" and moves the base line
961d4c52ffae Convert stem and stem3 to use stem series objects
David Bateman <dbateman@free.fr>
parents: 7245
diff changeset
68 ## of the first.
6303
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
69 ## @seealso{bar, barh, plot}
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
70 ## @end deftypefn
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
71
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
72 ## Author: Michel D. Schmid <michaelschmid@users.sourceforge.net>
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
73 ## Adapted-by: jwe
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
74
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
75 function h = stem (varargin)
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
76
8070
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8052
diff changeset
77 if (nargin < 1)
7218
02eb1619b857 [project @ 2007-11-29 21:10:55 by jwe]
jwe
parents: 7217
diff changeset
78 print_usage ();
02eb1619b857 [project @ 2007-11-29 21:10:55 by jwe]
jwe
parents: 7217
diff changeset
79 endif
02eb1619b857 [project @ 2007-11-29 21:10:55 by jwe]
jwe
parents: 7217
diff changeset
80
7217
c8abc18322b7 [project @ 2007-11-29 20:50:24 by jwe]
jwe
parents: 7189
diff changeset
81 tmp = __stem__ (false, varargin{:});
6303
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
82
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
83 if (nargout > 0)
7217
c8abc18322b7 [project @ 2007-11-29 20:50:24 by jwe]
jwe
parents: 7189
diff changeset
84 h = tmp;
6303
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
85 endif
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
86
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
87 endfunction
7245
d65670971cbc [project @ 2007-12-04 03:03:54 by jwe]
jwe
parents: 7218
diff changeset
88
14001
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
89
7245
d65670971cbc [project @ 2007-12-04 03:03:54 by jwe]
jwe
parents: 7218
diff changeset
90 %!demo
14237
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
91 %! clf;
7245
d65670971cbc [project @ 2007-12-04 03:03:54 by jwe]
jwe
parents: 7218
diff changeset
92 %! x = 1:10;
d65670971cbc [project @ 2007-12-04 03:03:54 by jwe]
jwe
parents: 7218
diff changeset
93 %! stem (x);
d65670971cbc [project @ 2007-12-04 03:03:54 by jwe]
jwe
parents: 7218
diff changeset
94
d65670971cbc [project @ 2007-12-04 03:03:54 by jwe]
jwe
parents: 7218
diff changeset
95 %!demo
14237
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
96 %! clf;
7245
d65670971cbc [project @ 2007-12-04 03:03:54 by jwe]
jwe
parents: 7218
diff changeset
97 %! x = 1:10;
14001
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
98 %! y = 2*x;
7245
d65670971cbc [project @ 2007-12-04 03:03:54 by jwe]
jwe
parents: 7218
diff changeset
99 %! stem (x, y);
d65670971cbc [project @ 2007-12-04 03:03:54 by jwe]
jwe
parents: 7218
diff changeset
100
d65670971cbc [project @ 2007-12-04 03:03:54 by jwe]
jwe
parents: 7218
diff changeset
101 %!demo
14237
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
102 %! clf;
7245
d65670971cbc [project @ 2007-12-04 03:03:54 by jwe]
jwe
parents: 7218
diff changeset
103 %! x = 1:10;
14001
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
104 %! y = 2*x;
14245
4506eade9f04 Use Matlab coding conventions for demos in plot/ directory.
Rik <octave@nomad.inbox5.com>
parents: 14237
diff changeset
105 %! h = stem (x, y, 'r');
7245
d65670971cbc [project @ 2007-12-04 03:03:54 by jwe]
jwe
parents: 7218
diff changeset
106
d65670971cbc [project @ 2007-12-04 03:03:54 by jwe]
jwe
parents: 7218
diff changeset
107 %!demo
14237
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
108 %! clf;
7245
d65670971cbc [project @ 2007-12-04 03:03:54 by jwe]
jwe
parents: 7218
diff changeset
109 %! x = 1:10;
14001
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
110 %! y = 2*x;
14245
4506eade9f04 Use Matlab coding conventions for demos in plot/ directory.
Rik <octave@nomad.inbox5.com>
parents: 14237
diff changeset
111 %! h = stem (x, y, '-.k');
7245
d65670971cbc [project @ 2007-12-04 03:03:54 by jwe]
jwe
parents: 7218
diff changeset
112
d65670971cbc [project @ 2007-12-04 03:03:54 by jwe]
jwe
parents: 7218
diff changeset
113 %!demo
14237
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
114 %! clf;
7245
d65670971cbc [project @ 2007-12-04 03:03:54 by jwe]
jwe
parents: 7218
diff changeset
115 %! x = 1:10;
14001
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
116 %! y = 2*x;
14245
4506eade9f04 Use Matlab coding conventions for demos in plot/ directory.
Rik <octave@nomad.inbox5.com>
parents: 14237
diff changeset
117 %! h = stem (x, y, '-.k.');
7245
d65670971cbc [project @ 2007-12-04 03:03:54 by jwe]
jwe
parents: 7218
diff changeset
118
d65670971cbc [project @ 2007-12-04 03:03:54 by jwe]
jwe
parents: 7218
diff changeset
119 %!demo
14237
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
120 %! clf;
7245
d65670971cbc [project @ 2007-12-04 03:03:54 by jwe]
jwe
parents: 7218
diff changeset
121 %! x = 1:10;
14001
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
122 %! y = 2*x;
14245
4506eade9f04 Use Matlab coding conventions for demos in plot/ directory.
Rik <octave@nomad.inbox5.com>
parents: 14237
diff changeset
123 %! h = stem (x, y, 'filled');
8052
961d4c52ffae Convert stem and stem3 to use stem series objects
David Bateman <dbateman@free.fr>
parents: 7245
diff changeset
124
961d4c52ffae Convert stem and stem3 to use stem series objects
David Bateman <dbateman@free.fr>
parents: 7245
diff changeset
125 %!demo
14237
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
126 %! clf;
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
127 %! x = (0 : 10)';
8052
961d4c52ffae Convert stem and stem3 to use stem series objects
David Bateman <dbateman@free.fr>
parents: 7245
diff changeset
128 %! y = [sin(x), cos(x)];
961d4c52ffae Convert stem and stem3 to use stem series objects
David Bateman <dbateman@free.fr>
parents: 7245
diff changeset
129 %! h = stem (x, y);
14245
4506eade9f04 Use Matlab coding conventions for demos in plot/ directory.
Rik <octave@nomad.inbox5.com>
parents: 14237
diff changeset
130 %! set (h(2), 'color', 'g');
4506eade9f04 Use Matlab coding conventions for demos in plot/ directory.
Rik <octave@nomad.inbox5.com>
parents: 14237
diff changeset
131 %! set (h(1), 'basevalue', -1)
14001
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
132