annotate scripts/plot/hist.m @ 3407:5e0a0b1cba43

[project @ 2000-01-06 03:13:55 by jwe]
author jwe
date Thu, 06 Jan 2000 03:14:17 +0000
parents a4cd1e9d9962
children f8dde1807dee
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2847
8b262e771614 [project @ 1997-03-27 16:18:26 by jwe]
jwe
parents: 2325
diff changeset
1 ## Copyright (C) 1996, 1997 John W. Eaton
2313
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
2 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
3 ## This file is part of Octave.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
4 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
6 ## under the terms of the GNU General Public License as published by
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
7 ## the Free Software Foundation; either version 2, or (at your option)
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
8 ## any later version.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
9 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
13 ## General Public License for more details.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
14 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
15 ## You should have received a copy of the GNU General Public License
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
16 ## along with Octave; see the file COPYING. If not, write to the Free
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
17 ## Software Foundation, 59 Temple Place - Suite 330, Boston, MA
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
18 ## 02111-1307, USA.
724
86d73993eee2 [project @ 1994-09-21 19:42:34 by jwe]
jwe
parents:
diff changeset
19
3368
a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe]
jwe
parents: 3175
diff changeset
20 ## -*- texinfo -*-
a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe]
jwe
parents: 3175
diff changeset
21 ## @deftypefn {Function File} {} hist (@var{y}, @var{x})
2311
2b5788792cad [project @ 1996-07-11 20:18:38 by jwe]
jwe
parents: 2303
diff changeset
22 ## Produce histogram counts or plots.
3368
a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe]
jwe
parents: 3175
diff changeset
23 ##
2311
2b5788792cad [project @ 1996-07-11 20:18:38 by jwe]
jwe
parents: 2303
diff changeset
24 ## With one vector input argument, plot a histogram of the values with
2b5788792cad [project @ 1996-07-11 20:18:38 by jwe]
jwe
parents: 2303
diff changeset
25 ## 10 bins. The range of the histogram bins is determined by the range
2b5788792cad [project @ 1996-07-11 20:18:38 by jwe]
jwe
parents: 2303
diff changeset
26 ## of the data.
3368
a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe]
jwe
parents: 3175
diff changeset
27 ##
2311
2b5788792cad [project @ 1996-07-11 20:18:38 by jwe]
jwe
parents: 2303
diff changeset
28 ## Given a second scalar argument, use that as the number of bins.
3368
a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe]
jwe
parents: 3175
diff changeset
29 ##
2311
2b5788792cad [project @ 1996-07-11 20:18:38 by jwe]
jwe
parents: 2303
diff changeset
30 ## Given a second vector argument, use that as the centers of the bins,
3368
a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe]
jwe
parents: 3175
diff changeset
31 ## with the width of the bins determined from the adjacent values in
2311
2b5788792cad [project @ 1996-07-11 20:18:38 by jwe]
jwe
parents: 2303
diff changeset
32 ## the vector.
3368
a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe]
jwe
parents: 3175
diff changeset
33 ##
2311
2b5788792cad [project @ 1996-07-11 20:18:38 by jwe]
jwe
parents: 2303
diff changeset
34 ## Extreme values are lumped in the first and last bins.
3368
a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe]
jwe
parents: 3175
diff changeset
35 ##
a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe]
jwe
parents: 3175
diff changeset
36 ## With two output arguments, produce the values @var{nn} and @var{xx} such
a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe]
jwe
parents: 3175
diff changeset
37 ## that @code{bar (@var{xx}, @var{nn})} will plot the histogram.
a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe]
jwe
parents: 3175
diff changeset
38 ## @end deftypefn
3407
5e0a0b1cba43 [project @ 2000-01-06 03:13:55 by jwe]
jwe
parents: 3368
diff changeset
39 ## @seealso{bar}
724
86d73993eee2 [project @ 1994-09-21 19:42:34 by jwe]
jwe
parents:
diff changeset
40
2314
949ab8eba8bc [project @ 1996-07-12 03:58:02 by jwe]
jwe
parents: 2313
diff changeset
41 ## Author: jwe
949ab8eba8bc [project @ 1996-07-12 03:58:02 by jwe]
jwe
parents: 2313
diff changeset
42
2311
2b5788792cad [project @ 1996-07-11 20:18:38 by jwe]
jwe
parents: 2303
diff changeset
43 function [nn, xx] = hist (y, x)
724
86d73993eee2 [project @ 1994-09-21 19:42:34 by jwe]
jwe
parents:
diff changeset
44
86d73993eee2 [project @ 1994-09-21 19:42:34 by jwe]
jwe
parents:
diff changeset
45 if (nargin < 1 || nargin > 2)
904
3470f1e25a79 [project @ 1994-11-09 21:22:15 by jwe]
jwe
parents: 736
diff changeset
46 usage ("[nn, xx] = hist (y, x)");
724
86d73993eee2 [project @ 1994-09-21 19:42:34 by jwe]
jwe
parents:
diff changeset
47 endif
2325
b5568c31ee2c [project @ 1996-07-15 22:20:21 by jwe]
jwe
parents: 2314
diff changeset
48
724
86d73993eee2 [project @ 1994-09-21 19:42:34 by jwe]
jwe
parents:
diff changeset
49 if (is_vector (y))
86d73993eee2 [project @ 1994-09-21 19:42:34 by jwe]
jwe
parents:
diff changeset
50 max_val = max (y);
86d73993eee2 [project @ 1994-09-21 19:42:34 by jwe]
jwe
parents:
diff changeset
51 min_val = min (y);
86d73993eee2 [project @ 1994-09-21 19:42:34 by jwe]
jwe
parents:
diff changeset
52 else
86d73993eee2 [project @ 1994-09-21 19:42:34 by jwe]
jwe
parents:
diff changeset
53 error ("hist: first argument must be a vector");
86d73993eee2 [project @ 1994-09-21 19:42:34 by jwe]
jwe
parents:
diff changeset
54 endif
86d73993eee2 [project @ 1994-09-21 19:42:34 by jwe]
jwe
parents:
diff changeset
55
86d73993eee2 [project @ 1994-09-21 19:42:34 by jwe]
jwe
parents:
diff changeset
56 if (nargin == 1)
86d73993eee2 [project @ 1994-09-21 19:42:34 by jwe]
jwe
parents:
diff changeset
57 n = 10;
86d73993eee2 [project @ 1994-09-21 19:42:34 by jwe]
jwe
parents:
diff changeset
58 delta = (max_val - min_val) / n / 2;
86d73993eee2 [project @ 1994-09-21 19:42:34 by jwe]
jwe
parents:
diff changeset
59 x = linspace (min_val+delta, max_val-delta, n);
86d73993eee2 [project @ 1994-09-21 19:42:34 by jwe]
jwe
parents:
diff changeset
60 cutoff = x + delta;
86d73993eee2 [project @ 1994-09-21 19:42:34 by jwe]
jwe
parents:
diff changeset
61 elseif (nargin == 2)
86d73993eee2 [project @ 1994-09-21 19:42:34 by jwe]
jwe
parents:
diff changeset
62 if (is_scalar (x))
86d73993eee2 [project @ 1994-09-21 19:42:34 by jwe]
jwe
parents:
diff changeset
63 n = x;
86d73993eee2 [project @ 1994-09-21 19:42:34 by jwe]
jwe
parents:
diff changeset
64 if (n <= 0)
86d73993eee2 [project @ 1994-09-21 19:42:34 by jwe]
jwe
parents:
diff changeset
65 error ("hist: number of bins must be positive");
86d73993eee2 [project @ 1994-09-21 19:42:34 by jwe]
jwe
parents:
diff changeset
66 endif
86d73993eee2 [project @ 1994-09-21 19:42:34 by jwe]
jwe
parents:
diff changeset
67 delta = (max_val - min_val) / n / 2;
86d73993eee2 [project @ 1994-09-21 19:42:34 by jwe]
jwe
parents:
diff changeset
68 x = linspace (min_val+delta, max_val-delta, n);
86d73993eee2 [project @ 1994-09-21 19:42:34 by jwe]
jwe
parents:
diff changeset
69 cutoff = x + delta;
86d73993eee2 [project @ 1994-09-21 19:42:34 by jwe]
jwe
parents:
diff changeset
70 elseif (is_vector (x))
86d73993eee2 [project @ 1994-09-21 19:42:34 by jwe]
jwe
parents:
diff changeset
71 tmp = sort (x);
86d73993eee2 [project @ 1994-09-21 19:42:34 by jwe]
jwe
parents:
diff changeset
72 if (any (tmp != x))
904
3470f1e25a79 [project @ 1994-11-09 21:22:15 by jwe]
jwe
parents: 736
diff changeset
73 warning ("hist: bin values not sorted on input");
724
86d73993eee2 [project @ 1994-09-21 19:42:34 by jwe]
jwe
parents:
diff changeset
74 x = tmp;
86d73993eee2 [project @ 1994-09-21 19:42:34 by jwe]
jwe
parents:
diff changeset
75 endif
86d73993eee2 [project @ 1994-09-21 19:42:34 by jwe]
jwe
parents:
diff changeset
76 n = length (x);
86d73993eee2 [project @ 1994-09-21 19:42:34 by jwe]
jwe
parents:
diff changeset
77 cutoff = zeros (1, n-1);
86d73993eee2 [project @ 1994-09-21 19:42:34 by jwe]
jwe
parents:
diff changeset
78 for i = 1:n-1
86d73993eee2 [project @ 1994-09-21 19:42:34 by jwe]
jwe
parents:
diff changeset
79 cutoff (i) = (x (i) + x (i+1)) / 2;
86d73993eee2 [project @ 1994-09-21 19:42:34 by jwe]
jwe
parents:
diff changeset
80 endfor
86d73993eee2 [project @ 1994-09-21 19:42:34 by jwe]
jwe
parents:
diff changeset
81 else
86d73993eee2 [project @ 1994-09-21 19:42:34 by jwe]
jwe
parents:
diff changeset
82 error ("hist: second argument must be a scalar or a vector");
86d73993eee2 [project @ 1994-09-21 19:42:34 by jwe]
jwe
parents:
diff changeset
83 endif
86d73993eee2 [project @ 1994-09-21 19:42:34 by jwe]
jwe
parents:
diff changeset
84 endif
86d73993eee2 [project @ 1994-09-21 19:42:34 by jwe]
jwe
parents:
diff changeset
85
86d73993eee2 [project @ 1994-09-21 19:42:34 by jwe]
jwe
parents:
diff changeset
86 freq = zeros (1, n);
86d73993eee2 [project @ 1994-09-21 19:42:34 by jwe]
jwe
parents:
diff changeset
87 freq (1) = sum (y < cutoff (1));
86d73993eee2 [project @ 1994-09-21 19:42:34 by jwe]
jwe
parents:
diff changeset
88 for i = 2:n-1
86d73993eee2 [project @ 1994-09-21 19:42:34 by jwe]
jwe
parents:
diff changeset
89 freq (i) = sum (y >= cutoff (i-1) & y < cutoff (i));
86d73993eee2 [project @ 1994-09-21 19:42:34 by jwe]
jwe
parents:
diff changeset
90 endfor
86d73993eee2 [project @ 1994-09-21 19:42:34 by jwe]
jwe
parents:
diff changeset
91 freq (n) = sum (y >= cutoff (n-1));
86d73993eee2 [project @ 1994-09-21 19:42:34 by jwe]
jwe
parents:
diff changeset
92
3175
096940972434 [project @ 1998-05-18 17:03:01 by jwe]
jwe
parents: 2847
diff changeset
93 if (nargout > 0)
736
c8f88bd3202b [project @ 1994-09-24 03:28:05 by jwe]
jwe
parents: 724
diff changeset
94 nn = freq;
c8f88bd3202b [project @ 1994-09-24 03:28:05 by jwe]
jwe
parents: 724
diff changeset
95 xx = x;
c8f88bd3202b [project @ 1994-09-24 03:28:05 by jwe]
jwe
parents: 724
diff changeset
96 else
c8f88bd3202b [project @ 1994-09-24 03:28:05 by jwe]
jwe
parents: 724
diff changeset
97 bar (x, freq);
724
86d73993eee2 [project @ 1994-09-21 19:42:34 by jwe]
jwe
parents:
diff changeset
98 endif
86d73993eee2 [project @ 1994-09-21 19:42:34 by jwe]
jwe
parents:
diff changeset
99
86d73993eee2 [project @ 1994-09-21 19:42:34 by jwe]
jwe
parents:
diff changeset
100 endfunction