octave-nkf: scripts/plot/draw/barh.m annotate

annotate scripts/plot/draw/barh.m @ 20737:2d9ec16fa960

Print error, rather than aborting, if mex function mxIsFromGlobalWS is used (bug #46070). * mex.cc (mxIsFromGlobalWS): Call mexErrMsgTxt rather than abort() in function.

author	Rik <rik@octave.org>
date	Tue, 29 Sep 2015 12:00:11 -0700
parents	4197fc428c7d
children

rev	line source
19898 4197fc428c7d maint: Update copyright notices for 2015. John W. Eaton <jwe@octave.org> parents: 19790 diff changeset	1 ## Copyright (C) 1996-2015 John W. Eaton
6633 5af6275fbca9 [project @ 2007-05-17 19:44:28 by dbateman] dbateman parents: diff changeset	2 ##
5af6275fbca9 [project @ 2007-05-17 19:44:28 by dbateman] dbateman parents: diff changeset	3 ## This file is part of Octave.
5af6275fbca9 [project @ 2007-05-17 19:44:28 by dbateman] dbateman parents: diff changeset	4 ##
5af6275fbca9 [project @ 2007-05-17 19:44:28 by dbateman] dbateman parents: diff changeset	5 ## Octave is free software; you can redistribute it and/or modify it
5af6275fbca9 [project @ 2007-05-17 19:44:28 by dbateman] dbateman 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: 6895 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: 6895 diff changeset	8 ## your option) any later version.
6633 5af6275fbca9 [project @ 2007-05-17 19:44:28 by dbateman] dbateman parents: diff changeset	9 ##
5af6275fbca9 [project @ 2007-05-17 19:44:28 by dbateman] dbateman parents: diff changeset	10 ## Octave is distributed in the hope that it will be useful, but
5af6275fbca9 [project @ 2007-05-17 19:44:28 by dbateman] dbateman parents: diff changeset	11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
5af6275fbca9 [project @ 2007-05-17 19:44:28 by dbateman] dbateman parents: diff changeset	12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
5af6275fbca9 [project @ 2007-05-17 19:44:28 by dbateman] dbateman parents: diff changeset	13 ## General Public License for more details.
5af6275fbca9 [project @ 2007-05-17 19:44:28 by dbateman] dbateman parents: diff changeset	14 ##
5af6275fbca9 [project @ 2007-05-17 19:44:28 by dbateman] dbateman 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: 6895 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: 6895 diff changeset	17 ## <http://www.gnu.org/licenses/>.
6633 5af6275fbca9 [project @ 2007-05-17 19:44:28 by dbateman] dbateman parents: diff changeset	18
5af6275fbca9 [project @ 2007-05-17 19:44:28 by dbateman] dbateman parents: diff changeset	19 ## -- texinfo --
17122 eaab03308c0b doc: Rewrite docstrings for most plot functions. Rik <rik@octave.org> parents: 16814 diff changeset	20 ## @deftypefn {Function File} {} barh (@var{y})
eaab03308c0b doc: Rewrite docstrings for most plot functions. Rik <rik@octave.org> parents: 16814 diff changeset	21 ## @deftypefnx {Function File} {} barh (@var{x}, @var{y})
eaab03308c0b doc: Rewrite docstrings for most plot functions. Rik <rik@octave.org> parents: 16814 diff changeset	22 ## @deftypefnx {Function File} {} barh (@dots{}, @var{w})
eaab03308c0b doc: Rewrite docstrings for most plot functions. Rik <rik@octave.org> parents: 16814 diff changeset	23 ## @deftypefnx {Function File} {} barh (@dots{}, @var{style})
eaab03308c0b doc: Rewrite docstrings for most plot functions. Rik <rik@octave.org> parents: 16814 diff changeset	24 ## @deftypefnx {Function File} {} barh (@dots{}, @var{prop}, @var{val}, @dots{})
eaab03308c0b doc: Rewrite docstrings for most plot functions. Rik <rik@octave.org> parents: 16814 diff changeset	25 ## @deftypefnx {Function File} {} barh (@var{hax}, @dots{})
eaab03308c0b doc: Rewrite docstrings for most plot functions. Rik <rik@octave.org> parents: 16814 diff changeset	26 ## @deftypefnx {Function File} {@var{h} =} barh (@dots{}, @var{prop}, @var{val}, @dots{})
eaab03308c0b doc: Rewrite docstrings for most plot functions. Rik <rik@octave.org> parents: 16814 diff changeset	27 ## Produce a horizontal bar graph from two vectors of X-Y data.
6633 5af6275fbca9 [project @ 2007-05-17 19:44:28 by dbateman] dbateman parents: diff changeset	28 ##
17122 eaab03308c0b doc: Rewrite docstrings for most plot functions. Rik <rik@octave.org> parents: 16814 diff changeset	29 ## If only one argument is given, it is taken as a vector of Y values
eaab03308c0b doc: Rewrite docstrings for most plot functions. Rik <rik@octave.org> parents: 16814 diff changeset	30 ## and the X coordinates are the range @code{1:numel (@var{y})}.
6633 5af6275fbca9 [project @ 2007-05-17 19:44:28 by dbateman] dbateman parents: diff changeset	31 ##
17122 eaab03308c0b doc: Rewrite docstrings for most plot functions. Rik <rik@octave.org> parents: 16814 diff changeset	32 ## The optional input @var{w} controls the width of the bars. A value of
eaab03308c0b doc: Rewrite docstrings for most plot functions. Rik <rik@octave.org> parents: 16814 diff changeset	33 ## 1.0 will cause each bar to exactly touch any adjacent bars.
eaab03308c0b doc: Rewrite docstrings for most plot functions. Rik <rik@octave.org> parents: 16814 diff changeset	34 ## The default width is 0.8.
7096 81bed50b9feb [project @ 2007-11-02 16:13:43 by jwe] jwe parents: 7086 diff changeset	35 ##
6633 5af6275fbca9 [project @ 2007-05-17 19:44:28 by dbateman] dbateman parents: diff changeset	36 ## If @var{y} is a matrix, then each column of @var{y} is taken to be a
9040 dbd0c77e575e Cleanup documentation file plot.texi Rik <rdrider0-list@yahoo.com> parents: 8920 diff changeset	37 ## separate bar graph plotted on the same graph. By default the columns
dbd0c77e575e Cleanup documentation file plot.texi Rik <rdrider0-list@yahoo.com> parents: 8920 diff changeset	38 ## are plotted side-by-side. This behavior can be changed by the @var{style}
17519 cc9befe5d271 Overhaul bar family of plot functions. Rik <rik@octave.org> parents: 17281 diff changeset	39 ## argument which can take the following values:
cc9befe5d271 Overhaul bar family of plot functions. Rik <rik@octave.org> parents: 17281 diff changeset	40 ##
cc9befe5d271 Overhaul bar family of plot functions. Rik <rik@octave.org> parents: 17281 diff changeset	41 ## @table @asis
19790 446c46af4b42 strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 17744 diff changeset	42 ## @item @qcode{"grouped"} (default)
17519 cc9befe5d271 Overhaul bar family of plot functions. Rik <rik@octave.org> parents: 17281 diff changeset	43 ## Side-by-side bars with a gap between bars and centered over the Y-coordinate.
19790 446c46af4b42 strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 17744 diff changeset	44 ##
17519 cc9befe5d271 Overhaul bar family of plot functions. Rik <rik@octave.org> parents: 17281 diff changeset	45 ## @item @qcode{"stacked"}
cc9befe5d271 Overhaul bar family of plot functions. Rik <rik@octave.org> parents: 17281 diff changeset	46 ## Bars are stacked so that each Y value has a single bar composed of
cc9befe5d271 Overhaul bar family of plot functions. Rik <rik@octave.org> parents: 17281 diff changeset	47 ## multiple segments.
cc9befe5d271 Overhaul bar family of plot functions. Rik <rik@octave.org> parents: 17281 diff changeset	48 ##
cc9befe5d271 Overhaul bar family of plot functions. Rik <rik@octave.org> parents: 17281 diff changeset	49 ## @item @qcode{"hist"}
cc9befe5d271 Overhaul bar family of plot functions. Rik <rik@octave.org> parents: 17281 diff changeset	50 ## Side-by-side bars with no gap between bars and centered over the
cc9befe5d271 Overhaul bar family of plot functions. Rik <rik@octave.org> parents: 17281 diff changeset	51 ## Y-coordinate.
cc9befe5d271 Overhaul bar family of plot functions. Rik <rik@octave.org> parents: 17281 diff changeset	52 ##
cc9befe5d271 Overhaul bar family of plot functions. Rik <rik@octave.org> parents: 17281 diff changeset	53 ## @item @qcode{"histc"}
cc9befe5d271 Overhaul bar family of plot functions. Rik <rik@octave.org> parents: 17281 diff changeset	54 ## Side-by-side bars with no gap between bars and left-aligned to the
cc9befe5d271 Overhaul bar family of plot functions. Rik <rik@octave.org> parents: 17281 diff changeset	55 ## Y-coordinate.
cc9befe5d271 Overhaul bar family of plot functions. Rik <rik@octave.org> parents: 17281 diff changeset	56 ## @end table
6633 5af6275fbca9 [project @ 2007-05-17 19:44:28 by dbateman] dbateman parents: diff changeset	57 ##
17122 eaab03308c0b doc: Rewrite docstrings for most plot functions. Rik <rik@octave.org> parents: 16814 diff changeset	58 ## Optional property/value pairs are passed directly to the underlying patch
eaab03308c0b doc: Rewrite docstrings for most plot functions. Rik <rik@octave.org> parents: 16814 diff changeset	59 ## objects.
eaab03308c0b doc: Rewrite docstrings for most plot functions. Rik <rik@octave.org> parents: 16814 diff changeset	60 ##
eaab03308c0b doc: Rewrite docstrings for most plot functions. Rik <rik@octave.org> parents: 16814 diff changeset	61 ## If the first argument @var{hax} is an axes handle, then plot into this axis,
eaab03308c0b doc: Rewrite docstrings for most plot functions. Rik <rik@octave.org> parents: 16814 diff changeset	62 ## rather than the current axes returned by @code{gca}.
19790 446c46af4b42 strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 17744 diff changeset	63 ##
14001 5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761) Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	64 ## The optional return value @var{h} is a graphics handle to the created
17122 eaab03308c0b doc: Rewrite docstrings for most plot functions. Rik <rik@octave.org> parents: 16814 diff changeset	65 ## bar series hggroup. For a description of the use of the
eaab03308c0b doc: Rewrite docstrings for most plot functions. Rik <rik@octave.org> parents: 16814 diff changeset	66 ## bar series, @pxref{XREFbar,,bar}.
eaab03308c0b doc: Rewrite docstrings for most plot functions. Rik <rik@octave.org> parents: 16814 diff changeset	67 ## @seealso{bar, hist, pie, plot, patch}
6633 5af6275fbca9 [project @ 2007-05-17 19:44:28 by dbateman] dbateman parents: diff changeset	68 ## @end deftypefn
5af6275fbca9 [project @ 2007-05-17 19:44:28 by dbateman] dbateman parents: diff changeset	69
5af6275fbca9 [project @ 2007-05-17 19:44:28 by dbateman] dbateman parents: diff changeset	70 ## Author: jwe
5af6275fbca9 [project @ 2007-05-17 19:44:28 by dbateman] dbateman parents: diff changeset	71
5af6275fbca9 [project @ 2007-05-17 19:44:28 by dbateman] dbateman parents: diff changeset	72 function varargout = barh (varargin)
5af6275fbca9 [project @ 2007-05-17 19:44:28 by dbateman] dbateman parents: diff changeset	73 varargout = cell (nargout, 1);
5af6275fbca9 [project @ 2007-05-17 19:44:28 by dbateman] dbateman parents: diff changeset	74 [varargout{:}] = __bar__ (false, "barh", varargin{:});
5af6275fbca9 [project @ 2007-05-17 19:44:28 by dbateman] dbateman parents: diff changeset	75 endfunction
14001 5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761) Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	76
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761) Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	77
15565 de751531e548 test: Add demos for bar.m and barh.m Rik <rik@octave.org> parents: 14138 diff changeset	78 %!demo
de751531e548 test: Add demos for bar.m and barh.m Rik <rik@octave.org> parents: 14138 diff changeset	79 %! clf;
de751531e548 test: Add demos for bar.m and barh.m Rik <rik@octave.org> parents: 14138 diff changeset	80 %! x = rand (10, 1);
de751531e548 test: Add demos for bar.m and barh.m Rik <rik@octave.org> parents: 14138 diff changeset	81 %! barh (x);
17190 df4c4b7708a4 Add titles and clean-up plotting %!demos. Rik <rik@octave.org> parents: 17122 diff changeset	82 %! title ('barh() graph')
14001 5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761) Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	83
15565 de751531e548 test: Add demos for bar.m and barh.m Rik <rik@octave.org> parents: 14138 diff changeset	84 %!demo
de751531e548 test: Add demos for bar.m and barh.m Rik <rik@octave.org> parents: 14138 diff changeset	85 %! clf;
de751531e548 test: Add demos for bar.m and barh.m Rik <rik@octave.org> parents: 14138 diff changeset	86 %! h = barh (rand (5, 3));
de751531e548 test: Add demos for bar.m and barh.m Rik <rik@octave.org> parents: 14138 diff changeset	87 %! set (h(1), 'facecolor', 'r')
de751531e548 test: Add demos for bar.m and barh.m Rik <rik@octave.org> parents: 14138 diff changeset	88 %! set (h(2), 'facecolor', 'g')
de751531e548 test: Add demos for bar.m and barh.m Rik <rik@octave.org> parents: 14138 diff changeset	89 %! set (h(3), 'facecolor', 'b')
17190 df4c4b7708a4 Add titles and clean-up plotting %!demos. Rik <rik@octave.org> parents: 17122 diff changeset	90 %! title ('barh() graph w/multiple bars')
15565 de751531e548 test: Add demos for bar.m and barh.m Rik <rik@octave.org> parents: 14138 diff changeset	91

Mercurial > hg > octave-nkf

annotate scripts/plot/draw/barh.m @ 20737:2d9ec16fa960