annotate scripts/plot/pareto.m @ 11191:01ddaedd6ad5

Reverse changeset b1f4bdc276b6. Use all lower case for "uniformoutput" option.
author Rik <octave@nomad.inbox5.com>
date Thu, 04 Nov 2010 12:18:08 -0700
parents 4cb1522e4d0f
children fd0a3ac60b0e
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
8920
eb63fbe60fab update copyright notices
John W. Eaton <jwe@octave.org>
parents: 8790
diff changeset
1 ## Copyright (C) 2007, 2008, 2009 David Bateman
7220
66081694ffb8 [project @ 2007-11-29 23:14:07 by jwe]
jwe
parents:
diff changeset
2 ## Copyright (C) 2003 Alberto Terruzzi
66081694ffb8 [project @ 2007-11-29 23:14:07 by jwe]
jwe
parents:
diff changeset
3 ##
66081694ffb8 [project @ 2007-11-29 23:14:07 by jwe]
jwe
parents:
diff changeset
4 ## This file is part of Octave.
66081694ffb8 [project @ 2007-11-29 23:14:07 by jwe]
jwe
parents:
diff changeset
5 ##
66081694ffb8 [project @ 2007-11-29 23:14:07 by jwe]
jwe
parents:
diff changeset
6 ## Octave is free software; you can redistribute it and/or modify it
66081694ffb8 [project @ 2007-11-29 23:14:07 by jwe]
jwe
parents:
diff changeset
7 ## under the terms of the GNU General Public License as published by
66081694ffb8 [project @ 2007-11-29 23:14:07 by jwe]
jwe
parents:
diff changeset
8 ## the Free Software Foundation; either version 3 of the License, or (at
66081694ffb8 [project @ 2007-11-29 23:14:07 by jwe]
jwe
parents:
diff changeset
9 ## your option) any later version.
66081694ffb8 [project @ 2007-11-29 23:14:07 by jwe]
jwe
parents:
diff changeset
10 ##
66081694ffb8 [project @ 2007-11-29 23:14:07 by jwe]
jwe
parents:
diff changeset
11 ## Octave is distributed in the hope that it will be useful, but
66081694ffb8 [project @ 2007-11-29 23:14:07 by jwe]
jwe
parents:
diff changeset
12 ## WITHOUT ANY WARRANTY; without even the implied warranty of
66081694ffb8 [project @ 2007-11-29 23:14:07 by jwe]
jwe
parents:
diff changeset
13 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
66081694ffb8 [project @ 2007-11-29 23:14:07 by jwe]
jwe
parents:
diff changeset
14 ## General Public License for more details.
66081694ffb8 [project @ 2007-11-29 23:14:07 by jwe]
jwe
parents:
diff changeset
15 ##
66081694ffb8 [project @ 2007-11-29 23:14:07 by jwe]
jwe
parents:
diff changeset
16 ## You should have received a copy of the GNU General Public License
66081694ffb8 [project @ 2007-11-29 23:14:07 by jwe]
jwe
parents:
diff changeset
17 ## along with Octave; see the file COPYING. If not, see
66081694ffb8 [project @ 2007-11-29 23:14:07 by jwe]
jwe
parents:
diff changeset
18 ## <http://www.gnu.org/licenses/>.
66081694ffb8 [project @ 2007-11-29 23:14:07 by jwe]
jwe
parents:
diff changeset
19
66081694ffb8 [project @ 2007-11-29 23:14:07 by jwe]
jwe
parents:
diff changeset
20 ## -*- texinfo -*-
10793
be55736a0783 Grammarcheck the documentation from m-files.
Rik <octave@nomad.inbox5.com>
parents: 10549
diff changeset
21 ## @deftypefn {Function File} {} pareto (@var{x})
7220
66081694ffb8 [project @ 2007-11-29 23:14:07 by jwe]
jwe
parents:
diff changeset
22 ## @deftypefnx {Function File} {} pareto (@var{x}, @var{y})
66081694ffb8 [project @ 2007-11-29 23:14:07 by jwe]
jwe
parents:
diff changeset
23 ## @deftypefnx {Function File} {} pareto (@var{h}, @dots{})
66081694ffb8 [project @ 2007-11-29 23:14:07 by jwe]
jwe
parents:
diff changeset
24 ## @deftypefnx {Function File} {@var{h} =} pareto (@dots{})
9040
dbd0c77e575e Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents: 8920
diff changeset
25 ## Draw a Pareto chart, also called ABC chart. A Pareto chart is a bar graph
7220
66081694ffb8 [project @ 2007-11-29 23:14:07 by jwe]
jwe
parents:
diff changeset
26 ## used to arrange information in such a way that priorities for process
9040
dbd0c77e575e Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents: 8920
diff changeset
27 ## improvement can be established. It organizes and displays information
dbd0c77e575e Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents: 8920
diff changeset
28 ## to show the relative importance of data. The chart is similar to the
7220
66081694ffb8 [project @ 2007-11-29 23:14:07 by jwe]
jwe
parents:
diff changeset
29 ## histogram or bar chart, except that the bars are arranged in decreasing
66081694ffb8 [project @ 2007-11-29 23:14:07 by jwe]
jwe
parents:
diff changeset
30 ## order from left to right along the abscissa.
66081694ffb8 [project @ 2007-11-29 23:14:07 by jwe]
jwe
parents:
diff changeset
31 ##
66081694ffb8 [project @ 2007-11-29 23:14:07 by jwe]
jwe
parents:
diff changeset
32 ## The fundamental idea (Pareto principle) behind the use of Pareto
66081694ffb8 [project @ 2007-11-29 23:14:07 by jwe]
jwe
parents:
diff changeset
33 ## diagrams is that the majority of an effect is due to a small subset of the
66081694ffb8 [project @ 2007-11-29 23:14:07 by jwe]
jwe
parents:
diff changeset
34 ## causes, so for quality improvement the first few (as presented on the
66081694ffb8 [project @ 2007-11-29 23:14:07 by jwe]
jwe
parents:
diff changeset
35 ## diagram) contributing causes to a problem usually account for the majority
9040
dbd0c77e575e Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents: 8920
diff changeset
36 ## of the result. Thus, targeting these "major causes" for elimination
7220
66081694ffb8 [project @ 2007-11-29 23:14:07 by jwe]
jwe
parents:
diff changeset
37 ## results in the most cost-effective improvement scheme.
66081694ffb8 [project @ 2007-11-29 23:14:07 by jwe]
jwe
parents:
diff changeset
38 ##
9040
dbd0c77e575e Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents: 8920
diff changeset
39 ## The data are passed as @var{x} and the abscissa as @var{y}. If @var{y} is
7220
66081694ffb8 [project @ 2007-11-29 23:14:07 by jwe]
jwe
parents:
diff changeset
40 ## absent, then the abscissa are assumed to be @code{1 : length (@var{x})}.
66081694ffb8 [project @ 2007-11-29 23:14:07 by jwe]
jwe
parents:
diff changeset
41 ## @var{y} can be a string array, a cell array of strings or a numerical
66081694ffb8 [project @ 2007-11-29 23:14:07 by jwe]
jwe
parents:
diff changeset
42 ## vector.
66081694ffb8 [project @ 2007-11-29 23:14:07 by jwe]
jwe
parents:
diff changeset
43 ##
66081694ffb8 [project @ 2007-11-29 23:14:07 by jwe]
jwe
parents:
diff changeset
44 ## An example of the use of @code{pareto} is
66081694ffb8 [project @ 2007-11-29 23:14:07 by jwe]
jwe
parents:
diff changeset
45 ##
66081694ffb8 [project @ 2007-11-29 23:14:07 by jwe]
jwe
parents:
diff changeset
46 ## @example
66081694ffb8 [project @ 2007-11-29 23:14:07 by jwe]
jwe
parents:
diff changeset
47 ## @group
9153
5247e89688e1 Eliminate most overfull errors when running texi2pdf for generating pdf documentation
Rik <rdrider0-list@yahoo.com>
parents: 9040
diff changeset
48 ## Cheese = @{"Cheddar", "Swiss", "Camembert", ...
5247e89688e1 Eliminate most overfull errors when running texi2pdf for generating pdf documentation
Rik <rdrider0-list@yahoo.com>
parents: 9040
diff changeset
49 ## "Munster", "Stilton", "Blue"@};
7220
66081694ffb8 [project @ 2007-11-29 23:14:07 by jwe]
jwe
parents:
diff changeset
50 ## Sold = [105, 30, 70, 10, 15, 20];
66081694ffb8 [project @ 2007-11-29 23:14:07 by jwe]
jwe
parents:
diff changeset
51 ## pareto(Sold, Cheese);
66081694ffb8 [project @ 2007-11-29 23:14:07 by jwe]
jwe
parents:
diff changeset
52 ## @end group
66081694ffb8 [project @ 2007-11-29 23:14:07 by jwe]
jwe
parents:
diff changeset
53 ## @end example
66081694ffb8 [project @ 2007-11-29 23:14:07 by jwe]
jwe
parents:
diff changeset
54 ## @end deftypefn
66081694ffb8 [project @ 2007-11-29 23:14:07 by jwe]
jwe
parents:
diff changeset
55
66081694ffb8 [project @ 2007-11-29 23:14:07 by jwe]
jwe
parents:
diff changeset
56 function h = pareto (varargin)
66081694ffb8 [project @ 2007-11-29 23:14:07 by jwe]
jwe
parents:
diff changeset
57
66081694ffb8 [project @ 2007-11-29 23:14:07 by jwe]
jwe
parents:
diff changeset
58 if (nargin != 1 && nargin != 2)
66081694ffb8 [project @ 2007-11-29 23:14:07 by jwe]
jwe
parents:
diff changeset
59 print_usage ();
66081694ffb8 [project @ 2007-11-29 23:14:07 by jwe]
jwe
parents:
diff changeset
60 endif
66081694ffb8 [project @ 2007-11-29 23:14:07 by jwe]
jwe
parents:
diff changeset
61
66081694ffb8 [project @ 2007-11-29 23:14:07 by jwe]
jwe
parents:
diff changeset
62 x = varargin {1}(:).';
66081694ffb8 [project @ 2007-11-29 23:14:07 by jwe]
jwe
parents:
diff changeset
63 if (nargin == 2)
66081694ffb8 [project @ 2007-11-29 23:14:07 by jwe]
jwe
parents:
diff changeset
64 y = varargin {2}(:).';
66081694ffb8 [project @ 2007-11-29 23:14:07 by jwe]
jwe
parents:
diff changeset
65 if (! iscell (y))
66081694ffb8 [project @ 2007-11-29 23:14:07 by jwe]
jwe
parents:
diff changeset
66 if (ischar (y))
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 9153
diff changeset
67 y = cellstr (y);
7220
66081694ffb8 [project @ 2007-11-29 23:14:07 by jwe]
jwe
parents:
diff changeset
68 else
11191
01ddaedd6ad5 Reverse changeset b1f4bdc276b6. Use all lower case for "uniformoutput" option.
Rik <octave@nomad.inbox5.com>
parents: 11188
diff changeset
69 y = cellfun (@num2str, num2cell (y), "uniformoutput", false);
7220
66081694ffb8 [project @ 2007-11-29 23:14:07 by jwe]
jwe
parents:
diff changeset
70 endif
66081694ffb8 [project @ 2007-11-29 23:14:07 by jwe]
jwe
parents:
diff changeset
71 endif
66081694ffb8 [project @ 2007-11-29 23:14:07 by jwe]
jwe
parents:
diff changeset
72 else
11188
4cb1522e4d0f Use function handle as input to cellfun,
Rik <octave@nomad.inbox5.com>
parents: 10793
diff changeset
73 y = cellfun (@int2str, num2cell (1 : numel(x)),
11191
01ddaedd6ad5 Reverse changeset b1f4bdc276b6. Use all lower case for "uniformoutput" option.
Rik <octave@nomad.inbox5.com>
parents: 11188
diff changeset
74 "uniformoutput", false);
7220
66081694ffb8 [project @ 2007-11-29 23:14:07 by jwe]
jwe
parents:
diff changeset
75 endif
66081694ffb8 [project @ 2007-11-29 23:14:07 by jwe]
jwe
parents:
diff changeset
76
66081694ffb8 [project @ 2007-11-29 23:14:07 by jwe]
jwe
parents:
diff changeset
77 [x, idx] = sort (x, "descend");
66081694ffb8 [project @ 2007-11-29 23:14:07 by jwe]
jwe
parents:
diff changeset
78 y = y (idx);
66081694ffb8 [project @ 2007-11-29 23:14:07 by jwe]
jwe
parents:
diff changeset
79 cdf = cumsum (x);
7221
2636c0846924 [project @ 2007-11-29 23:27:32 by dbateman]
dbateman
parents: 7220
diff changeset
80 maxcdf = max(cdf);
2636c0846924 [project @ 2007-11-29 23:27:32 by dbateman]
dbateman
parents: 7220
diff changeset
81 cdf = cdf ./ maxcdf;
7228
685c186d8f62 [project @ 2007-11-30 16:43:12 by jwe]
jwe
parents: 7221
diff changeset
82 cdf95 = cdf - 0.95;
685c186d8f62 [project @ 2007-11-30 16:43:12 by jwe]
jwe
parents: 7221
diff changeset
83 idx95 = find(sign(cdf95(1:end-1)) != sign(cdf95(2:end)))(1);
7220
66081694ffb8 [project @ 2007-11-29 23:14:07 by jwe]
jwe
parents:
diff changeset
84
8208
f6ca8ff51818 [mq]: graphics-backend
John W. Eaton <jwe@octave.org>
parents: 8102
diff changeset
85 [ax, hbar, hline] = plotyy (1 : idx95, x (1 : idx95),
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 9153
diff changeset
86 1 : length(cdf), 100 .* cdf,
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 9153
diff changeset
87 @bar, @plot);
7220
66081694ffb8 [project @ 2007-11-29 23:14:07 by jwe]
jwe
parents:
diff changeset
88
66081694ffb8 [project @ 2007-11-29 23:14:07 by jwe]
jwe
parents:
diff changeset
89 axis (ax(1), [1 - 0.6, idx95 + 0.6, 0, maxcdf]);
66081694ffb8 [project @ 2007-11-29 23:14:07 by jwe]
jwe
parents:
diff changeset
90 axis (ax(2), [1 - 0.6, idx95 + 0.6, 0, 100]);
66081694ffb8 [project @ 2007-11-29 23:14:07 by jwe]
jwe
parents:
diff changeset
91 set (ax(2), "ytick", [0, 20, 40, 60, 80, 100],
66081694ffb8 [project @ 2007-11-29 23:14:07 by jwe]
jwe
parents:
diff changeset
92 "yticklabel", {"0%", "20%", "40%", "60%", "80%", "100%"});
66081694ffb8 [project @ 2007-11-29 23:14:07 by jwe]
jwe
parents:
diff changeset
93 set (ax(1), "xtick", 1 : idx95, "xticklabel", y (1: idx95));
66081694ffb8 [project @ 2007-11-29 23:14:07 by jwe]
jwe
parents:
diff changeset
94 set (ax(2), "xtick", 1 : idx95, "xticklabel", y (1: idx95));
66081694ffb8 [project @ 2007-11-29 23:14:07 by jwe]
jwe
parents:
diff changeset
95
66081694ffb8 [project @ 2007-11-29 23:14:07 by jwe]
jwe
parents:
diff changeset
96 if (nargout > 0)
66081694ffb8 [project @ 2007-11-29 23:14:07 by jwe]
jwe
parents:
diff changeset
97 h = [hbar; hline];
66081694ffb8 [project @ 2007-11-29 23:14:07 by jwe]
jwe
parents:
diff changeset
98 endif
66081694ffb8 [project @ 2007-11-29 23:14:07 by jwe]
jwe
parents:
diff changeset
99
66081694ffb8 [project @ 2007-11-29 23:14:07 by jwe]
jwe
parents:
diff changeset
100 endfunction
66081694ffb8 [project @ 2007-11-29 23:14:07 by jwe]
jwe
parents:
diff changeset
101
66081694ffb8 [project @ 2007-11-29 23:14:07 by jwe]
jwe
parents:
diff changeset
102 %!demo
8790
a013ff655ca4 Trivial changes to demos to produce a more pleasant output for octave+gnuplot+aquaterm.
Ben Abbott <bpabbott@mac.com>
parents: 8208
diff changeset
103 %! clf
a013ff655ca4 Trivial changes to demos to produce a more pleasant output for octave+gnuplot+aquaterm.
Ben Abbott <bpabbott@mac.com>
parents: 8208
diff changeset
104 %! colormap (jet (64))
7220
66081694ffb8 [project @ 2007-11-29 23:14:07 by jwe]
jwe
parents:
diff changeset
105 %! Cheese = {"Cheddar", "Swiss", "Camembert", "Munster", "Stilton", "Blue"};
66081694ffb8 [project @ 2007-11-29 23:14:07 by jwe]
jwe
parents:
diff changeset
106 %! Sold = [105, 30, 70, 10, 15, 20];
66081694ffb8 [project @ 2007-11-29 23:14:07 by jwe]
jwe
parents:
diff changeset
107 %! pareto(Sold, Cheese);
66081694ffb8 [project @ 2007-11-29 23:14:07 by jwe]
jwe
parents:
diff changeset
108
66081694ffb8 [project @ 2007-11-29 23:14:07 by jwe]
jwe
parents:
diff changeset
109 %!demo
8790
a013ff655ca4 Trivial changes to demos to produce a more pleasant output for octave+gnuplot+aquaterm.
Ben Abbott <bpabbott@mac.com>
parents: 8208
diff changeset
110 %! clf
7220
66081694ffb8 [project @ 2007-11-29 23:14:07 by jwe]
jwe
parents:
diff changeset
111 %! % Suppose that we want establish which products makes 80 % of turnover.
66081694ffb8 [project @ 2007-11-29 23:14:07 by jwe]
jwe
parents:
diff changeset
112 %! Codes = {"AB4","BD7","CF8","CC5","AD11","BB5","BB3","AD8","DF3","DE7"};
66081694ffb8 [project @ 2007-11-29 23:14:07 by jwe]
jwe
parents:
diff changeset
113 %! Value = [2.35 7.9 2.45 1.1 0.15 13.45 5.4 2.05 0.85 1.65]';
66081694ffb8 [project @ 2007-11-29 23:14:07 by jwe]
jwe
parents:
diff changeset
114 %! SoldUnits = [54723 41114 16939 1576091 168000 687197 120222 168195, ...
66081694ffb8 [project @ 2007-11-29 23:14:07 by jwe]
jwe
parents:
diff changeset
115 %! 1084118 55576]';
66081694ffb8 [project @ 2007-11-29 23:14:07 by jwe]
jwe
parents:
diff changeset
116 %! pareto (Value.*SoldUnits, Codes);