|
7017
|
1 ## Copyright (C) 1996, 1997, 2007 John W. Eaton |
|
6633
|
2 ## |
|
|
3 ## This file is part of Octave. |
|
|
4 ## |
|
|
5 ## Octave is free software; you can redistribute it and/or modify it |
|
|
6 ## under the terms of the GNU General Public License as published by |
|
7016
|
7 ## the Free Software Foundation; either version 3 of the License, or (at |
|
|
8 ## your option) any later version. |
|
6633
|
9 ## |
|
|
10 ## Octave is distributed in the hope that it will be useful, but |
|
|
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of |
|
|
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
|
|
13 ## General Public License for more details. |
|
|
14 ## |
|
|
15 ## You should have received a copy of the GNU General Public License |
|
7016
|
16 ## along with Octave; see the file COPYING. If not, see |
|
|
17 ## <http://www.gnu.org/licenses/>. |
|
6633
|
18 |
|
|
19 ## -*- texinfo -*- |
|
|
20 ## @deftypefn {Function File} {@var{h} =} barh (@var{x}, @var{y}, @var{style}) |
|
|
21 ## @deftypefnx {Function File} {[@var{xb}, @var{yb}] =} barh (@dots{}) |
|
6895
|
22 ## Given two vectors of x-y data, @code{bar} produce a horizontal bar graph. |
|
6633
|
23 ## |
|
|
24 ## If only one argument is given, it is taken as a vector of y-values |
|
|
25 ## and the x coordinates are taken to be the indices of the elements. |
|
|
26 ## |
|
|
27 ## If @var{y} is a matrix, then each column of @var{y} is taken to be a |
|
|
28 ## separate bar graph plotted on the same graph. By default the columns |
|
|
29 ## are plotted side-by-side. This behavior can be changed by the @var{style} |
|
7086
|
30 ## argument, which can take the values @code{"grouped"} (the default), |
|
|
31 ## or @code{"stacked"}. |
|
6633
|
32 ## |
|
|
33 ## If two output arguments are specified, the data are generated but |
|
|
34 ## not plotted. For example, |
|
|
35 ## |
|
|
36 ## @example |
|
|
37 ## barh (x, y); |
|
|
38 ## @end example |
|
|
39 ## |
|
|
40 ## @noindent |
|
|
41 ## and |
|
|
42 ## |
|
|
43 ## @example |
|
|
44 ## [xb, yb] = barh (x, y); |
|
|
45 ## plot (xb, yb); |
|
|
46 ## @end example |
|
|
47 ## |
|
|
48 ## @noindent |
|
|
49 ## are equivalent. |
|
6895
|
50 ## @seealso{bar, plot} |
|
6633
|
51 ## @end deftypefn |
|
|
52 |
|
|
53 ## Author: jwe |
|
|
54 |
|
|
55 function varargout = barh (varargin) |
|
|
56 varargout = cell (nargout, 1); |
|
|
57 [varargout{:}] = __bar__ (false, "barh", varargin{:}); |
|
|
58 endfunction |
