octave: scripts/plot/draw/pie.m annotate

annotate scripts/plot/draw/pie.m @ 33670:9dd2a8e7e0d5 default tip @

uifigure.m: Make sure variable exists before it is used (bug #65459). * scripts/gui/uifigure.m: The variable "props" might have been used before it existed. Make sure it exists for all code paths.

author	Markus Mützel <markus.muetzel@gmx.de>
date	Mon, 24 Jun 2024 10:29:15 +0200
parents	2e484f9f1f18
children

rev	line source
27923 bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	1 ########################################################################
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	2 ##
32632 2e484f9f1f18 maint: update Octave Project Developers copyright for the new year John W. Eaton <jwe@octave.org> parents: 31706 diff changeset	3 ## Copyright (C) 2007-2024 The Octave Project Developers
27918 b442ec6dda5c use centralized file for copyright info for individual contributors John W. Eaton <jwe@octave.org> parents: 27231 diff changeset	4 ##
27923 bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	5 ## See the file COPYRIGHT.md in the top-level directory of this
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	6 ## distribution or <https://octave.org/copyright/>.
7118 d32f867e4dda [project @ 2007-11-07 20:44:11 by jwe] jwe parents: diff changeset	7 ##
d32f867e4dda [project @ 2007-11-07 20:44:11 by jwe] jwe parents: diff changeset	8 ## This file is part of Octave.
d32f867e4dda [project @ 2007-11-07 20:44:11 by jwe] jwe parents: diff changeset	9 ##
24534 194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 24432 diff changeset	10 ## Octave is free software: you can redistribute it and/or modify it
7118 d32f867e4dda [project @ 2007-11-07 20:44:11 by jwe] jwe parents: diff changeset	11 ## under the terms of the GNU General Public License as published by
24534 194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 24432 diff changeset	12 ## the Free Software Foundation, either version 3 of the License, or
22755 3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22323 diff changeset	13 ## (at your option) any later version.
7118 d32f867e4dda [project @ 2007-11-07 20:44:11 by jwe] jwe parents: diff changeset	14 ##
d32f867e4dda [project @ 2007-11-07 20:44:11 by jwe] jwe parents: diff changeset	15 ## Octave is distributed in the hope that it will be useful, but
d32f867e4dda [project @ 2007-11-07 20:44:11 by jwe] jwe parents: diff changeset	16 ## WITHOUT ANY WARRANTY; without even the implied warranty of
22755 3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22323 diff changeset	17 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22323 diff changeset	18 ## GNU General Public License for more details.
7118 d32f867e4dda [project @ 2007-11-07 20:44:11 by jwe] jwe parents: diff changeset	19 ##
d32f867e4dda [project @ 2007-11-07 20:44:11 by jwe] jwe parents: diff changeset	20 ## You should have received a copy of the GNU General Public License
d32f867e4dda [project @ 2007-11-07 20:44:11 by jwe] jwe parents: diff changeset	21 ## along with Octave; see the file COPYING. If not, see
24534 194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 24432 diff changeset	22 ## <https://www.gnu.org/licenses/>.
27923 bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	23 ##
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	24 ########################################################################
7118 d32f867e4dda [project @ 2007-11-07 20:44:11 by jwe] jwe parents: diff changeset	25
d32f867e4dda [project @ 2007-11-07 20:44:11 by jwe] jwe parents: diff changeset	26 ## -- texinfo --
20852 516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files. Rik <rik@octave.org> parents: 19697 diff changeset	27 ## @deftypefn {} {} pie (@var{x})
516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files. Rik <rik@octave.org> parents: 19697 diff changeset	28 ## @deftypefnx {} {} pie (@dots{}, @var{explode})
516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files. Rik <rik@octave.org> parents: 19697 diff changeset	29 ## @deftypefnx {} {} pie (@dots{}, @var{labels})
27231 940c1b6e3453 doc: Remove stray semicolons from pie, pie3 calling forms. Rik <rik@octave.org> parents: 26376 diff changeset	30 ## @deftypefnx {} {} pie (@var{hax}, @dots{})
940c1b6e3453 doc: Remove stray semicolons from pie, pie3 calling forms. Rik <rik@octave.org> parents: 26376 diff changeset	31 ## @deftypefnx {} {@var{h} =} pie (@dots{})
16814 64e7bb01fce2 doc: Improve documentation for 2-D plot functions Rik <rik@octave.org> parents: 14359 diff changeset	32 ## Plot a 2-D pie chart.
7118 d32f867e4dda [project @ 2007-11-07 20:44:11 by jwe] jwe parents: diff changeset	33 ##
16814 64e7bb01fce2 doc: Improve documentation for 2-D plot functions Rik <rik@octave.org> parents: 14359 diff changeset	34 ## When called with a single vector argument, produce a pie chart of the
64e7bb01fce2 doc: Improve documentation for 2-D plot functions Rik <rik@octave.org> parents: 14359 diff changeset	35 ## elements in @var{x}. The size of the ith slice is the percentage that the
17064 84e000930ca5 pie.m, pie3.m: Update to use new __plt_get_axis_arg__. Rik <rik@octave.org> parents: 16814 diff changeset	36 ## element @var{x}i represents of the total sum of @var{x}:
19593 446c46af4b42 strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 17744 diff changeset	37 ## @code{pct = @var{x}(i) / sum (@var{x})}.
7118 d32f867e4dda [project @ 2007-11-07 20:44:11 by jwe] jwe parents: diff changeset	38 ##
17064 84e000930ca5 pie.m, pie3.m: Update to use new __plt_get_axis_arg__. Rik <rik@octave.org> parents: 16814 diff changeset	39 ## The optional input @var{explode} is a vector of the same length as @var{x}
18812 9ac2357f19bc doc: Replace "non-zero" with "nonzero" to match existing usage. Rik <rik@octave.org> parents: 17744 diff changeset	40 ## that, if nonzero, "explodes" the slice from the pie chart.
7118 d32f867e4dda [project @ 2007-11-07 20:44:11 by jwe] jwe parents: diff changeset	41 ##
16814 64e7bb01fce2 doc: Improve documentation for 2-D plot functions Rik <rik@octave.org> parents: 14359 diff changeset	42 ## The optional input @var{labels} is a cell array of strings of the same
64e7bb01fce2 doc: Improve documentation for 2-D plot functions Rik <rik@octave.org> parents: 14359 diff changeset	43 ## length as @var{x} specifying the label for each slice.
19593 446c46af4b42 strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 17744 diff changeset	44 ##
24431 0c6cedafc71e doc: Use 'axes' rather than 'axis' appropriately in docstrings. Rik <rik@octave.org> parents: 23219 diff changeset	45 ## If the first argument @var{hax} is an axes handle, then plot into this axes,
17122 eaab03308c0b doc: Rewrite docstrings for most plot functions. Rik <rik@octave.org> parents: 17064 diff changeset	46 ## rather than the current axes returned by @code{gca}.
7118 d32f867e4dda [project @ 2007-11-07 20:44:11 by jwe] jwe parents: diff changeset	47 ##
14001 5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761) Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	48 ## The optional return value @var{h} is a list of handles to the patch
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761) Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	49 ## and text objects generating the plot.
7118 d32f867e4dda [project @ 2007-11-07 20:44:11 by jwe] jwe parents: diff changeset	50 ##
17064 84e000930ca5 pie.m, pie3.m: Update to use new __plt_get_axis_arg__. Rik <rik@octave.org> parents: 16814 diff changeset	51 ## Note: If @code{sum (@var{x}) @leq{} 1} then the elements of @var{x} are
21546 f7f97d7e9294 doc: Wrap m-file docstrings to 79 characters + newline (80 total). Rik <rik@octave.org> parents: 20852 diff changeset	52 ## interpreted as percentages directly and are not normalized by @code{sum
f7f97d7e9294 doc: Wrap m-file docstrings to 79 characters + newline (80 total). Rik <rik@octave.org> parents: 20852 diff changeset	53 ## (x)}. Furthermore, if the sum is less than 1 then there will be a missing
f7f97d7e9294 doc: Wrap m-file docstrings to 79 characters + newline (80 total). Rik <rik@octave.org> parents: 20852 diff changeset	54 ## slice in the pie plot to represent the missing, unspecified percentage.
17064 84e000930ca5 pie.m, pie3.m: Update to use new __plt_get_axis_arg__. Rik <rik@octave.org> parents: 16814 diff changeset	55 ##
84e000930ca5 pie.m, pie3.m: Update to use new __plt_get_axis_arg__. Rik <rik@octave.org> parents: 16814 diff changeset	56 ## @seealso{pie3, bar, hist, rose}
7118 d32f867e4dda [project @ 2007-11-07 20:44:11 by jwe] jwe parents: diff changeset	57 ## @end deftypefn
d32f867e4dda [project @ 2007-11-07 20:44:11 by jwe] jwe parents: diff changeset	58
25836 07cb3e098c0a Use "Octave Forge" spelling in all files. Rik <rik@octave.org> parents: 25054 diff changeset	59 ## Very roughly based on pie.m from Octave Forge whose author was
7118 d32f867e4dda [project @ 2007-11-07 20:44:11 by jwe] jwe parents: diff changeset	60 ## Daniel Heiserer <Daniel.heiserer@physik.tu-muenchen.de>
d32f867e4dda [project @ 2007-11-07 20:44:11 by jwe] jwe parents: diff changeset	61
17064 84e000930ca5 pie.m, pie3.m: Update to use new __plt_get_axis_arg__. Rik <rik@octave.org> parents: 16814 diff changeset	62 function h = pie (varargin)
7118 d32f867e4dda [project @ 2007-11-07 20:44:11 by jwe] jwe parents: diff changeset	63
17064 84e000930ca5 pie.m, pie3.m: Update to use new __plt_get_axis_arg__. Rik <rik@octave.org> parents: 16814 diff changeset	64 [hax, varargin, nargin] = __plt_get_axis_arg__ ("pie", varargin{:});
7215 dd88d61d443f [project @ 2007-11-29 16:44:45 by jwe] jwe parents: 7208 diff changeset	65
7118 d32f867e4dda [project @ 2007-11-07 20:44:11 by jwe] jwe parents: diff changeset	66 if (nargin < 1)
d32f867e4dda [project @ 2007-11-07 20:44:11 by jwe] jwe parents: diff changeset	67 print_usage ();
d32f867e4dda [project @ 2007-11-07 20:44:11 by jwe] jwe parents: diff changeset	68 endif
d32f867e4dda [project @ 2007-11-07 20:44:11 by jwe] jwe parents: diff changeset	69
25233 c64f7a95b464 pie.m, pie3.m: Validate that data input is finite (bug #53480). Rik <rik@octave.org> parents: 25054 diff changeset	70 if (! all (isfinite (varargin{1})))
25436 996d78102a71 maint: Strip trailing whitespace from source files. John W. Eaton <jwe@octave.org> parents: 25233 diff changeset	71 error ("pie: all data in X must be finite");
25233 c64f7a95b464 pie.m, pie3.m: Validate that data input is finite (bug #53480). Rik <rik@octave.org> parents: 25054 diff changeset	72 endif
c64f7a95b464 pie.m, pie3.m: Validate that data input is finite (bug #53480). Rik <rik@octave.org> parents: 25054 diff changeset	73
17211 87ba70043bfc Don't use ifelse in plot fcns to avoid unnecessary fcn evaluations. Rik <rik@octave.org> parents: 17190 diff changeset	74 oldfig = [];
17301 68bcac3c043a Correct inversion accidentally introduced in cset 87ba70043bfc. Rik <rik@octave.org> parents: 17211 diff changeset	75 if (! isempty (hax))
17211 87ba70043bfc Don't use ifelse in plot fcns to avoid unnecessary fcn evaluations. Rik <rik@octave.org> parents: 17190 diff changeset	76 oldfig = get (0, "currentfigure");
87ba70043bfc Don't use ifelse in plot fcns to avoid unnecessary fcn evaluations. Rik <rik@octave.org> parents: 17190 diff changeset	77 endif
17064 84e000930ca5 pie.m, pie3.m: Update to use new __plt_get_axis_arg__. Rik <rik@octave.org> parents: 16814 diff changeset	78 unwind_protect
84e000930ca5 pie.m, pie3.m: Update to use new __plt_get_axis_arg__. Rik <rik@octave.org> parents: 16814 diff changeset	79 hax = newplot (hax);
84e000930ca5 pie.m, pie3.m: Update to use new __plt_get_axis_arg__. Rik <rik@octave.org> parents: 16814 diff changeset	80 htmp = __pie__ ("pie", hax, varargin{:});
84e000930ca5 pie.m, pie3.m: Update to use new __plt_get_axis_arg__. Rik <rik@octave.org> parents: 16814 diff changeset	81 unwind_protect_cleanup
84e000930ca5 pie.m, pie3.m: Update to use new __plt_get_axis_arg__. Rik <rik@octave.org> parents: 16814 diff changeset	82 if (! isempty (oldfig))
84e000930ca5 pie.m, pie3.m: Update to use new __plt_get_axis_arg__. Rik <rik@octave.org> parents: 16814 diff changeset	83 set (0, "currentfigure", oldfig);
84e000930ca5 pie.m, pie3.m: Update to use new __plt_get_axis_arg__. Rik <rik@octave.org> parents: 16814 diff changeset	84 endif
84e000930ca5 pie.m, pie3.m: Update to use new __plt_get_axis_arg__. Rik <rik@octave.org> parents: 16814 diff changeset	85 end_unwind_protect
84e000930ca5 pie.m, pie3.m: Update to use new __plt_get_axis_arg__. Rik <rik@octave.org> parents: 16814 diff changeset	86
7118 d32f867e4dda [project @ 2007-11-07 20:44:11 by jwe] jwe parents: diff changeset	87 if (nargout > 0)
17064 84e000930ca5 pie.m, pie3.m: Update to use new __plt_get_axis_arg__. Rik <rik@octave.org> parents: 16814 diff changeset	88 h = htmp;
7118 d32f867e4dda [project @ 2007-11-07 20:44:11 by jwe] jwe parents: diff changeset	89 endif
7119 d22ad51b9cf8 [project @ 2007-11-07 21:06:27 by jwe] jwe parents: 7118 diff changeset	90
7118 d32f867e4dda [project @ 2007-11-07 20:44:11 by jwe] jwe parents: diff changeset	91 endfunction
d32f867e4dda [project @ 2007-11-07 20:44:11 by jwe] jwe parents: diff changeset	92
14001 5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761) Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	93
7120 a2174fb073d4 [project @ 2007-11-07 21:26:43 by jwe] jwe parents: 7119 diff changeset	94 %!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	95 %! clf;
7120 a2174fb073d4 [project @ 2007-11-07 21:26:43 by jwe] jwe parents: 7119 diff changeset	96 %! pie ([3, 2, 1], [0, 0, 1]);
14001 5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761) Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	97 %! colormap ([1,0,0;0,1,0;0,0,1;1,1,0;1,0,1;0,1,1]);
22302 1c4cd12987f5 Use Octave syntax in graphics demos. Rik <rik@octave.org> parents: 21546 diff changeset	98 %! title ("pie() with exploded wedge");
7120 a2174fb073d4 [project @ 2007-11-07 21:26:43 by jwe] jwe parents: 7119 diff changeset	99
a2174fb073d4 [project @ 2007-11-07 21:26:43 by jwe] jwe parents: 7119 diff changeset	100 %!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	101 %! clf;
22302 1c4cd12987f5 Use Octave syntax in graphics demos. Rik <rik@octave.org> parents: 21546 diff changeset	102 %! pie ([3, 2, 1], [0, 0, 1], {"Cheddar", "Swiss", "Camembert"});
14001 5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761) Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	103 %! colormap ([1,0,0;0,1,0;0,0,1;1,1,0;1,0,1;0,1,1]);
7120 a2174fb073d4 [project @ 2007-11-07 21:26:43 by jwe] jwe parents: 7119 diff changeset	104 %! axis ([-2,2,-2,2]);
22302 1c4cd12987f5 Use Octave syntax in graphics demos. Rik <rik@octave.org> parents: 21546 diff changeset	105 %! title ("pie() with labels");
17190 df4c4b7708a4 Add titles and clean-up plotting %!demos. Rik <rik@octave.org> parents: 17122 diff changeset	106
11341 3c7ba1e3dc21 Add missing option slice for pie and pie3 Kai Habel <kai.habel@gmx.de> parents: 11330 diff changeset	107
3c7ba1e3dc21 Add missing option slice for pie and pie3 Kai Habel <kai.habel@gmx.de> parents: 11330 diff changeset	108 %!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	109 %! clf;
22302 1c4cd12987f5 Use Octave syntax in graphics demos. Rik <rik@octave.org> parents: 21546 diff changeset	110 %! pie ([0.17, 0.34, 0.41], {"Cheddar", "Swiss", "Camembert"});
14001 5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761) Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	111 %! colormap ([1,0,0;0,1,0;0,0,1;1,1,0;1,0,1;0,1,1]);
11341 3c7ba1e3dc21 Add missing option slice for pie and pie3 Kai Habel <kai.habel@gmx.de> parents: 11330 diff changeset	112 %! axis ([-2,2,-2,2]);
22302 1c4cd12987f5 Use Octave syntax in graphics demos. Rik <rik@octave.org> parents: 21546 diff changeset	113 %! title ("pie() with missing slice");
25233 c64f7a95b464 pie.m, pie3.m: Validate that data input is finite (bug #53480). Rik <rik@octave.org> parents: 25054 diff changeset	114
c64f7a95b464 pie.m, pie3.m: Validate that data input is finite (bug #53480). Rik <rik@octave.org> parents: 25054 diff changeset	115 ## Test input validation
28896 90fea9cc9caa test: Add expected error message <Invalid call> to BIST tests for nargin. Rik <rik@octave.org> parents: 27923 diff changeset	116 %!error <Invalid call> pie ()
25233 c64f7a95b464 pie.m, pie3.m: Validate that data input is finite (bug #53480). Rik <rik@octave.org> parents: 25054 diff changeset	117 %!error <all data in X must be finite> pie ([1 2 Inf])
c64f7a95b464 pie.m, pie3.m: Validate that data input is finite (bug #53480). Rik <rik@octave.org> parents: 25054 diff changeset	118 %!error <all data in X must be finite> pie ([1 2 NaN])

Mercurial > octave

annotate scripts/plot/draw/pie.m @ 33670:9dd2a8e7e0d5 default tip @