octave-nkf: scripts/plot/stem.m annotate

annotate scripts/plot/stem.m @ 10846:a4f482e66b65

Grammarcheck more of the documentation. Use @noindent macro appropriately. Limit line length to 80 characters.

author	Rik <octave@nomad.inbox5.com>
date	Sun, 01 Aug 2010 20:22:17 -0700
parents	a8ce6bdecce5
children	fd0a3ac60b0e

rev	line source
9245 16f53d29049f update copyright notices John W. Eaton <jwe@octave.org> parents: 9040 diff changeset	1 ## Copyright (C) 2006, 2007, 2008, 2009 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;
8052 961d4c52ffae Convert stem and stem3 to use stem series objects David Bateman <dbateman@free.fr> parents: 7245 diff changeset	49 ##
10687 a8ce6bdecce5 Improve documentation strings. Rik <octave@nomad.inbox5.com> parents: 9245 diff changeset	50 ## The return value of @code{stem} is a vector of "stem series" graphics
9040 dbd0c77e575e Cleanup documentation file plot.texi Rik <rdrider0-list@yahoo.com> parents: 8920 diff changeset	51 ## handles, with one handle per column of the variable @var{y}. This
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
d65670971cbc [project @ 2007-12-04 03:03:54 by jwe] jwe parents: 7218 diff changeset	89 %!demo
d65670971cbc [project @ 2007-12-04 03:03:54 by jwe] jwe parents: 7218 diff changeset	90 %! x = 1:10;
d65670971cbc [project @ 2007-12-04 03:03:54 by jwe] jwe parents: 7218 diff changeset	91 %! stem (x);
d65670971cbc [project @ 2007-12-04 03:03:54 by jwe] jwe parents: 7218 diff changeset	92
d65670971cbc [project @ 2007-12-04 03:03:54 by jwe] jwe parents: 7218 diff changeset	93 %!demo
d65670971cbc [project @ 2007-12-04 03:03:54 by jwe] jwe parents: 7218 diff changeset	94 %! x = 1:10;
d65670971cbc [project @ 2007-12-04 03:03:54 by jwe] jwe parents: 7218 diff changeset	95 %! y = ones (1, length (x))2.x;
d65670971cbc [project @ 2007-12-04 03:03:54 by jwe] jwe parents: 7218 diff changeset	96 %! stem (x, y);
d65670971cbc [project @ 2007-12-04 03:03:54 by jwe] jwe parents: 7218 diff changeset	97
d65670971cbc [project @ 2007-12-04 03:03:54 by jwe] jwe parents: 7218 diff changeset	98 %!demo
d65670971cbc [project @ 2007-12-04 03:03:54 by jwe] jwe parents: 7218 diff changeset	99 %! x = 1:10;
d65670971cbc [project @ 2007-12-04 03:03:54 by jwe] jwe parents: 7218 diff changeset	100 %! y = ones (size (x))2.x;
10687 a8ce6bdecce5 Improve documentation strings. Rik <octave@nomad.inbox5.com> parents: 9245 diff changeset	101 %! h = stem (x, y, "r");
7245 d65670971cbc [project @ 2007-12-04 03:03:54 by jwe] jwe parents: 7218 diff changeset	102
d65670971cbc [project @ 2007-12-04 03:03:54 by jwe] jwe parents: 7218 diff changeset	103 %!demo
d65670971cbc [project @ 2007-12-04 03:03:54 by jwe] jwe parents: 7218 diff changeset	104 %! x = 1:10;
d65670971cbc [project @ 2007-12-04 03:03:54 by jwe] jwe parents: 7218 diff changeset	105 %! y = ones (size (x))2.x;
d65670971cbc [project @ 2007-12-04 03:03:54 by jwe] jwe parents: 7218 diff changeset	106 %! h = stem (x, y, "-.k");
d65670971cbc [project @ 2007-12-04 03:03:54 by jwe] jwe parents: 7218 diff changeset	107
d65670971cbc [project @ 2007-12-04 03:03:54 by jwe] jwe parents: 7218 diff changeset	108 %!demo
d65670971cbc [project @ 2007-12-04 03:03:54 by jwe] jwe parents: 7218 diff changeset	109 %! x = 1:10;
d65670971cbc [project @ 2007-12-04 03:03:54 by jwe] jwe parents: 7218 diff changeset	110 %! y = ones (size (x))2.x;
d65670971cbc [project @ 2007-12-04 03:03:54 by jwe] jwe parents: 7218 diff changeset	111 %! h = stem (x, y, "-.k.");
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 (size (x))2.x;
10687 a8ce6bdecce5 Improve documentation strings. Rik <octave@nomad.inbox5.com> parents: 9245 diff changeset	116 %! 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	117
961d4c52ffae Convert stem and stem3 to use stem series objects David Bateman <dbateman@free.fr> parents: 7245 diff changeset	118 %!demo
10687 a8ce6bdecce5 Improve documentation strings. Rik <octave@nomad.inbox5.com> parents: 9245 diff changeset	119 %! x = [0 : 10]';
8052 961d4c52ffae Convert stem and stem3 to use stem series objects David Bateman <dbateman@free.fr> parents: 7245 diff changeset	120 %! y = [sin(x), cos(x)];
961d4c52ffae Convert stem and stem3 to use stem series objects David Bateman <dbateman@free.fr> parents: 7245 diff changeset	121 %! h = stem (x, y);
961d4c52ffae Convert stem and stem3 to use stem series objects David Bateman <dbateman@free.fr> parents: 7245 diff changeset	122 %! set (h(2), "color", "g");
961d4c52ffae Convert stem and stem3 to use stem series objects David Bateman <dbateman@free.fr> parents: 7245 diff changeset	123 %! set (h(1), "basevalue", -1)

Mercurial > hg > octave-nkf

annotate scripts/plot/stem.m @ 10846:a4f482e66b65