octave-lyh: scripts/plot/hist.m annotate

annotate scripts/plot/hist.m @ 17500:be7e8b91c6b1

hist.m: Overhaul function. * scripts/plot/hist.m: Rephrase some of docstring. Put input validation first. Use variable names in error messages. Use meaningful variable name 'xsort' rather than 'tmp'. Use in-place operators for performance.

author	Rik <rik@octave.org>
date	Wed, 25 Sep 2013 11:34:53 -0700
parents	1e2641277b2a
children

rev	line source
14138 72c96de7a403 maint: update copyright notices for 2012 John W. Eaton <jwe@octave.org> parents: 11587 diff changeset	1 ## Copyright (C) 1994-2012 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
7016 93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6586 diff changeset	7 ## the Free Software Foundation; either version 3 of the License, or (at
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6586 diff changeset	8 ## your option) any later version.
2313 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
7016 93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6586 diff changeset	16 ## along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6586 diff changeset	17 ## <http://www.gnu.org/licenses/>.
724 86d73993eee2 [project @ 1994-09-21 19:42:34 by jwe] jwe parents: diff changeset	18
3368 a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe] jwe parents: 3175 diff changeset	19 ## -- texinfo --
11563 3c6e8aaa9555 Grammarcheck m-files before 3.4 release. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	20 ## @deftypefn {Function File} {} hist (@var{y})
11351 bff585d759cf improved the help text in hist.m Doug Stewart <doug.dastew@gmail.com> parents: 10549 diff changeset	21 ## @deftypefnx {Function File} {} hist (@var{y}, @var{x})
bff585d759cf improved the help text in hist.m Doug Stewart <doug.dastew@gmail.com> parents: 10549 diff changeset	22 ## @deftypefnx {Function File} {} hist (@var{y}, @var{nbins})
bff585d759cf improved the help text in hist.m Doug Stewart <doug.dastew@gmail.com> parents: 10549 diff changeset	23 ## @deftypefnx {Function File} {} hist (@var{y}, @var{x}, @var{norm})
17166 b491ef539071 hist.m: Accept an axis handle as first input (bug #38508). Rik <rik@octave.org> parents: 17126 diff changeset	24 ## @deftypefnx {Function File} {} hist (@dots{}, @var{prop}, @var{val}, @dots{})
17170 1e2641277b2a hist.m: Correct typo in Texinfo docstring in cset b491ef539071. Rik <rik@octave.org> parents: 17166 diff changeset	25 ## @deftypefnx {Function File} {} hist (@var{hax}, @dots{})
11351 bff585d759cf improved the help text in hist.m Doug Stewart <doug.dastew@gmail.com> parents: 10549 diff changeset	26 ## @deftypefnx {Function File} {[@var{nn}, @var{xx}] =} hist (@dots{})
2311 2b5788792cad [project @ 1996-07-11 20:18:38 by jwe] jwe parents: 2303 diff changeset	27 ## Produce histogram counts or plots.
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3407 diff changeset	28 ##
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	29 ## With one vector input argument, @var{y}, plot a histogram of the values
c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	30 ## with 10 bins. The range of the histogram bins is determined by the
11351 bff585d759cf improved the help text in hist.m Doug Stewart <doug.dastew@gmail.com> parents: 10549 diff changeset	31 ## range of the data. With one matrix input argument, @var{y}, plot a
bff585d759cf improved the help text in hist.m Doug Stewart <doug.dastew@gmail.com> parents: 10549 diff changeset	32 ## histogram where each bin contains a bar per input column.
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3407 diff changeset	33 ##
11351 bff585d759cf improved the help text in hist.m Doug Stewart <doug.dastew@gmail.com> parents: 10549 diff changeset	34 ## Given a second vector argument, @var{x}, use that as the centers of
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	35 ## the bins, with the width of the bins determined from the adjacent
11351 bff585d759cf improved the help text in hist.m Doug Stewart <doug.dastew@gmail.com> parents: 10549 diff changeset	36 ## values in the vector.
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3407 diff changeset	37 ##
11575 d6619410e79c Spellcheck documentation before 3.4 release. Rik <octave@nomad.inbox5.com> parents: 11563 diff changeset	38 ## If scalar, the second argument, @var{nbins}, defines the number of bins.
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3407 diff changeset	39 ##
11575 d6619410e79c Spellcheck documentation before 3.4 release. Rik <octave@nomad.inbox5.com> parents: 11563 diff changeset	40 ## If a third argument is provided, the histogram is normalized such that
3597 26662775f4e9 [project @ 2000-02-12 02:24:41 by jwe] jwe parents: 3426 diff changeset	41 ## the sum of the bars is equal to @var{norm}.
26662775f4e9 [project @ 2000-02-12 02:24:41 by jwe] jwe parents: 3426 diff changeset	42 ##
17500 be7e8b91c6b1 hist.m: Overhaul function. Rik <rik@octave.org> parents: 17170 diff changeset	43 ## Extreme values are lumped into the first and last bins.
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3407 diff changeset	44 ##
11351 bff585d759cf improved the help text in hist.m Doug Stewart <doug.dastew@gmail.com> parents: 10549 diff changeset	45 ## The histogram's appearance may be modified by specifying property/value
17166 b491ef539071 hist.m: Accept an axis handle as first input (bug #38508). Rik <rik@octave.org> parents: 17126 diff changeset	46 ## pairs. For example the face and edge color may be modified.
11351 bff585d759cf improved the help text in hist.m Doug Stewart <doug.dastew@gmail.com> parents: 10549 diff changeset	47 ##
bff585d759cf improved the help text in hist.m Doug Stewart <doug.dastew@gmail.com> parents: 10549 diff changeset	48 ## @example
bff585d759cf improved the help text in hist.m Doug Stewart <doug.dastew@gmail.com> parents: 10549 diff changeset	49 ## @group
14327 4d917a6a858b doc: Use Octave coding conventions in @example blocks of docstrings. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	50 ## hist (randn (1, 100), 25, "facecolor", "r", "edgecolor", "b");
11351 bff585d759cf improved the help text in hist.m Doug Stewart <doug.dastew@gmail.com> parents: 10549 diff changeset	51 ## @end group
bff585d759cf improved the help text in hist.m Doug Stewart <doug.dastew@gmail.com> parents: 10549 diff changeset	52 ## @end example
bff585d759cf improved the help text in hist.m Doug Stewart <doug.dastew@gmail.com> parents: 10549 diff changeset	53 ##
bff585d759cf improved the help text in hist.m Doug Stewart <doug.dastew@gmail.com> parents: 10549 diff changeset	54 ## @noindent
17166 b491ef539071 hist.m: Accept an axis handle as first input (bug #38508). Rik <rik@octave.org> parents: 17126 diff changeset	55 ## The histogram's colors also depend upon the current colormap.
11351 bff585d759cf improved the help text in hist.m Doug Stewart <doug.dastew@gmail.com> parents: 10549 diff changeset	56 ##
bff585d759cf improved the help text in hist.m Doug Stewart <doug.dastew@gmail.com> parents: 10549 diff changeset	57 ## @example
bff585d759cf improved the help text in hist.m Doug Stewart <doug.dastew@gmail.com> parents: 10549 diff changeset	58 ## @group
14327 4d917a6a858b doc: Use Octave coding conventions in @example blocks of docstrings. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	59 ## hist (rand (10, 3));
4d917a6a858b doc: Use Octave coding conventions in @example blocks of docstrings. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	60 ## colormap (summer ());
11351 bff585d759cf improved the help text in hist.m Doug Stewart <doug.dastew@gmail.com> parents: 10549 diff changeset	61 ## @end group
bff585d759cf improved the help text in hist.m Doug Stewart <doug.dastew@gmail.com> parents: 10549 diff changeset	62 ## @end example
bff585d759cf improved the help text in hist.m Doug Stewart <doug.dastew@gmail.com> parents: 10549 diff changeset	63 ##
17166 b491ef539071 hist.m: Accept an axis handle as first input (bug #38508). Rik <rik@octave.org> parents: 17126 diff changeset	64 ## If the first argument @var{hax} is an axes handle, then plot into this axis,
b491ef539071 hist.m: Accept an axis handle as first input (bug #38508). Rik <rik@octave.org> parents: 17126 diff changeset	65 ## rather than the current axes returned by @code{gca}.
b491ef539071 hist.m: Accept an axis handle as first input (bug #38508). Rik <rik@octave.org> parents: 17126 diff changeset	66 ##
17500 be7e8b91c6b1 hist.m: Overhaul function. Rik <rik@octave.org> parents: 17170 diff changeset	67 ## With two output arguments, produce the values @var{nn} (numbers of elements)
be7e8b91c6b1 hist.m: Overhaul function. Rik <rik@octave.org> parents: 17170 diff changeset	68 ## and @var{xx} (bin centers) such that @code{bar (@var{xx}, @var{nn})} will
be7e8b91c6b1 hist.m: Overhaul function. Rik <rik@octave.org> parents: 17170 diff changeset	69 ## plot the histogram.
17166 b491ef539071 hist.m: Accept an axis handle as first input (bug #38508). Rik <rik@octave.org> parents: 17126 diff changeset	70 ##
17126 eaab03308c0b doc: Rewrite docstrings for most plot functions. Rik <rik@octave.org> parents: 14872 diff changeset	71 ## @seealso{histc, bar, pie, rose}
3368 a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe] jwe parents: 3175 diff changeset	72 ## @end deftypefn
724 86d73993eee2 [project @ 1994-09-21 19:42:34 by jwe] jwe parents: diff changeset	73
2314 949ab8eba8bc [project @ 1996-07-12 03:58:02 by jwe] jwe parents: 2313 diff changeset	74 ## Author: jwe
949ab8eba8bc [project @ 1996-07-12 03:58:02 by jwe] jwe parents: 2313 diff changeset	75
17166 b491ef539071 hist.m: Accept an axis handle as first input (bug #38508). Rik <rik@octave.org> parents: 17126 diff changeset	76 function [nn, xx] = hist (varargin)
b491ef539071 hist.m: Accept an axis handle as first input (bug #38508). Rik <rik@octave.org> parents: 17126 diff changeset	77
b491ef539071 hist.m: Accept an axis handle as first input (bug #38508). Rik <rik@octave.org> parents: 17126 diff changeset	78 [hax, varargin, nargin] = __plt_get_axis_arg__ ("hist", varargin{:});
724 86d73993eee2 [project @ 1994-09-21 19:42:34 by jwe] jwe parents: diff changeset	79
7112 f90a8188c9c2 [project @ 2007-11-07 00:24:11 by dbateman] dbateman parents: 7017 diff changeset	80 if (nargin < 1)
6046 34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe] jwe parents: 5746 diff changeset	81 print_usage ();
724 86d73993eee2 [project @ 1994-09-21 19:42:34 by jwe] jwe parents: diff changeset	82 endif
17166 b491ef539071 hist.m: Accept an axis handle as first input (bug #38508). Rik <rik@octave.org> parents: 17126 diff changeset	83
b491ef539071 hist.m: Accept an axis handle as first input (bug #38508). Rik <rik@octave.org> parents: 17126 diff changeset	84 y = varargin{1};
b491ef539071 hist.m: Accept an axis handle as first input (bug #38508). Rik <rik@octave.org> parents: 17126 diff changeset	85 varargin = varargin(2:end);
2325 b5568c31ee2c [project @ 1996-07-15 22:20:21 by jwe] jwe parents: 2314 diff changeset	86
5443 ec8c33dcd1bf [project @ 2005-09-08 01:40:57 by jwe] jwe parents: 5307 diff changeset	87 arg_is_vector = isvector (y);
5065 1312d3af9eb0 [project @ 2004-11-04 20:12:00 by jwe] jwe parents: 5053 diff changeset	88
17500 be7e8b91c6b1 hist.m: Overhaul function. Rik <rik@octave.org> parents: 17170 diff changeset	89 if (arg_is_vector)
4880 b9662e2ceb6b [project @ 2004-04-23 16:13:49 by jwe] jwe parents: 4873 diff changeset	90 y = y(:);
b9662e2ceb6b [project @ 2004-04-23 16:13:49 by jwe] jwe parents: 4873 diff changeset	91 endif
b9662e2ceb6b [project @ 2004-04-23 16:13:49 by jwe] jwe parents: 4873 diff changeset	92
17500 be7e8b91c6b1 hist.m: Overhaul function. Rik <rik@octave.org> parents: 17170 diff changeset	93 if (! isreal (y))
be7e8b91c6b1 hist.m: Overhaul function. Rik <rik@octave.org> parents: 17170 diff changeset	94 error ("hist: Y must be real valued");
724 86d73993eee2 [project @ 1994-09-21 19:42:34 by jwe] jwe parents: diff changeset	95 endif
86d73993eee2 [project @ 1994-09-21 19:42:34 by jwe] jwe parents: diff changeset	96
17500 be7e8b91c6b1 hist.m: Overhaul function. Rik <rik@octave.org> parents: 17170 diff changeset	97 max_val = max (y(:));
be7e8b91c6b1 hist.m: Overhaul function. Rik <rik@octave.org> parents: 17170 diff changeset	98 min_val = min (y(:));
be7e8b91c6b1 hist.m: Overhaul function. Rik <rik@octave.org> parents: 17170 diff changeset	99
7112 f90a8188c9c2 [project @ 2007-11-07 00:24:11 by dbateman] dbateman parents: 7017 diff changeset	100 iarg = 1;
f90a8188c9c2 [project @ 2007-11-07 00:24:11 by dbateman] dbateman parents: 7017 diff changeset	101 if (nargin == 1 \|\| ischar (varargin{iarg}))
724 86d73993eee2 [project @ 1994-09-21 19:42:34 by jwe] jwe parents: diff changeset	102 n = 10;
4880 b9662e2ceb6b [project @ 2004-04-23 16:13:49 by jwe] jwe parents: 4873 diff changeset	103 x = [0.5:n]'/n;
14868 5d3a684236b0 maint: Use Octave coding conventions for cuddling parentheses in scripts directory Rik <octave@nomad.inbox5.com> parents: 14613 diff changeset	104 x = x * (max_val - min_val) + ones (size (x)) * min_val;
3597 26662775f4e9 [project @ 2000-02-12 02:24:41 by jwe] jwe parents: 3426 diff changeset	105 else
26662775f4e9 [project @ 2000-02-12 02:24:41 by jwe] jwe parents: 3426 diff changeset	106 ## nargin is either 2 or 3
7208 a730e47fda4d [project @ 2007-11-28 02:32:41 by jwe] jwe parents: 7191 diff changeset	107 x = varargin{iarg++};
4030 22bd65326ec1 [project @ 2002-08-09 18:58:13 by jwe] jwe parents: 3690 diff changeset	108 if (isscalar (x))
724 86d73993eee2 [project @ 1994-09-21 19:42:34 by jwe] jwe parents: diff changeset	109 n = x;
86d73993eee2 [project @ 1994-09-21 19:42:34 by jwe] jwe parents: diff changeset	110 if (n <= 0)
17500 be7e8b91c6b1 hist.m: Overhaul function. Rik <rik@octave.org> parents: 17170 diff changeset	111 error ("hist: number of bins NBINS must be positive");
724 86d73993eee2 [project @ 1994-09-21 19:42:34 by jwe] jwe parents: diff changeset	112 endif
4880 b9662e2ceb6b [project @ 2004-04-23 16:13:49 by jwe] jwe parents: 4873 diff changeset	113 x = [0.5:n]'/n;
7191 b48a21816f2e [project @ 2007-11-26 21:24:32 by jwe] jwe parents: 7189 diff changeset	114 x = x * (max_val - min_val) + ones (size (x)) * min_val;
4880 b9662e2ceb6b [project @ 2004-04-23 16:13:49 by jwe] jwe parents: 4873 diff changeset	115 elseif (isreal (x))
b9662e2ceb6b [project @ 2004-04-23 16:13:49 by jwe] jwe parents: 4873 diff changeset	116 if (isvector (x))
10549 95c3e38098bf Untabify .m scripts Rik <code@nomad.inbox5.com> parents: 9040 diff changeset	117 x = x(:);
4880 b9662e2ceb6b [project @ 2004-04-23 16:13:49 by jwe] jwe parents: 4873 diff changeset	118 endif
17500 be7e8b91c6b1 hist.m: Overhaul function. Rik <rik@octave.org> parents: 17170 diff changeset	119 xsort = sort (x);
be7e8b91c6b1 hist.m: Overhaul function. Rik <rik@octave.org> parents: 17170 diff changeset	120 if (any (xsort != x))
904 3470f1e25a79 [project @ 1994-11-09 21:22:15 by jwe] jwe parents: 736 diff changeset	121 warning ("hist: bin values not sorted on input");
17500 be7e8b91c6b1 hist.m: Overhaul function. Rik <rik@octave.org> parents: 17170 diff changeset	122 x = xsort;
724 86d73993eee2 [project @ 1994-09-21 19:42:34 by jwe] jwe parents: diff changeset	123 endif
86d73993eee2 [project @ 1994-09-21 19:42:34 by jwe] jwe parents: diff changeset	124 else
86d73993eee2 [project @ 1994-09-21 19:42:34 by jwe] jwe parents: diff changeset	125 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	126 endif
86d73993eee2 [project @ 1994-09-21 19:42:34 by jwe] jwe parents: diff changeset	127 endif
86d73993eee2 [project @ 1994-09-21 19:42:34 by jwe] jwe parents: diff changeset	128
7189 e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman] dbateman parents: 7112 diff changeset	129 ## Avoid issues with integer types for x and y
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman] dbateman parents: 7112 diff changeset	130 x = double (x);
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman] dbateman parents: 7112 diff changeset	131 y = double (y);
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman] dbateman parents: 7112 diff changeset	132
4880 b9662e2ceb6b [project @ 2004-04-23 16:13:49 by jwe] jwe parents: 4873 diff changeset	133 cutoff = (x(1:end-1,:) + x(2:end,:)) / 2;
b9662e2ceb6b [project @ 2004-04-23 16:13:49 by jwe] jwe parents: 4873 diff changeset	134 n = rows (x);
7566 b3acdf1c41a5 hist: avoid temps; allow matrix args when number of bins > 30 John W. Eaton <jwe@octave.org> parents: 7208 diff changeset	135 y_nc = columns (y);
4880 b9662e2ceb6b [project @ 2004-04-23 16:13:49 by jwe] jwe parents: 4873 diff changeset	136 if (n < 30 && columns (x) == 1)
4407 16e8acbd19d5 [project @ 2003-05-05 19:00:56 by jwe] jwe parents: 4030 diff changeset	137 ## The following algorithm works fastest for n less than about 30.
7566 b3acdf1c41a5 hist: avoid temps; allow matrix args when number of bins > 30 John W. Eaton <jwe@octave.org> parents: 7208 diff changeset	138 chist = zeros (n+1, y_nc);
4407 16e8acbd19d5 [project @ 2003-05-05 19:00:56 by jwe] jwe parents: 4030 diff changeset	139 for i = 1:n-1
4880 b9662e2ceb6b [project @ 2004-04-23 16:13:49 by jwe] jwe parents: 4873 diff changeset	140 chist(i+1,:) = sum (y <= cutoff(i));
4407 16e8acbd19d5 [project @ 2003-05-05 19:00:56 by jwe] jwe parents: 4030 diff changeset	141 endfor
5746 e4e93452fd3e [project @ 2006-04-06 20:46:31 by jwe] jwe parents: 5642 diff changeset	142 chist(n+1,:) = sum (! isnan (y));
4407 16e8acbd19d5 [project @ 2003-05-05 19:00:56 by jwe] jwe parents: 4030 diff changeset	143 else
16e8acbd19d5 [project @ 2003-05-05 19:00:56 by jwe] jwe parents: 4030 diff changeset	144 ## The following algorithm works fastest for n greater than about 30.
16e8acbd19d5 [project @ 2003-05-05 19:00:56 by jwe] jwe parents: 4030 diff changeset	145 ## Put cutoff elements between boundaries, integrate over all
16e8acbd19d5 [project @ 2003-05-05 19:00:56 by jwe] jwe parents: 4030 diff changeset	146 ## elements, keep totals at boundaries.
7566 b3acdf1c41a5 hist: avoid temps; allow matrix args when number of bins > 30 John W. Eaton <jwe@octave.org> parents: 7208 diff changeset	147 [s, idx] = sort ([y; repmat(cutoff, 1, y_nc)]);
4880 b9662e2ceb6b [project @ 2004-04-23 16:13:49 by jwe] jwe parents: 4873 diff changeset	148 len = rows (y);
b9662e2ceb6b [project @ 2004-04-23 16:13:49 by jwe] jwe parents: 4873 diff changeset	149 chist = cumsum (idx <= len);
7566 b3acdf1c41a5 hist: avoid temps; allow matrix args when number of bins > 30 John W. Eaton <jwe@octave.org> parents: 7208 diff changeset	150 chist = [(zeros (1, y_nc));
10549 95c3e38098bf Untabify .m scripts Rik <code@nomad.inbox5.com> parents: 9040 diff changeset	151 (reshape (chist(idx > len), rows (cutoff), y_nc));
95c3e38098bf Untabify .m scripts Rik <code@nomad.inbox5.com> parents: 9040 diff changeset	152 (chist(end,:) - sum (isnan (y)))];
4407 16e8acbd19d5 [project @ 2003-05-05 19:00:56 by jwe] jwe parents: 4030 diff changeset	153 endif
16e8acbd19d5 [project @ 2003-05-05 19:00:56 by jwe] jwe parents: 4030 diff changeset	154
4880 b9662e2ceb6b [project @ 2004-04-23 16:13:49 by jwe] jwe parents: 4873 diff changeset	155 freq = diff (chist);
724 86d73993eee2 [project @ 1994-09-21 19:42:34 by jwe] jwe parents: diff changeset	156
7191 b48a21816f2e [project @ 2007-11-26 21:24:32 by jwe] jwe parents: 7189 diff changeset	157 if (nargin > 2 && ! ischar (varargin{iarg}))
17500 be7e8b91c6b1 hist.m: Overhaul function. Rik <rik@octave.org> parents: 17170 diff changeset	158 ## Normalize the histogram.
7112 f90a8188c9c2 [project @ 2007-11-07 00:24:11 by dbateman] dbateman parents: 7017 diff changeset	159 norm = varargin{iarg++};
17500 be7e8b91c6b1 hist.m: Overhaul function. Rik <rik@octave.org> parents: 17170 diff changeset	160 freq *= norm / sum (! isnan (y));
3597 26662775f4e9 [project @ 2000-02-12 02:24:41 by jwe] jwe parents: 3426 diff changeset	161 endif
26662775f4e9 [project @ 2000-02-12 02:24:41 by jwe] jwe parents: 3426 diff changeset	162
6586 e4ea529efab0 [project @ 2007-04-26 19:09:26 by dbateman] dbateman parents: 6582 diff changeset	163 if (nargout > 0)
17500 be7e8b91c6b1 hist.m: Overhaul function. Rik <rik@octave.org> parents: 17170 diff changeset	164 if (arg_is_vector)
be7e8b91c6b1 hist.m: Overhaul function. Rik <rik@octave.org> parents: 17170 diff changeset	165 ## Matlab compatibility requires a row vector return
be7e8b91c6b1 hist.m: Overhaul function. Rik <rik@octave.org> parents: 17170 diff changeset	166 nn = freq';
4880 b9662e2ceb6b [project @ 2004-04-23 16:13:49 by jwe] jwe parents: 4873 diff changeset	167 xx = x';
b9662e2ceb6b [project @ 2004-04-23 16:13:49 by jwe] jwe parents: 4873 diff changeset	168 else
b9662e2ceb6b [project @ 2004-04-23 16:13:49 by jwe] jwe parents: 4873 diff changeset	169 nn = freq;
b9662e2ceb6b [project @ 2004-04-23 16:13:49 by jwe] jwe parents: 4873 diff changeset	170 xx = x;
b9662e2ceb6b [project @ 2004-04-23 16:13:49 by jwe] jwe parents: 4873 diff changeset	171 endif
736 c8f88bd3202b [project @ 1994-09-24 03:28:05 by jwe] jwe parents: 724 diff changeset	172 else
17166 b491ef539071 hist.m: Accept an axis handle as first input (bug #38508). Rik <rik@octave.org> parents: 17126 diff changeset	173 if (isempty (hax))
b491ef539071 hist.m: Accept an axis handle as first input (bug #38508). Rik <rik@octave.org> parents: 17126 diff changeset	174 hax = gca ();
b491ef539071 hist.m: Accept an axis handle as first input (bug #38508). Rik <rik@octave.org> parents: 17126 diff changeset	175 endif
b491ef539071 hist.m: Accept an axis handle as first input (bug #38508). Rik <rik@octave.org> parents: 17126 diff changeset	176 if (columns (freq) != 1)
b491ef539071 hist.m: Accept an axis handle as first input (bug #38508). Rik <rik@octave.org> parents: 17126 diff changeset	177 bar (hax, x, freq, 0.8, varargin{iarg:end});
b491ef539071 hist.m: Accept an axis handle as first input (bug #38508). Rik <rik@octave.org> parents: 17126 diff changeset	178 else
b491ef539071 hist.m: Accept an axis handle as first input (bug #38508). Rik <rik@octave.org> parents: 17126 diff changeset	179 bar (hax, x, freq, 1.0, varargin{iarg:end});
b491ef539071 hist.m: Accept an axis handle as first input (bug #38508). Rik <rik@octave.org> parents: 17126 diff changeset	180 endif
724 86d73993eee2 [project @ 1994-09-21 19:42:34 by jwe] jwe parents: diff changeset	181 endif
86d73993eee2 [project @ 1994-09-21 19:42:34 by jwe] jwe parents: diff changeset	182
86d73993eee2 [project @ 1994-09-21 19:42:34 by jwe] jwe parents: diff changeset	183 endfunction
4811 198f3712c692 [project @ 2004-03-03 19:24:33 by jwe] jwe parents: 4430 diff changeset	184
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	185
4811 198f3712c692 [project @ 2004-03-03 19:24:33 by jwe] jwe parents: 4430 diff changeset	186 %!test
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	187 %! [nn,xx] = hist ([1:4], 3);
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	188 %! assert (xx, [1.5,2.5,3.5]);
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	189 %! assert (nn, [2,1,1]);
4880 b9662e2ceb6b [project @ 2004-04-23 16:13:49 by jwe] jwe parents: 4873 diff changeset	190 %!test
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	191 %! [nn,xx] = hist ([1:4]', 3);
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	192 %! assert (xx, [1.5,2.5,3.5]);
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	193 %! assert (nn, [2,1,1]);
4880 b9662e2ceb6b [project @ 2004-04-23 16:13:49 by jwe] jwe parents: 4873 diff changeset	194 %!test
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	195 %! [nn,xx] = hist ([1 1 1 NaN NaN NaN 2 2 3],[1 2 3]);
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	196 %! assert (xx, [1,2,3]);
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	197 %! assert (nn, [3,2,1]);
5746 e4e93452fd3e [project @ 2006-04-06 20:46:31 by jwe] jwe parents: 5642 diff changeset	198 %!test
14613 e7c8e31f8e5d hist.m: Add test to check for correct NaN normalising Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 14612 diff changeset	199 %! [nn,xx] = hist ([1 1 1 NaN NaN NaN 2 2 3],[1 2 3], 6);
e7c8e31f8e5d hist.m: Add test to check for correct NaN normalising Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 14612 diff changeset	200 %! assert (xx, [1,2,3]);
e7c8e31f8e5d hist.m: Add test to check for correct NaN normalising Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 14612 diff changeset	201 %! assert (nn, [3,2,1]);
e7c8e31f8e5d hist.m: Add test to check for correct NaN normalising Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 14612 diff changeset	202 %!test
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	203 %! [nn,xx] = hist ([[1:4]', [1:4]'], 3);
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	204 %! assert (xx, [1.5;2.5;3.5]);
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	205 %! assert (nn, [[2,1,1]',[2,1,1]']);
4880 b9662e2ceb6b [project @ 2004-04-23 16:13:49 by jwe] jwe parents: 4873 diff changeset	206 %!test
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	207 %! for n = [10, 30, 100, 1000]
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	208 %! assert (sum (hist ([1:n], n)), n);
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	209 %! assert (sum (hist ([1:n], [2:n-1])), n);
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	210 %! assert (sum (hist ([1:n], [1:n])), n);
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	211 %! assert (sum (hist ([1:n], 29)), n);
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	212 %! assert (sum (hist ([1:n], 30)), n);
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	213 %! endfor
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	214 %!assert (hist (1,1), 1)
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	215 %!assert (size (hist (randn (750,240), 200)), [200,240])
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	216

Mercurial > hg > octave-lyh

annotate scripts/plot/hist.m @ 17500:be7e8b91c6b1