Mercurial > octave
view scripts/plot/draw/pie.m @ 25233:c64f7a95b464
pie.m, pie3.m: Validate that data input is finite (bug #53480).
* pie.m, pie3.m: Use isfinite() to check input data X.
Add BIST tests for input validation.
author | Rik <rik@octave.org> |
---|---|
date | Thu, 12 Apr 2018 13:30:50 -0700 |
parents | 6652d3823428 |
children | 996d78102a71 |
line wrap: on
line source
## Copyright (C) 2007-2018 David Bateman ## ## This file is part of Octave. ## ## Octave is free software: you can redistribute it and/or modify it ## under the terms of the GNU General Public License as published by ## the Free Software Foundation, either version 3 of the License, or ## (at your option) any later version. ## ## Octave is distributed in the hope that it will be useful, but ## WITHOUT ANY WARRANTY; without even the implied warranty of ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the ## GNU General Public License for more details. ## ## You should have received a copy of the GNU General Public License ## along with Octave; see the file COPYING. If not, see ## <https://www.gnu.org/licenses/>. ## -*- texinfo -*- ## @deftypefn {} {} pie (@var{x}) ## @deftypefnx {} {} pie (@dots{}, @var{explode}) ## @deftypefnx {} {} pie (@dots{}, @var{labels}) ## @deftypefnx {} {} pie (@var{hax}, @dots{}); ## @deftypefnx {} {@var{h} =} pie (@dots{}); ## Plot a 2-D pie chart. ## ## When called with a single vector argument, produce a pie chart of the ## elements in @var{x}. The size of the ith slice is the percentage that the ## element @var{x}i represents of the total sum of @var{x}: ## @code{pct = @var{x}(i) / sum (@var{x})}. ## ## The optional input @var{explode} is a vector of the same length as @var{x} ## that, if nonzero, "explodes" the slice from the pie chart. ## ## The optional input @var{labels} is a cell array of strings of the same ## length as @var{x} specifying the label for each slice. ## ## If the first argument @var{hax} is an axes handle, then plot into this axes, ## rather than the current axes returned by @code{gca}. ## ## The optional return value @var{h} is a list of handles to the patch ## and text objects generating the plot. ## ## Note: If @code{sum (@var{x}) @leq{} 1} then the elements of @var{x} are ## interpreted as percentages directly and are not normalized by @code{sum ## (x)}. Furthermore, if the sum is less than 1 then there will be a missing ## slice in the pie plot to represent the missing, unspecified percentage. ## ## @seealso{pie3, bar, hist, rose} ## @end deftypefn ## Very roughly based on pie.m from octave-forge whose author was ## Daniel Heiserer <Daniel.heiserer@physik.tu-muenchen.de> function h = pie (varargin) [hax, varargin, nargin] = __plt_get_axis_arg__ ("pie", varargin{:}); if (nargin < 1) print_usage (); endif if (! all (isfinite (varargin{1}))) error ("pie: all data in X must be finite"); endif oldfig = []; if (! isempty (hax)) oldfig = get (0, "currentfigure"); endif unwind_protect hax = newplot (hax); htmp = __pie__ ("pie", hax, varargin{:}); unwind_protect_cleanup if (! isempty (oldfig)) set (0, "currentfigure", oldfig); endif end_unwind_protect if (nargout > 0) h = htmp; endif endfunction %!demo %! clf; %! pie ([3, 2, 1], [0, 0, 1]); %! colormap ([1,0,0;0,1,0;0,0,1;1,1,0;1,0,1;0,1,1]); %! title ("pie() with exploded wedge"); %!demo %! clf; %! pie ([3, 2, 1], [0, 0, 1], {"Cheddar", "Swiss", "Camembert"}); %! colormap ([1,0,0;0,1,0;0,0,1;1,1,0;1,0,1;0,1,1]); %! axis ([-2,2,-2,2]); %! title ("pie() with labels"); %!demo %! clf; %! pie ([0.17, 0.34, 0.41], {"Cheddar", "Swiss", "Camembert"}); %! colormap ([1,0,0;0,1,0;0,0,1;1,1,0;1,0,1;0,1,1]); %! axis ([-2,2,-2,2]); %! title ("pie() with missing slice"); ## Test input validation %!error pie () %!error <all data in X must be finite> pie ([1 2 Inf]) %!error <all data in X must be finite> pie ([1 2 NaN])