Mercurial > octave

annotate scripts/plot/draw/pie3.m @ 27919:1891570abac8

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
update Octave Project Developers copyright for the new year In files that have the "Octave Project Developers" copyright notice, update for 2020.
author John W. Eaton <jwe@octave.org>
date Mon, 06 Jan 2020 22:29:51 -0500
parents b442ec6dda5c
children bd51beb6205e
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
27919
1891570abac8 update Octave Project Developers copyright for the new year
John W. Eaton <jwe@octave.org>
parents: 27918
diff changeset
1 ## Copyright (C) 2007-2020 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
2 ##
b442ec6dda5c use centralized file for copyright info for individual contributors
John W. Eaton <jwe@octave.org>
parents: 27231
diff changeset
3 ## See the file COPYRIGHT.md in the top-level directory of this distribution
b442ec6dda5c use centralized file for copyright info for individual contributors
John W. Eaton <jwe@octave.org>
parents: 27231
diff changeset
4 ## or <https://octave.org/COPYRIGHT.html/>.
b442ec6dda5c use centralized file for copyright info for individual contributors
John W. Eaton <jwe@octave.org>
parents: 27231
diff changeset
5 ##
11330
4f399d91eb32 add pie3 to plot functions
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
6 ##
4f399d91eb32 add pie3 to plot functions
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
7 ## This file is part of Octave.
4f399d91eb32 add pie3 to plot functions
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
8 ##
24534
194eb4bd202b maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents: 24432
diff changeset
9 ## Octave is free software: you can redistribute it and/or modify it
11330
4f399d91eb32 add pie3 to plot functions
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
10 ## 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
11 ## 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
12 ## (at your option) any later version.
11330
4f399d91eb32 add pie3 to plot functions
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
13 ##
4f399d91eb32 add pie3 to plot functions
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
14 ## Octave is distributed in the hope that it will be useful, but
4f399d91eb32 add pie3 to plot functions
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
15 ## WITHOUT ANY WARRANTY; without even the implied warranty of
22755
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22323
diff changeset
16 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22323
diff changeset
17 ## GNU General Public License for more details.
11330
4f399d91eb32 add pie3 to plot functions
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
18 ##
4f399d91eb32 add pie3 to plot functions
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
19 ## You should have received a copy of the GNU General Public License
4f399d91eb32 add pie3 to plot functions
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
20 ## 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
21 ## <https://www.gnu.org/licenses/>.
11330
4f399d91eb32 add pie3 to plot functions
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
22
4f399d91eb32 add pie3 to plot functions
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
23 ## -*- texinfo -*-
20852
516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files.
Rik <rik@octave.org>
parents: 19697
diff changeset
24 ## @deftypefn {} {} pie3 (@var{x})
516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files.
Rik <rik@octave.org>
parents: 19697
diff changeset
25 ## @deftypefnx {} {} pie3 (@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
26 ## @deftypefnx {} {} pie3 (@dots{}, @var{labels})
27231
940c1b6e3453 doc: Remove stray semicolons from pie, pie3 calling forms.
Rik <rik@octave.org>
parents: 26376
diff changeset
27 ## @deftypefnx {} {} pie3 (@var{hax}, @dots{})
940c1b6e3453 doc: Remove stray semicolons from pie, pie3 calling forms.
Rik <rik@octave.org>
parents: 26376
diff changeset
28 ## @deftypefnx {} {@var{h} =} pie3 (@dots{})
16814
64e7bb01fce2 doc: Improve documentation for 2-D plot functions
Rik <rik@octave.org>
parents: 14359
diff changeset
29 ## Plot a 3-D pie chart.
11330
4f399d91eb32 add pie3 to plot functions
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
30 ##
11563
3c6e8aaa9555 Grammarcheck m-files before 3.4 release.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
31 ## Called with a single vector argument, produces a 3-D pie chart of the
16814
64e7bb01fce2 doc: Improve documentation for 2-D plot functions
Rik <rik@octave.org>
parents: 14359
diff changeset
32 ## 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
33 ## 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
34 ## @code{pct = @var{x}(i) / sum (@var{x})}.
11330
4f399d91eb32 add pie3 to plot functions
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
35 ##
17064
84e000930ca5 pie.m, pie3.m: Update to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16814
diff changeset
36 ## 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
37 ## that, if nonzero, "explodes" the slice from the pie chart.
11330
4f399d91eb32 add pie3 to plot functions
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
38 ##
16814
64e7bb01fce2 doc: Improve documentation for 2-D plot functions
Rik <rik@octave.org>
parents: 14359
diff changeset
39 ## 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
40 ## length as @var{x} specifying the label for each slice.
11330
4f399d91eb32 add pie3 to plot functions
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
41 ##
24431
0c6cedafc71e doc: Use 'axes' rather than 'axis' appropriately in docstrings.
Rik <rik@octave.org>
parents: 23219
diff changeset
42 ## 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
43 ## rather than the current axes returned by @code{gca}.
17064
84e000930ca5 pie.m, pie3.m: Update to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16814
diff changeset
44 ##
17122
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17064
diff changeset
45 ## The optional return value @var{h} is a list of graphics handles to the
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17064
diff changeset
46 ## patch, surface, and text objects generating the plot.
11330
4f399d91eb32 add pie3 to plot functions
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
47 ##
17064
84e000930ca5 pie.m, pie3.m: Update to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16814
diff changeset
48 ## 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
49 ## 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
50 ## (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
51 ## 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
52 ##
84e000930ca5 pie.m, pie3.m: Update to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16814
diff changeset
53 ## @seealso{pie, bar, hist, rose}
11330
4f399d91eb32 add pie3 to plot functions
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
54 ## @end deftypefn
4f399d91eb32 add pie3 to plot functions
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
55
25836
07cb3e098c0a Use "Octave Forge" spelling in all files.
Rik <rik@octave.org>
parents: 25054
diff changeset
56 ## Very roughly based on pie.m from Octave Forge whose author was
11330
4f399d91eb32 add pie3 to plot functions
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
57 ## Daniel Heiserer <Daniel.heiserer@physik.tu-muenchen.de>
4f399d91eb32 add pie3 to plot functions
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
58
17064
84e000930ca5 pie.m, pie3.m: Update to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16814
diff changeset
59 function h = pie3 (varargin)
11330
4f399d91eb32 add pie3 to plot functions
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
60
17064
84e000930ca5 pie.m, pie3.m: Update to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16814
diff changeset
61 [hax, varargin, nargin] = __plt_get_axis_arg__ ("pie3", varargin{:});
11330
4f399d91eb32 add pie3 to plot functions
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
62
4f399d91eb32 add pie3 to plot functions
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
63 if (nargin < 1)
4f399d91eb32 add pie3 to plot functions
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
64 print_usage ();
4f399d91eb32 add pie3 to plot functions
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
65 endif
4f399d91eb32 add pie3 to plot functions
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
66
25233
c64f7a95b464 pie.m, pie3.m: Validate that data input is finite (bug #53480).
Rik <rik@octave.org>
parents: 25054
diff changeset
67 if (! all (isfinite (varargin{1})))
25436
996d78102a71 maint: Strip trailing whitespace from source files.
John W. Eaton <jwe@octave.org>
parents: 25233
diff changeset
68 error ("pie3: 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
69 endif
c64f7a95b464 pie.m, pie3.m: Validate that data input is finite (bug #53480).
Rik <rik@octave.org>
parents: 25054
diff changeset
70
17211
87ba70043bfc Don't use ifelse in plot fcns to avoid unnecessary fcn evaluations.
Rik <rik@octave.org>
parents: 17190
diff changeset
71 oldfig = [];
17301
68bcac3c043a Correct inversion accidentally introduced in cset 87ba70043bfc.
Rik <rik@octave.org>
parents: 17211
diff changeset
72 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
73 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
74 endif
17064
84e000930ca5 pie.m, pie3.m: Update to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16814
diff changeset
75 unwind_protect
84e000930ca5 pie.m, pie3.m: Update to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16814
diff changeset
76 hax = newplot (hax);
84e000930ca5 pie.m, pie3.m: Update to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16814
diff changeset
77 htmp = __pie__ ("pie3", hax, varargin{:});
84e000930ca5 pie.m, pie3.m: Update to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16814
diff changeset
78 unwind_protect_cleanup
84e000930ca5 pie.m, pie3.m: Update to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16814
diff changeset
79 if (! isempty (oldfig))
84e000930ca5 pie.m, pie3.m: Update to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16814
diff changeset
80 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
81 endif
84e000930ca5 pie.m, pie3.m: Update to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16814
diff changeset
82 end_unwind_protect
84e000930ca5 pie.m, pie3.m: Update to use new __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16814
diff changeset
83
11330
4f399d91eb32 add pie3 to plot functions
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
84 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
85 h = htmp;
11330
4f399d91eb32 add pie3 to plot functions
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
86 endif
4f399d91eb32 add pie3 to plot functions
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
87
4f399d91eb32 add pie3 to plot functions
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
88 endfunction
4f399d91eb32 add pie3 to plot functions
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
89
14001
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents: 12344
diff changeset
90
11330
4f399d91eb32 add pie3 to plot functions
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
91 %!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
92 %! clf;
11330
4f399d91eb32 add pie3 to plot functions
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
93 %! pie3 ([5:-1:1], [0, 0, 1, 0, 0]);
14001
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents: 12344
diff changeset
94 %! 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
95 %! title ("pie3() with exploded wedge");
11330
4f399d91eb32 add pie3 to plot functions
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
96
4f399d91eb32 add pie3 to plot functions
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
97 %!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
98 %! clf;
22302
1c4cd12987f5 Use Octave syntax in graphics demos.
Rik <rik@octave.org>
parents: 21546
diff changeset
99 %! pie3 ([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: 12344
diff changeset
100 %! colormap ([1,0,0;0,1,0;0,0,1;1,1,0;1,0,1;0,1,1]);
11330
4f399d91eb32 add pie3 to plot functions
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
101 %! axis ([-2,2,-2,2]);
22302
1c4cd12987f5 Use Octave syntax in graphics demos.
Rik <rik@octave.org>
parents: 21546
diff changeset
102 %! title ("pie3() with labels");
11341
3c7ba1e3dc21 Add missing option slice for pie and pie3
Kai Habel <kai.habel@gmx.de>
parents: 11330
diff changeset
103
3c7ba1e3dc21 Add missing option slice for pie and pie3
Kai Habel <kai.habel@gmx.de>
parents: 11330
diff changeset
104 %!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
105 %! clf;
22302
1c4cd12987f5 Use Octave syntax in graphics demos.
Rik <rik@octave.org>
parents: 21546
diff changeset
106 %! pie3 ([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: 12344
diff changeset
107 %! 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
108 %! axis ([-2,2,-2,2]);
22302
1c4cd12987f5 Use Octave syntax in graphics demos.
Rik <rik@octave.org>
parents: 21546
diff changeset
109 %! title ("pie3() 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
110
c64f7a95b464 pie.m, pie3.m: Validate that data input is finite (bug #53480).
Rik <rik@octave.org>
parents: 25054
diff changeset
111 ## Test input validation
c64f7a95b464 pie.m, pie3.m: Validate that data input is finite (bug #53480).
Rik <rik@octave.org>
parents: 25054
diff changeset
112 %!error pie3 ()
c64f7a95b464 pie.m, pie3.m: Validate that data input is finite (bug #53480).
Rik <rik@octave.org>
parents: 25054
diff changeset
113 %!error <all data in X must be finite> pie3 ([1 2 Inf])
c64f7a95b464 pie.m, pie3.m: Validate that data input is finite (bug #53480).
Rik <rik@octave.org>
parents: 25054
diff changeset
114 %!error <all data in X must be finite> pie3 ([1 2 NaN])