|
7017
|
1 ## Copyright (C) 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2002, 2003, |
|
|
2 ## 2004, 2005, 2006, 2007 John W. Eaton |
|
2313
|
3 ## |
|
|
4 ## This file is part of Octave. |
|
|
5 ## |
|
|
6 ## Octave is free software; you can redistribute it and/or modify it |
|
|
7 ## under the terms of the GNU General Public License as published by |
|
7016
|
8 ## the Free Software Foundation; either version 3 of the License, or (at |
|
|
9 ## your option) any later version. |
|
2313
|
10 ## |
|
|
11 ## Octave is distributed in the hope that it will be useful, but |
|
|
12 ## WITHOUT ANY WARRANTY; without even the implied warranty of |
|
|
13 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
|
|
14 ## General Public License for more details. |
|
|
15 ## |
|
|
16 ## You should have received a copy of the GNU General Public License |
|
7016
|
17 ## along with Octave; see the file COPYING. If not, see |
|
|
18 ## <http://www.gnu.org/licenses/>. |
|
724
|
19 |
|
3368
|
20 ## -*- texinfo -*- |
|
3597
|
21 ## @deftypefn {Function File} {} hist (@var{y}, @var{x}, @var{norm}) |
|
2311
|
22 ## Produce histogram counts or plots. |
|
3426
|
23 ## |
|
2311
|
24 ## With one vector input argument, plot a histogram of the values with |
|
|
25 ## 10 bins. The range of the histogram bins is determined by the range |
|
|
26 ## of the data. |
|
3426
|
27 ## |
|
2311
|
28 ## Given a second scalar argument, use that as the number of bins. |
|
3426
|
29 ## |
|
2311
|
30 ## Given a second vector argument, use that as the centers of the bins, |
|
3368
|
31 ## with the width of the bins determined from the adjacent values in |
|
2311
|
32 ## the vector. |
|
3426
|
33 ## |
|
3597
|
34 ## If third argument is provided, the histogram is normalised such that |
|
|
35 ## the sum of the bars is equal to @var{norm}. |
|
|
36 ## |
|
2311
|
37 ## Extreme values are lumped in the first and last bins. |
|
3426
|
38 ## |
|
3368
|
39 ## With two output arguments, produce the values @var{nn} and @var{xx} such |
|
|
40 ## that @code{bar (@var{xx}, @var{nn})} will plot the histogram. |
|
5642
|
41 ## @seealso{bar} |
|
3368
|
42 ## @end deftypefn |
|
724
|
43 |
|
2314
|
44 ## Author: jwe |
|
|
45 |
|
7112
|
46 function [nn, xx] = hist (y, varargin) |
|
724
|
47 |
|
7112
|
48 if (nargin < 1) |
|
6046
|
49 print_usage (); |
|
724
|
50 endif |
|
2325
|
51 |
|
5443
|
52 arg_is_vector = isvector (y); |
|
5065
|
53 |
|
|
54 if (rows (y) == 1) |
|
4880
|
55 y = y(:); |
|
|
56 endif |
|
|
57 |
|
|
58 if (isreal (y)) |
|
7112
|
59 max_val = max (y(:)); |
|
|
60 min_val = min (y(:)); |
|
724
|
61 else |
|
|
62 error ("hist: first argument must be a vector"); |
|
|
63 endif |
|
|
64 |
|
7112
|
65 iarg = 1; |
|
|
66 if (nargin == 1 || ischar (varargin{iarg})) |
|
724
|
67 n = 10; |
|
4880
|
68 x = [0.5:n]'/n; |
|
|
69 x = x * (max_val - min_val) + ones(size(x)) * min_val; |
|
3597
|
70 else |
|
|
71 ## nargin is either 2 or 3 |
|
7112
|
72 x = varargin {iarg++}; |
|
4030
|
73 if (isscalar (x)) |
|
724
|
74 n = x; |
|
|
75 if (n <= 0) |
|
|
76 error ("hist: number of bins must be positive"); |
|
|
77 endif |
|
4880
|
78 x = [0.5:n]'/n; |
|
|
79 x = x * (max_val - min_val) + ones(size(x)) * min_val; |
|
|
80 elseif (isreal (x)) |
|
|
81 if (isvector (x)) |
|
|
82 x = x(:); |
|
|
83 endif |
|
724
|
84 tmp = sort (x); |
|
|
85 if (any (tmp != x)) |
|
904
|
86 warning ("hist: bin values not sorted on input"); |
|
724
|
87 x = tmp; |
|
|
88 endif |
|
|
89 else |
|
|
90 error ("hist: second argument must be a scalar or a vector"); |
|
|
91 endif |
|
|
92 endif |
|
|
93 |
|
4880
|
94 cutoff = (x(1:end-1,:) + x(2:end,:)) / 2; |
|
|
95 n = rows (x); |
|
|
96 if (n < 30 && columns (x) == 1) |
|
4407
|
97 ## The following algorithm works fastest for n less than about 30. |
|
4880
|
98 chist = zeros (n+1, columns (y)); |
|
4407
|
99 for i = 1:n-1 |
|
4880
|
100 chist(i+1,:) = sum (y <= cutoff(i)); |
|
4407
|
101 endfor |
|
5746
|
102 chist(n+1,:) = sum (! isnan (y)); |
|
4407
|
103 else |
|
|
104 ## The following algorithm works fastest for n greater than about 30. |
|
|
105 ## Put cutoff elements between boundaries, integrate over all |
|
|
106 ## elements, keep totals at boundaries. |
|
4880
|
107 [s, idx] = sort ([y; cutoff]); |
|
|
108 len = rows (y); |
|
|
109 chist = cumsum (idx <= len); |
|
|
110 t1 = zeros (1, columns (y)); |
|
|
111 t2 = reshape (chist(idx > len), size (cutoff)); |
|
5746
|
112 t3 = chist(end,:) - sum (isnan (y)); |
|
4880
|
113 chist = [t1; t2; t3]; |
|
4407
|
114 endif |
|
|
115 |
|
4880
|
116 freq = diff (chist); |
|
724
|
117 |
|
7112
|
118 if (nargin > 2 && !ischar (varargin{iarg})) |
|
3597
|
119 ## Normalise the histogram. |
|
7112
|
120 norm = varargin{iarg++}; |
|
4880
|
121 freq = freq / rows (y) * norm; |
|
3597
|
122 endif |
|
|
123 |
|
6586
|
124 if (nargout > 0) |
|
5065
|
125 if (arg_is_vector) |
|
4880
|
126 nn = freq'; |
|
|
127 xx = x'; |
|
|
128 else |
|
|
129 nn = freq; |
|
|
130 xx = x; |
|
|
131 endif |
|
7112
|
132 elseif (size (freq, 2) != 1) |
|
|
133 bar (x, freq, 0.8, varargin{iarg:end}); |
|
736
|
134 else |
|
7112
|
135 bar (x, freq, 1.0, varargin{iarg:end}); |
|
724
|
136 endif |
|
|
137 |
|
|
138 endfunction |
|
4811
|
139 |
|
|
140 %!test |
|
4880
|
141 %! [nn,xx]=hist([1:4],3); |
|
|
142 %! assert(xx, [1.5,2.5,3.5]); |
|
|
143 %! assert(nn, [2,1,1]); |
|
|
144 %!test |
|
|
145 %! [nn,xx]=hist([1:4]',3); |
|
5584
|
146 %! assert(xx, [1.5,2.5,3.5]); |
|
|
147 %! assert(nn, [2,1,1]); |
|
4880
|
148 %!test |
|
5746
|
149 %! [nn,xx]=hist([1 1 1 NaN NaN NaN 2 2 3],[1 2 3]); |
|
|
150 %! assert(xx, [1,2,3]); |
|
|
151 %! assert(nn, [3,2,1]); |
|
|
152 %!test |
|
4880
|
153 %! [nn,xx]=hist([[1:4]',[1:4]'],3); |
|
7112
|
154 %! assert(xx, [1.5;2.5;3.5]); |
|
4880
|
155 %! assert(nn, [[2,1,1]',[2,1,1]']); |
|
|
156 %!assert(hist(1,1),1); |
|
|
157 %!test |
|
|
158 %! for n = [10, 30, 100, 1000] |
|
|
159 %! assert( sum(hist([1:n], n)), n ); |
|
|
160 %! assert( sum(hist([1:n], [2:n-1])), n); |
|
|
161 %! assert( sum(hist([1:n], [1:n])), n ); |
|
|
162 %! assert( sum(hist([1:n], 29)), n); |
|
|
163 %! assert( sum(hist([1:n], 30)), n); |
|
4811
|
164 %! endfor |
