annotate scripts/plot/stem.m @ 7245:d65670971cbc

[project @ 2007-12-04 03:03:54 by jwe]
author jwe
date Tue, 04 Dec 2007 03:03:55 +0000
parents 02eb1619b857
children 961d4c52ffae
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
7017
a1dbe9d80eee [project @ 2007-10-12 21:27:11 by jwe]
jwe
parents: 7016
diff changeset
1 ## Copyright (C) 2006, 2007 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 -*-
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
20 ## @deftypefn {Function File} {@var{h} =} stem (@var{x}, @var{y}, @var{linespec})
6506
e48c2a2528f6 [project @ 2007-04-06 17:28:54 by jwe]
jwe
parents: 6474
diff changeset
21 ## Plot a stem graph and return the handles of the line and marker
6303
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
22 ## objects used to draw the stems. The default color is @code{"r"}
6895
76e3d985ae56 [project @ 2007-09-13 18:22:38 by jwe]
jwe
parents: 6534
diff changeset
23 ## (red). The default line style is @code{"-"} and the default marker is
6303
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
24 ## @code{"o"}.
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
25 ##
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
26 ## For example,
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
27 ## @example
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
28 ## x = 1:10;
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
29 ## stem (x);
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
30 ## @end example
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
31 ## @noindent
6509
84f2d0253aea [project @ 2007-04-09 19:12:10 by jwe]
jwe
parents: 6506
diff changeset
32 ## plots 10 stems with heights from 1 to 10;
6303
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
33 ##
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
34 ## @example
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
35 ## x = 1:10;
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
36 ## y = ones (1, length (x))*2.*x;
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
37 ## stem (x, y);
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
38 ## @end example
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
39 ## @noindent
6509
84f2d0253aea [project @ 2007-04-09 19:12:10 by jwe]
jwe
parents: 6506
diff changeset
40 ## plots 10 stems with heights from 2 to 20;
6303
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
41 ##
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
42 ## @example
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
43 ## x = 1:10;
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
44 ## y = ones (size (x))*2.*x;
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
45 ## h = stem (x, y, "b");
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
46 ## @end example
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
47 ## @noindent
6509
84f2d0253aea [project @ 2007-04-09 19:12:10 by jwe]
jwe
parents: 6506
diff changeset
48 ## plots 10 bars with heights from 2 to 20
6303
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
49 ## (the color is blue, and @var{h} is a 2-by-10 array of handles in
7001
8b0cfeb06365 [project @ 2007-10-10 18:02:59 by jwe]
jwe
parents: 6895
diff changeset
50 ## which the first row holds the line handles and
6303
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
51 ## the second row holds the marker handles);
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
52 ##
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
53 ## @example
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
54 ## x = 1:10;
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
55 ## y = ones (size (x))*2.*x;
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
56 ## h = stem (x, y, "-.k");
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
57 ## @end example
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
58 ## @noindent
6509
84f2d0253aea [project @ 2007-04-09 19:12:10 by jwe]
jwe
parents: 6506
diff changeset
59 ## plots 10 stems with heights from 2 to 20
6303
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
60 ## (the color is black, line style is @code{"-."}, and @var{h} is a 2-by-10
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
61 ## array of handles in which the first row holds the line handles and
7001
8b0cfeb06365 [project @ 2007-10-10 18:02:59 by jwe]
jwe
parents: 6895
diff changeset
62 ## the second row holds the marker handles);
6303
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
63 ##
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
64 ## @example
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
65 ## x = 1:10;
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
66 ## y = ones (size (x))*2.*x;
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
67 ## h = stem (x, y, "-.k.");
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
68 ## @end example
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
69 ## @noindent
6509
84f2d0253aea [project @ 2007-04-09 19:12:10 by jwe]
jwe
parents: 6506
diff changeset
70 ## plots 10 stems with heights from 2 to 20
6303
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
71 ## (the color is black, line style is @code{"-."} and the marker style
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
72 ## is @code{"."}, and @var{h} is a 2-by-10 array of handles in which the
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
73 ## first row holds the line handles and the second row holds the marker
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
74 ## handles);
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
75 ##
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
76 ## @example
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
77 ## x = 1:10;
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
78 ## y = ones (size (x))*2.*x;
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
79 ## h = stem (x, y, "fill");
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
80 ## @end example
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
81 ## @noindent
6506
e48c2a2528f6 [project @ 2007-04-06 17:28:54 by jwe]
jwe
parents: 6474
diff changeset
82 ## plots 10 stems with heights from 2 to 20
6303
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
83 ## (the color is rgb-triple defined, the line style is @code{"-"},
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
84 ## the marker style is @code{"o"}, and @var{h} is a 2-by-10 array of
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
85 ## handles in which the first row holds the line handles and the second
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
86 ## row holds the marker handles).
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
87 ##
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
88 ## Color definitions with rgb-triples are not valid!
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
89 ## @seealso{bar, barh, plot}
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
90 ## @end deftypefn
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
91
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
92 ## Author: Michel D. Schmid <michaelschmid@users.sourceforge.net>
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
93 ## Adapted-by: jwe
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
94
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
95 function h = stem (varargin)
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
96
7218
02eb1619b857 [project @ 2007-11-29 21:10:55 by jwe]
jwe
parents: 7217
diff changeset
97 if (nargin < 1 || nargin > 3)
02eb1619b857 [project @ 2007-11-29 21:10:55 by jwe]
jwe
parents: 7217
diff changeset
98 print_usage ();
02eb1619b857 [project @ 2007-11-29 21:10:55 by jwe]
jwe
parents: 7217
diff changeset
99 endif
02eb1619b857 [project @ 2007-11-29 21:10:55 by jwe]
jwe
parents: 7217
diff changeset
100
7217
c8abc18322b7 [project @ 2007-11-29 20:50:24 by jwe]
jwe
parents: 7189
diff changeset
101 tmp = __stem__ (false, varargin{:});
6303
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
102
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
103 if (nargout > 0)
7217
c8abc18322b7 [project @ 2007-11-29 20:50:24 by jwe]
jwe
parents: 7189
diff changeset
104 h = tmp;
6303
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
105 endif
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
106
df89e87a1d2e [project @ 2007-02-13 09:11:53 by jwe]
jwe
parents:
diff changeset
107 endfunction
7245
d65670971cbc [project @ 2007-12-04 03:03:54 by jwe]
jwe
parents: 7218
diff changeset
108
d65670971cbc [project @ 2007-12-04 03:03:54 by jwe]
jwe
parents: 7218
diff changeset
109 %!demo
d65670971cbc [project @ 2007-12-04 03:03:54 by jwe]
jwe
parents: 7218
diff changeset
110 %! x = 1:10;
d65670971cbc [project @ 2007-12-04 03:03:54 by jwe]
jwe
parents: 7218
diff changeset
111 %! stem (x);
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
d65670971cbc [project @ 2007-12-04 03:03:54 by jwe]
jwe
parents: 7218
diff changeset
114 %! x = 1:10;
d65670971cbc [project @ 2007-12-04 03:03:54 by jwe]
jwe
parents: 7218
diff changeset
115 %! y = ones (1, length (x))*2.*x;
d65670971cbc [project @ 2007-12-04 03:03:54 by jwe]
jwe
parents: 7218
diff changeset
116 %! stem (x, y);
d65670971cbc [project @ 2007-12-04 03:03:54 by jwe]
jwe
parents: 7218
diff changeset
117
d65670971cbc [project @ 2007-12-04 03:03:54 by jwe]
jwe
parents: 7218
diff changeset
118 %!demo
d65670971cbc [project @ 2007-12-04 03:03:54 by jwe]
jwe
parents: 7218
diff changeset
119 %! x = 1:10;
d65670971cbc [project @ 2007-12-04 03:03:54 by jwe]
jwe
parents: 7218
diff changeset
120 %! y = ones (size (x))*2.*x;
d65670971cbc [project @ 2007-12-04 03:03:54 by jwe]
jwe
parents: 7218
diff changeset
121 %! h = stem (x, y, "b");
d65670971cbc [project @ 2007-12-04 03:03:54 by jwe]
jwe
parents: 7218
diff changeset
122
d65670971cbc [project @ 2007-12-04 03:03:54 by jwe]
jwe
parents: 7218
diff changeset
123 %!demo
d65670971cbc [project @ 2007-12-04 03:03:54 by jwe]
jwe
parents: 7218
diff changeset
124 %! x = 1:10;
d65670971cbc [project @ 2007-12-04 03:03:54 by jwe]
jwe
parents: 7218
diff changeset
125 %! y = ones (size (x))*2.*x;
d65670971cbc [project @ 2007-12-04 03:03:54 by jwe]
jwe
parents: 7218
diff changeset
126 %! h = stem (x, y, "-.k");
d65670971cbc [project @ 2007-12-04 03:03:54 by jwe]
jwe
parents: 7218
diff changeset
127
d65670971cbc [project @ 2007-12-04 03:03:54 by jwe]
jwe
parents: 7218
diff changeset
128 %!demo
d65670971cbc [project @ 2007-12-04 03:03:54 by jwe]
jwe
parents: 7218
diff changeset
129 %! x = 1:10;
d65670971cbc [project @ 2007-12-04 03:03:54 by jwe]
jwe
parents: 7218
diff changeset
130 %! y = ones (size (x))*2.*x;
d65670971cbc [project @ 2007-12-04 03:03:54 by jwe]
jwe
parents: 7218
diff changeset
131 %! h = stem (x, y, "-.k.");
d65670971cbc [project @ 2007-12-04 03:03:54 by jwe]
jwe
parents: 7218
diff changeset
132
d65670971cbc [project @ 2007-12-04 03:03:54 by jwe]
jwe
parents: 7218
diff changeset
133 %!demo
d65670971cbc [project @ 2007-12-04 03:03:54 by jwe]
jwe
parents: 7218
diff changeset
134 %! x = 1:10;
d65670971cbc [project @ 2007-12-04 03:03:54 by jwe]
jwe
parents: 7218
diff changeset
135 %! y = ones (size (x))*2.*x;
d65670971cbc [project @ 2007-12-04 03:03:54 by jwe]
jwe
parents: 7218
diff changeset
136 %! h = stem (x, y, "fill");