annotate scripts/plot/pie.m @ 16950:b34202b24212

fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961). * scripts/plot/fplot.m: Add ability to specify n,tol,fmt in any order and simultaneously. Return data rather than plotting it if asked. Use additional test on progress of algorithm to decide whether to quit. Add %!demo and %!tests.
author Rik <rik@octave.org>
date Thu, 11 Jul 2013 09:25:54 -0700
parents 64e7bb01fce2
children 84e000930ca5
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
14138
72c96de7a403 maint: update copyright notices for 2012
John W. Eaton <jwe@octave.org>
parents: 14092
diff changeset
1 ## Copyright (C) 2007-2012 David Bateman
7118
d32f867e4dda [project @ 2007-11-07 20:44:11 by jwe]
jwe
parents:
diff changeset
2 ##
d32f867e4dda [project @ 2007-11-07 20:44:11 by jwe]
jwe
parents:
diff changeset
3 ## This file is part of Octave.
d32f867e4dda [project @ 2007-11-07 20:44:11 by jwe]
jwe
parents:
diff changeset
4 ##
d32f867e4dda [project @ 2007-11-07 20:44:11 by jwe]
jwe
parents:
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
d32f867e4dda [project @ 2007-11-07 20:44:11 by jwe]
jwe
parents:
diff changeset
6 ## under the terms of the GNU General Public License as published by
d32f867e4dda [project @ 2007-11-07 20:44:11 by jwe]
jwe
parents:
diff changeset
7 ## the Free Software Foundation; either version 3 of the License, or (at
d32f867e4dda [project @ 2007-11-07 20:44:11 by jwe]
jwe
parents:
diff changeset
8 ## your option) any later version.
d32f867e4dda [project @ 2007-11-07 20:44:11 by jwe]
jwe
parents:
diff changeset
9 ##
d32f867e4dda [project @ 2007-11-07 20:44:11 by jwe]
jwe
parents:
diff changeset
10 ## 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
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
d32f867e4dda [project @ 2007-11-07 20:44:11 by jwe]
jwe
parents:
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
d32f867e4dda [project @ 2007-11-07 20:44:11 by jwe]
jwe
parents:
diff changeset
13 ## General Public License for more details.
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 ## 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
16 ## along with Octave; see the file COPYING. If not, see
d32f867e4dda [project @ 2007-11-07 20:44:11 by jwe]
jwe
parents:
diff changeset
17 ## <http://www.gnu.org/licenses/>.
d32f867e4dda [project @ 2007-11-07 20:44:11 by jwe]
jwe
parents:
diff changeset
18
d32f867e4dda [project @ 2007-11-07 20:44:11 by jwe]
jwe
parents:
diff changeset
19 ## -*- texinfo -*-
11341
3c7ba1e3dc21 Add missing option slice for pie and pie3
Kai Habel <kai.habel@gmx.de>
parents: 11330
diff changeset
20 ## @deftypefn {Function File} {} pie (@var{x})
3c7ba1e3dc21 Add missing option slice for pie and pie3
Kai Habel <kai.habel@gmx.de>
parents: 11330
diff changeset
21 ## @deftypefnx {Function File} {} pie (@var{x}, @var{explode})
7118
d32f867e4dda [project @ 2007-11-07 20:44:11 by jwe]
jwe
parents:
diff changeset
22 ## @deftypefnx {Function File} {} pie (@dots{}, @var{labels})
d32f867e4dda [project @ 2007-11-07 20:44:11 by jwe]
jwe
parents:
diff changeset
23 ## @deftypefnx {Function File} {} pie (@var{h}, @dots{});
d32f867e4dda [project @ 2007-11-07 20:44:11 by jwe]
jwe
parents:
diff changeset
24 ## @deftypefnx {Function File} {@var{h} =} pie (@dots{});
16814
64e7bb01fce2 doc: Improve documentation for 2-D plot functions
Rik <rik@octave.org>
parents: 14359
diff changeset
25 ## Plot a 2-D pie chart.
7118
d32f867e4dda [project @ 2007-11-07 20:44:11 by jwe]
jwe
parents:
diff changeset
26 ##
16814
64e7bb01fce2 doc: Improve documentation for 2-D plot functions
Rik <rik@octave.org>
parents: 14359
diff changeset
27 ## 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
28 ## elements in @var{x}. The size of the ith slice is the percentage that the
64e7bb01fce2 doc: Improve documentation for 2-D plot functions
Rik <rik@octave.org>
parents: 14359
diff changeset
29 ## element @var{x}i represents of the total sum of @var{x}.
7118
d32f867e4dda [project @ 2007-11-07 20:44:11 by jwe]
jwe
parents:
diff changeset
30 ##
16814
64e7bb01fce2 doc: Improve documentation for 2-D plot functions
Rik <rik@octave.org>
parents: 14359
diff changeset
31 ## The variable @var{explode} is a vector of the same length as @var{x} that,
64e7bb01fce2 doc: Improve documentation for 2-D plot functions
Rik <rik@octave.org>
parents: 14359
diff changeset
32 ## if non-zero, "explodes" the slice from the 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 ## 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
35 ## length as @var{x} specifying the label for each slice.
7118
d32f867e4dda [project @ 2007-11-07 20:44:11 by jwe]
jwe
parents:
diff changeset
36 ##
14001
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
37 ## 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
38 ## and text objects generating the plot.
7118
d32f867e4dda [project @ 2007-11-07 20:44:11 by jwe]
jwe
parents:
diff changeset
39 ##
11330
4f399d91eb32 add pie3 to plot functions
Kai Habel <kai.habel@gmx.de>
parents: 10793
diff changeset
40 ## @seealso{pie3, bar, stem}
7118
d32f867e4dda [project @ 2007-11-07 20:44:11 by jwe]
jwe
parents:
diff changeset
41 ## @end deftypefn
d32f867e4dda [project @ 2007-11-07 20:44:11 by jwe]
jwe
parents:
diff changeset
42
d32f867e4dda [project @ 2007-11-07 20:44:11 by jwe]
jwe
parents:
diff changeset
43 ## Very roughly based on pie.m from octave-forge whose author was
d32f867e4dda [project @ 2007-11-07 20:44:11 by jwe]
jwe
parents:
diff changeset
44 ## Daniel Heiserer <Daniel.heiserer@physik.tu-muenchen.de>
d32f867e4dda [project @ 2007-11-07 20:44:11 by jwe]
jwe
parents:
diff changeset
45
d32f867e4dda [project @ 2007-11-07 20:44:11 by jwe]
jwe
parents:
diff changeset
46 function retval = pie (varargin)
d32f867e4dda [project @ 2007-11-07 20:44:11 by jwe]
jwe
parents:
diff changeset
47
7215
dd88d61d443f [project @ 2007-11-29 16:44:45 by jwe]
jwe
parents: 7208
diff changeset
48 [h, varargin] = __plt_get_axis_arg__ ("pie", varargin{:});
dd88d61d443f [project @ 2007-11-29 16:44:45 by jwe]
jwe
parents: 7208
diff changeset
49
7118
d32f867e4dda [project @ 2007-11-07 20:44:11 by jwe]
jwe
parents:
diff changeset
50 if (nargin < 1)
d32f867e4dda [project @ 2007-11-07 20:44:11 by jwe]
jwe
parents:
diff changeset
51 print_usage ();
7215
dd88d61d443f [project @ 2007-11-29 16:44:45 by jwe]
jwe
parents: 7208
diff changeset
52 else
7118
d32f867e4dda [project @ 2007-11-07 20:44:11 by jwe]
jwe
parents:
diff changeset
53 oldh = gca ();
d32f867e4dda [project @ 2007-11-07 20:44:11 by jwe]
jwe
parents:
diff changeset
54 unwind_protect
d32f867e4dda [project @ 2007-11-07 20:44:11 by jwe]
jwe
parents:
diff changeset
55 axes (h);
d32f867e4dda [project @ 2007-11-07 20:44:11 by jwe]
jwe
parents:
diff changeset
56 newplot ();
11330
4f399d91eb32 add pie3 to plot functions
Kai Habel <kai.habel@gmx.de>
parents: 10793
diff changeset
57 tmp = __pie__ ("pie", h, varargin{:});
7118
d32f867e4dda [project @ 2007-11-07 20:44:11 by jwe]
jwe
parents:
diff changeset
58 unwind_protect_cleanup
d32f867e4dda [project @ 2007-11-07 20:44:11 by jwe]
jwe
parents:
diff changeset
59 axes (oldh);
d32f867e4dda [project @ 2007-11-07 20:44:11 by jwe]
jwe
parents:
diff changeset
60 end_unwind_protect
d32f867e4dda [project @ 2007-11-07 20:44:11 by jwe]
jwe
parents:
diff changeset
61 endif
d32f867e4dda [project @ 2007-11-07 20:44:11 by jwe]
jwe
parents:
diff changeset
62
d32f867e4dda [project @ 2007-11-07 20:44:11 by jwe]
jwe
parents:
diff changeset
63 if (nargout > 0)
d32f867e4dda [project @ 2007-11-07 20:44:11 by jwe]
jwe
parents:
diff changeset
64 retval = tmp;
d32f867e4dda [project @ 2007-11-07 20:44:11 by jwe]
jwe
parents:
diff changeset
65 endif
7119
d22ad51b9cf8 [project @ 2007-11-07 21:06:27 by jwe]
jwe
parents: 7118
diff changeset
66
7118
d32f867e4dda [project @ 2007-11-07 20:44:11 by jwe]
jwe
parents:
diff changeset
67 endfunction
d32f867e4dda [project @ 2007-11-07 20:44:11 by jwe]
jwe
parents:
diff changeset
68
14001
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
69
7120
a2174fb073d4 [project @ 2007-11-07 21:26:43 by jwe]
jwe
parents: 7119
diff changeset
70 %!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
71 %! clf;
7120
a2174fb073d4 [project @ 2007-11-07 21:26:43 by jwe]
jwe
parents: 7119
diff changeset
72 %! 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
73 %! 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
74
a2174fb073d4 [project @ 2007-11-07 21:26:43 by jwe]
jwe
parents: 7119
diff changeset
75 %!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
76 %! clf;
14245
4506eade9f04 Use Matlab coding conventions for demos in plot/ directory.
Rik <octave@nomad.inbox5.com>
parents: 14237
diff changeset
77 %! 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
78 %! 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
79 %! axis ([-2,2,-2,2]);
11341
3c7ba1e3dc21 Add missing option slice for pie and pie3
Kai Habel <kai.habel@gmx.de>
parents: 11330
diff changeset
80
3c7ba1e3dc21 Add missing option slice for pie and pie3
Kai Habel <kai.habel@gmx.de>
parents: 11330
diff changeset
81 %!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
82 %! clf;
14245
4506eade9f04 Use Matlab coding conventions for demos in plot/ directory.
Rik <octave@nomad.inbox5.com>
parents: 14237
diff changeset
83 %! 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
84 %! 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
85 %! axis ([-2,2,-2,2]);
14245
4506eade9f04 Use Matlab coding conventions for demos in plot/ directory.
Rik <octave@nomad.inbox5.com>
parents: 14237
diff changeset
86 %! title ('missing slice');
14001
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
87