Mercurial > hg > octave-nkf

annotate scripts/plot/draw/pareto.m @ 19840:c5270263d466 gui-release

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
close gui-release branch
author John W. Eaton <jwe@octave.org>
date Fri, 30 Jan 2015 17:41:50 -0500
parents 446c46af4b42
children 0e1f5a750d00
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
17744
d63878346099 maint: Update copyright notices for release.
John W. Eaton <jwe@octave.org>
parents: 17572
diff changeset
1 ## Copyright (C) 2007-2013 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 -*-
17122
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 16814
diff changeset
21 ## @deftypefn {Function File} {} pareto (@var{y})
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 16814
diff changeset
22 ## @deftypefnx {Function File} {} pareto (@var{y}, @var{x})
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 16814
diff changeset
23 ## @deftypefnx {Function File} {} pareto (@var{hax}, @dots{})
7220
66081694ffb8 [project @ 2007-11-29 23:14:07 by jwe]
jwe
parents:
diff changeset
24 ## @deftypefnx {Function File} {@var{h} =} pareto (@dots{})
17122
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 16814
diff changeset
25 ## Draw a Pareto chart.
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 16814
diff changeset
26 ##
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 16814
diff changeset
27 ## A Pareto chart is a bar graph that arranges information in such a way
17281
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17160
diff changeset
28 ## that priorities for process improvement can be established; It organizes
17122
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 16814
diff changeset
29 ## and displays information to show the relative importance of data. The chart
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 16814
diff changeset
30 ## is similar to the histogram or bar chart, except that the bars are arranged
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 16814
diff changeset
31 ## in decreasing magnitude from left to right along the x-axis.
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
32 ##
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
33 ## The fundamental idea (Pareto principle) behind the use of Pareto
7220
66081694ffb8 [project @ 2007-11-29 23:14:07 by jwe]
jwe
parents:
diff changeset
34 ## diagrams is that the majority of an effect is due to a small subset of the
19790
446c46af4b42 strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 17744
diff changeset
35 ## causes. For quality improvement, the first few contributing causes
17122
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 16814
diff changeset
36 ## (leftmost bars as presented on the diagram) to a problem usually account for
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 16814
diff changeset
37 ## the majority of the result. Thus, targeting these "major causes" for
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 16814
diff changeset
38 ## elimination results in the most cost-effective improvement scheme.
7220
66081694ffb8 [project @ 2007-11-29 23:14:07 by jwe]
jwe
parents:
diff changeset
39 ##
17122
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 16814
diff changeset
40 ## Typically only the magnitude data @var{y} is present in which case
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 16814
diff changeset
41 ## @var{x} is taken to be the range @code{1 : length (@var{y})}. If @var{x}
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 16814
diff changeset
42 ## is given it may be a string array, a cell array of strings, or a numerical
7220
66081694ffb8 [project @ 2007-11-29 23:14:07 by jwe]
jwe
parents:
diff changeset
43 ## vector.
66081694ffb8 [project @ 2007-11-29 23:14:07 by jwe]
jwe
parents:
diff changeset
44 ##
17122
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 16814
diff changeset
45 ## If the first argument @var{hax} is an axes handle, then plot into this axis,
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 16814
diff changeset
46 ## rather than the current axes returned by @code{gca}.
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 16814
diff changeset
47 ##
14001
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents: 12931
diff changeset
48 ## The optional return value @var{h} is a 2-element vector with a graphics
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents: 12931
diff changeset
49 ## handle for the created bar plot and a second handle for the created line
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents: 12931
diff changeset
50 ## plot.
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents: 12931
diff changeset
51 ##
7220
66081694ffb8 [project @ 2007-11-29 23:14:07 by jwe]
jwe
parents:
diff changeset
52 ## An example of the use of @code{pareto} is
66081694ffb8 [project @ 2007-11-29 23:14:07 by jwe]
jwe
parents:
diff changeset
53 ##
66081694ffb8 [project @ 2007-11-29 23:14:07 by jwe]
jwe
parents:
diff changeset
54 ## @example
66081694ffb8 [project @ 2007-11-29 23:14:07 by jwe]
jwe
parents:
diff changeset
55 ## @group
9153
5247e89688e1 Eliminate most overfull errors when running texi2pdf for generating pdf documentation
Rik <rdrider0-list@yahoo.com>
parents: 9040
diff changeset
56 ## 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
57 ## "Munster", "Stilton", "Blue"@};
7220
66081694ffb8 [project @ 2007-11-29 23:14:07 by jwe]
jwe
parents:
diff changeset
58 ## Sold = [105, 30, 70, 10, 15, 20];
14001
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents: 12931
diff changeset
59 ## pareto (Sold, Cheese);
7220
66081694ffb8 [project @ 2007-11-29 23:14:07 by jwe]
jwe
parents:
diff changeset
60 ## @end group
66081694ffb8 [project @ 2007-11-29 23:14:07 by jwe]
jwe
parents:
diff changeset
61 ## @end example
17122
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 16814
diff changeset
62 ## @seealso{bar, barh, hist, pie, plot}
7220
66081694ffb8 [project @ 2007-11-29 23:14:07 by jwe]
jwe
parents:
diff changeset
63 ## @end deftypefn
66081694ffb8 [project @ 2007-11-29 23:14:07 by jwe]
jwe
parents:
diff changeset
64
66081694ffb8 [project @ 2007-11-29 23:14:07 by jwe]
jwe
parents:
diff changeset
65 function h = pareto (varargin)
66081694ffb8 [project @ 2007-11-29 23:14:07 by jwe]
jwe
parents:
diff changeset
66
17160
6e8c621c3496 pareto.m: Accept an axis handle as first input.
Rik <rik@octave.org>
parents: 17122
diff changeset
67 [hax, varargin, nargin] = __plt_get_axis_arg__ ("pareto", varargin{:});
6e8c621c3496 pareto.m: Accept an axis handle as first input.
Rik <rik@octave.org>
parents: 17122
diff changeset
68
7220
66081694ffb8 [project @ 2007-11-29 23:14:07 by jwe]
jwe
parents:
diff changeset
69 if (nargin != 1 && nargin != 2)
66081694ffb8 [project @ 2007-11-29 23:14:07 by jwe]
jwe
parents:
diff changeset
70 print_usage ();
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
17523
968c99137122 pareto.m: Include 95% of CDF for Matlab compatibility.
Rik <rik@octave.org>
parents: 17386
diff changeset
73 y = varargin{1}(:).';
7220
66081694ffb8 [project @ 2007-11-29 23:14:07 by jwe]
jwe
parents:
diff changeset
74 if (nargin == 2)
17523
968c99137122 pareto.m: Include 95% of CDF for Matlab compatibility.
Rik <rik@octave.org>
parents: 17386
diff changeset
75 x = varargin{2}(:).';
968c99137122 pareto.m: Include 95% of CDF for Matlab compatibility.
Rik <rik@octave.org>
parents: 17386
diff changeset
76 if (! iscell (x))
968c99137122 pareto.m: Include 95% of CDF for Matlab compatibility.
Rik <rik@octave.org>
parents: 17386
diff changeset
77 if (ischar (x))
968c99137122 pareto.m: Include 95% of CDF for Matlab compatibility.
Rik <rik@octave.org>
parents: 17386
diff changeset
78 x = cellstr (x);
7220
66081694ffb8 [project @ 2007-11-29 23:14:07 by jwe]
jwe
parents:
diff changeset
79 else
17523
968c99137122 pareto.m: Include 95% of CDF for Matlab compatibility.
Rik <rik@octave.org>
parents: 17386
diff changeset
80 x = cellstr (num2str (x(:)));
7220
66081694ffb8 [project @ 2007-11-29 23:14:07 by jwe]
jwe
parents:
diff changeset
81 endif
66081694ffb8 [project @ 2007-11-29 23:14:07 by jwe]
jwe
parents:
diff changeset
82 endif
66081694ffb8 [project @ 2007-11-29 23:14:07 by jwe]
jwe
parents:
diff changeset
83 else
17523
968c99137122 pareto.m: Include 95% of CDF for Matlab compatibility.
Rik <rik@octave.org>
parents: 17386
diff changeset
84 x = cellstr (int2str ([1:numel(y)]'));
7220
66081694ffb8 [project @ 2007-11-29 23:14:07 by jwe]
jwe
parents:
diff changeset
85 endif
66081694ffb8 [project @ 2007-11-29 23:14:07 by jwe]
jwe
parents:
diff changeset
86
17523
968c99137122 pareto.m: Include 95% of CDF for Matlab compatibility.
Rik <rik@octave.org>
parents: 17386
diff changeset
87 [y, idx] = sort (y, "descend");
968c99137122 pareto.m: Include 95% of CDF for Matlab compatibility.
Rik <rik@octave.org>
parents: 17386
diff changeset
88 x = x(idx);
968c99137122 pareto.m: Include 95% of CDF for Matlab compatibility.
Rik <rik@octave.org>
parents: 17386
diff changeset
89 cdf = cumsum (y);
968c99137122 pareto.m: Include 95% of CDF for Matlab compatibility.
Rik <rik@octave.org>
parents: 17386
diff changeset
90 maxcdf = cdf(end);
968c99137122 pareto.m: Include 95% of CDF for Matlab compatibility.
Rik <rik@octave.org>
parents: 17386
diff changeset
91 cdf ./= maxcdf;
968c99137122 pareto.m: Include 95% of CDF for Matlab compatibility.
Rik <rik@octave.org>
parents: 17386
diff changeset
92 idx95 = find (cdf < 0.95, 1, "last") + 1;
7220
66081694ffb8 [project @ 2007-11-29 23:14:07 by jwe]
jwe
parents:
diff changeset
93
17160
6e8c621c3496 pareto.m: Accept an axis handle as first input.
Rik <rik@octave.org>
parents: 17122
diff changeset
94 if (isempty (hax))
17523
968c99137122 pareto.m: Include 95% of CDF for Matlab compatibility.
Rik <rik@octave.org>
parents: 17386
diff changeset
95 [ax, hbar, hline] = plotyy (1 : idx95, y(1:idx95),
968c99137122 pareto.m: Include 95% of CDF for Matlab compatibility.
Rik <rik@octave.org>
parents: 17386
diff changeset
96 1 : length (cdf), 100 * cdf,
17160
6e8c621c3496 pareto.m: Accept an axis handle as first input.
Rik <rik@octave.org>
parents: 17122
diff changeset
97 @bar, @plot);
6e8c621c3496 pareto.m: Accept an axis handle as first input.
Rik <rik@octave.org>
parents: 17122
diff changeset
98 else
17523
968c99137122 pareto.m: Include 95% of CDF for Matlab compatibility.
Rik <rik@octave.org>
parents: 17386
diff changeset
99 [ax, hbar, hline] = plotyy (hax, 1 : idx95, y(1:idx95),
968c99137122 pareto.m: Include 95% of CDF for Matlab compatibility.
Rik <rik@octave.org>
parents: 17386
diff changeset
100 1 : length (cdf), 100 * cdf,
17160
6e8c621c3496 pareto.m: Accept an axis handle as first input.
Rik <rik@octave.org>
parents: 17122
diff changeset
101 @bar, @plot);
6e8c621c3496 pareto.m: Accept an axis handle as first input.
Rik <rik@octave.org>
parents: 17122
diff changeset
102 endif
7220
66081694ffb8 [project @ 2007-11-29 23:14:07 by jwe]
jwe
parents:
diff changeset
103
66081694ffb8 [project @ 2007-11-29 23:14:07 by jwe]
jwe
parents:
diff changeset
104 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
105 axis (ax(2), [1 - 0.6, idx95 + 0.6, 0, 100]);
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
106 set (ax(2), "ytick", [0, 20, 40, 60, 80, 100],
17160
6e8c621c3496 pareto.m: Accept an axis handle as first input.
Rik <rik@octave.org>
parents: 17122
diff changeset
107 "yticklabel", {"0%", "20%", "40%", "60%", "80%", "100%"});
17523
968c99137122 pareto.m: Include 95% of CDF for Matlab compatibility.
Rik <rik@octave.org>
parents: 17386
diff changeset
108 set (ax(1:2), "xtick", 1:idx95, "xticklabel", x(1:idx95));
7220
66081694ffb8 [project @ 2007-11-29 23:14:07 by jwe]
jwe
parents:
diff changeset
109
66081694ffb8 [project @ 2007-11-29 23:14:07 by jwe]
jwe
parents:
diff changeset
110 if (nargout > 0)
66081694ffb8 [project @ 2007-11-29 23:14:07 by jwe]
jwe
parents:
diff changeset
111 h = [hbar; hline];
66081694ffb8 [project @ 2007-11-29 23:14:07 by jwe]
jwe
parents:
diff changeset
112 endif
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
113
7220
66081694ffb8 [project @ 2007-11-29 23:14:07 by jwe]
jwe
parents:
diff changeset
114 endfunction
66081694ffb8 [project @ 2007-11-29 23:14:07 by jwe]
jwe
parents:
diff changeset
115
14001
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents: 12931
diff changeset
116
7220
66081694ffb8 [project @ 2007-11-29 23:14:07 by jwe]
jwe
parents:
diff changeset
117 %!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
118 %! clf;
14001
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents: 12931
diff changeset
119 %! colormap (jet (64));
14245
4506eade9f04 Use Matlab coding conventions for demos in plot/ directory.
Rik <octave@nomad.inbox5.com>
parents: 14237
diff changeset
120 %! Cheese = {'Cheddar', 'Swiss', 'Camembert', 'Munster', 'Stilton', 'Blue'};
7220
66081694ffb8 [project @ 2007-11-29 23:14:07 by jwe]
jwe
parents:
diff changeset
121 %! Sold = [105, 30, 70, 10, 15, 20];
14001
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents: 12931
diff changeset
122 %! pareto (Sold, Cheese);
7220
66081694ffb8 [project @ 2007-11-29 23:14:07 by jwe]
jwe
parents:
diff changeset
123
66081694ffb8 [project @ 2007-11-29 23:14:07 by jwe]
jwe
parents:
diff changeset
124 %!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
125 %! clf;
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
126 %! % Suppose that we want establish which products makes 80% of turnover.
14245
4506eade9f04 Use Matlab coding conventions for demos in plot/ directory.
Rik <octave@nomad.inbox5.com>
parents: 14237
diff changeset
127 %! Codes = {'AB4','BD7','CF8','CC5','AD11','BB5','BB3','AD8','DF3','DE7'};
7220
66081694ffb8 [project @ 2007-11-29 23:14:07 by jwe]
jwe
parents:
diff changeset
128 %! 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
129 %! SoldUnits = [54723 41114 16939 1576091 168000 687197 120222 168195, ...
66081694ffb8 [project @ 2007-11-29 23:14:07 by jwe]
jwe
parents:
diff changeset
130 %! 1084118 55576]';
66081694ffb8 [project @ 2007-11-29 23:14:07 by jwe]
jwe
parents:
diff changeset
131 %! pareto (Value.*SoldUnits, Codes);
14001
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents: 12931
diff changeset
132