octave-nkf: scripts/statistics/base/iqr.m annotate

annotate scripts/statistics/base/iqr.m @ 19867:9fc020886ae9

maint: Clean up m-files to follow Octave coding conventions. Try to trim long lines to < 80 chars. Use '##' for single line comments. Use '(...)' around tests for if/elseif/switch/while. Abut cell indexing operator '{' next to variable. Abut array indexing operator '(' next to variable. Use space between negation operator '!' and following expression. Use two newlines between endfunction and start of %!test or %!demo code. Remove unnecessary parens grouping between short-circuit operators. Remove stray extra spaces (typos) between variables and assignment operators. Remove stray extra spaces from ends of lines.

author	Rik <rik@octave.org>
date	Mon, 23 Feb 2015 14:54:39 -0800
parents	4197fc428c7d
children	d9341b422488

rev	line source
19731 4197fc428c7d maint: Update copyright notices for 2015. John W. Eaton <jwe@octave.org> parents: 17744 diff changeset	1 ## Copyright (C) 1995-2015 Kurt Hornik
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3200 diff changeset	2 ##
3922 38c61cbf086c [project @ 2002-05-01 06:48:35 by jwe] jwe parents: 3456 diff changeset	3 ## This file is part of Octave.
38c61cbf086c [project @ 2002-05-01 06:48:35 by jwe] jwe parents: 3456 diff changeset	4 ##
38c61cbf086c [project @ 2002-05-01 06:48:35 by jwe] jwe parents: 3456 diff changeset	5 ## Octave is free software; you can redistribute it and/or modify it
38c61cbf086c [project @ 2002-05-01 06:48:35 by jwe] jwe parents: 3456 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: 6046 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: 6046 diff changeset	8 ## your option) any later version.
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3200 diff changeset	9 ##
3922 38c61cbf086c [project @ 2002-05-01 06:48:35 by jwe] jwe parents: 3456 diff changeset	10 ## Octave is distributed in the hope that it will be useful, but
3200 781c930425fd [project @ 1998-10-29 05:23:08 by jwe] jwe parents: diff changeset	11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
781c930425fd [project @ 1998-10-29 05:23:08 by jwe] jwe parents: diff changeset	12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3200 diff changeset	13 ## General Public License for more details.
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3200 diff changeset	14 ##
3200 781c930425fd [project @ 1998-10-29 05:23:08 by jwe] jwe parents: 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: 6046 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: 6046 diff changeset	17 ## <http://www.gnu.org/licenses/>.
3200 781c930425fd [project @ 1998-10-29 05:23:08 by jwe] jwe parents: diff changeset	18
3453 71d2e09c15a2 [project @ 2000-01-18 08:32:09 by jwe] jwe parents: 3426 diff changeset	19 ## -- texinfo --
11436 e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 11149 diff changeset	20 ## @deftypefn {Function File} {} iqr (@var{x})
e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 11149 diff changeset	21 ## @deftypefnx {Function File} {} iqr (@var{x}, @var{dim})
e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 11149 diff changeset	22 ## Return the interquartile range, i.e., the difference between the upper
e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 11149 diff changeset	23 ## and lower quartile of the input data. If @var{x} is a matrix, do the
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	24 ## above for first non-singleton dimension of @var{x}.
3200 781c930425fd [project @ 1998-10-29 05:23:08 by jwe] jwe parents: diff changeset	25 ##
11436 e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 11149 diff changeset	26 ## If the optional argument @var{dim} is given, operate along this dimension.
e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 11149 diff changeset	27 ##
e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 11149 diff changeset	28 ## As a measure of dispersion, the interquartile range is less affected by
e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 11149 diff changeset	29 ## outliers than either @code{range} or @code{std}.
e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 11149 diff changeset	30 ## @seealso{range, std}
3453 71d2e09c15a2 [project @ 2000-01-18 08:32:09 by jwe] jwe parents: 3426 diff changeset	31 ## @end deftypefn
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3200 diff changeset	32
5428 2a16423e4aa0 [project @ 2005-08-23 18:38:27 by jwe] jwe parents: 5307 diff changeset	33 ## Author KH <Kurt.Hornik@wu-wien.ac.at>
3456 434790acb067 [project @ 2000-01-19 06:58:51 by jwe] jwe parents: 3453 diff changeset	34 ## Description: Interquartile range
3200 781c930425fd [project @ 1998-10-29 05:23:08 by jwe] jwe parents: diff changeset	35
4885 28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe] jwe parents: 4681 diff changeset	36 function y = iqr (x, dim)
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3200 diff changeset	37
4885 28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe] jwe parents: 4681 diff changeset	38 if (nargin != 1 && nargin != 2)
6046 34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe] jwe parents: 5435 diff changeset	39 print_usage ();
3200 781c930425fd [project @ 1998-10-29 05:23:08 by jwe] jwe parents: diff changeset	40 endif
781c930425fd [project @ 1998-10-29 05:23:08 by jwe] jwe parents: diff changeset	41
12656 6b2f14af2360 Overhaul functions in statistics/base directory. Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	42 if (! (isnumeric (x) \|\| islogical (x)))
11436 e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 11149 diff changeset	43 error ("iqr: X must be a numeric vector or matrix");
10669 cab3b148d4e4 Improve validation of input arguments for base statistics functions. Rik <octave@nomad.inbox5.com> parents: 10549 diff changeset	44 endif
cab3b148d4e4 Improve validation of input arguments for base statistics functions. Rik <octave@nomad.inbox5.com> parents: 10549 diff changeset	45
4885 28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe] jwe parents: 4681 diff changeset	46 nd = ndims (x);
28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe] jwe parents: 4681 diff changeset	47 sz = size (x);
28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe] jwe parents: 4681 diff changeset	48 nel = numel (x);
28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe] jwe parents: 4681 diff changeset	49 if (nargin != 2)
4886 54b076a24718 [project @ 2004-04-30 04:31:51 by jwe] jwe parents: 4885 diff changeset	50 ## Find the first non-singleton dimension.
12656 6b2f14af2360 Overhaul functions in statistics/base directory. Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	51 (dim = find (sz > 1, 1)) \|\| (dim = 1);
4885 28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe] jwe parents: 4681 diff changeset	52 else
11436 e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 11149 diff changeset	53 if (!(isscalar (dim) && dim == fix (dim))
11149 fe3c3dfc07eb style fix: break lines before && and \|\|, not after John W. Eaton <jwe@octave.org> parents: 10669 diff changeset	54 \|\| !(1 <= dim && dim <= nd))
10669 cab3b148d4e4 Improve validation of input arguments for base statistics functions. Rik <octave@nomad.inbox5.com> parents: 10549 diff changeset	55 error ("iqr: DIM must be an integer and a valid dimension");
4885 28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe] jwe parents: 4681 diff changeset	56 endif
4681 bb9515a3527d [project @ 2003-12-18 15:35:09 by jwe] jwe parents: 4631 diff changeset	57 endif
4631 cae0b7c46842 [project @ 2003-11-18 18:30:06 by jwe] jwe parents: 3922 diff changeset	58
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	59 ## This code is a bit heavy, but is needed until empirical_inv
12656 6b2f14af2360 Overhaul functions in statistics/base directory. Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	60 ## can take a matrix, rather than just a vector argument.
6b2f14af2360 Overhaul functions in statistics/base directory. Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	61 n = sz(dim);
4886 54b076a24718 [project @ 2004-04-30 04:31:51 by jwe] jwe parents: 4885 diff changeset	62 sz(dim) = 1;
14336 34af9f9ff98b Use Octave coding conventions (double-quote " in preference to single quote ') Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	63 if (isa (x, "single"))
34af9f9ff98b Use Octave coding conventions (double-quote " in preference to single quote ') Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	64 y = zeros (sz, "single");
12656 6b2f14af2360 Overhaul functions in statistics/base directory. Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	65 else
6b2f14af2360 Overhaul functions in statistics/base directory. Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	66 y = zeros (sz);
6b2f14af2360 Overhaul functions in statistics/base directory. Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	67 endif
4886 54b076a24718 [project @ 2004-04-30 04:31:51 by jwe] jwe parents: 4885 diff changeset	68 stride = prod (sz(1:dim-1));
12656 6b2f14af2360 Overhaul functions in statistics/base directory. Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	69 for i = 1 : nel / n;
4885 28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe] jwe parents: 4681 diff changeset	70 offset = i;
28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe] jwe parents: 4681 diff changeset	71 offset2 = 0;
28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe] jwe parents: 4681 diff changeset	72 while (offset > stride)
28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe] jwe parents: 4681 diff changeset	73 offset -= stride;
28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe] jwe parents: 4681 diff changeset	74 offset2++;
28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe] jwe parents: 4681 diff changeset	75 endwhile
12656 6b2f14af2360 Overhaul functions in statistics/base directory. Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	76 offset += offset2 * stride * n;
6b2f14af2360 Overhaul functions in statistics/base directory. Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	77 rng = [0 : n-1] * stride + offset;
4631 cae0b7c46842 [project @ 2003-11-18 18:30:06 by jwe] jwe parents: 3922 diff changeset	78
12656 6b2f14af2360 Overhaul functions in statistics/base directory. Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	79 y(i) = diff (empirical_inv ([1/4, 3/4], x(rng)));
4681 bb9515a3527d [project @ 2003-12-18 15:35:09 by jwe] jwe parents: 4631 diff changeset	80 endfor
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3200 diff changeset	81
3200 781c930425fd [project @ 1998-10-29 05:23:08 by jwe] jwe parents: diff changeset	82 endfunction
11436 e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 11149 diff changeset	83
12656 6b2f14af2360 Overhaul functions in statistics/base directory. Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	84
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14336 diff changeset	85 %!assert (iqr (1:101), 50)
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14336 diff changeset	86 %!assert (iqr (single (1:101)), single (50))
11436 e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 11149 diff changeset	87
19867 9fc020886ae9 maint: Clean up m-files to follow Octave coding conventions. Rik <rik@octave.org> parents: 19731 diff changeset	88 ## FIXME: iqr throws horrible error when running across a dimension that is 1.
9fc020886ae9 maint: Clean up m-files to follow Octave coding conventions. Rik <rik@octave.org> parents: 19731 diff changeset	89 %!test
9fc020886ae9 maint: Clean up m-files to follow Octave coding conventions. Rik <rik@octave.org> parents: 19731 diff changeset	90 %! x = [1:100]';
9fc020886ae9 maint: Clean up m-files to follow Octave coding conventions. Rik <rik@octave.org> parents: 19731 diff changeset	91 %! assert (iqr (x, 1), 50);
9fc020886ae9 maint: Clean up m-files to follow Octave coding conventions. Rik <rik@octave.org> parents: 19731 diff changeset	92 %! assert (iqr (x', 2), 50);
11436 e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 11149 diff changeset	93
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14336 diff changeset	94 %!error iqr ()
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14336 diff changeset	95 %!error iqr (1, 2, 3)
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14336 diff changeset	96 %!error iqr (1)
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14336 diff changeset	97 %!error iqr (['A'; 'B'])
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14336 diff changeset	98 %!error iqr (1:10, 3)
12656 6b2f14af2360 Overhaul functions in statistics/base directory. Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	99

Mercurial > octave-nkf

annotate scripts/statistics/base/iqr.m @ 19867:9fc020886ae9