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

annotate scripts/statistics/base/ranks.m @ 12575:d0b799dafede

Grammarcheck files for 3.4.1 release.

author	Rik <octave@nomad.inbox5.com>
date	Mon, 04 Apr 2011 15:33:46 -0700
parents	c792872f8942
children	6b2f14af2360

rev	line source
11523 fd0a3ac60b0e update copyright notices John W. Eaton <jwe@octave.org> parents: 11436 diff changeset	1 ## Copyright (C) 1995-2011 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: 3457 diff changeset	3 ## This file is part of Octave.
38c61cbf086c [project @ 2002-05-01 06:48:35 by jwe] jwe parents: 3457 diff changeset	4 ##
38c61cbf086c [project @ 2002-05-01 06:48:35 by jwe] jwe parents: 3457 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: 3457 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: 3457 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 --
4885 28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe] jwe parents: 3922 diff changeset	20 ## @deftypefn {Function File} {} ranks (@var{x}, @var{dim})
8035 1720d4fab3fa Doc fix for ranks David Bateman <dbateman@free.fr> parents: 7017 diff changeset	21 ## Return the ranks of @var{x} along the first non-singleton dimension
10687 a8ce6bdecce5 Improve documentation strings. Rik <octave@nomad.inbox5.com> parents: 10669 diff changeset	22 ## adjusted for ties. If the optional argument @var{dim} is
4885 28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe] jwe parents: 3922 diff changeset	23 ## given, operate along this dimension.
12575 d0b799dafede Grammarcheck files for 3.4.1 release. Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	24 ## @seealso{spearman, kendall}
3453 71d2e09c15a2 [project @ 2000-01-18 08:32:09 by jwe] jwe parents: 3426 diff changeset	25 ## @end deftypefn
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3200 diff changeset	26
5428 2a16423e4aa0 [project @ 2005-08-23 18:38:27 by jwe] jwe parents: 5307 diff changeset	27 ## Author: KH <Kurt.Hornik@wu-wien.ac.at>
3456 434790acb067 [project @ 2000-01-19 06:58:51 by jwe] jwe parents: 3453 diff changeset	28 ## Description: Compute ranks
3200 781c930425fd [project @ 1998-10-29 05:23:08 by jwe] jwe parents: diff changeset	29
4885 28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe] jwe parents: 3922 diff changeset	30 ## This code was rather ugly, since it didn't use sort due to the
28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe] jwe parents: 3922 diff changeset	31 ## fact of how to deal with ties. Now it does use sort and its
28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe] jwe parents: 3922 diff changeset	32 ## even uglier!!! At least it handles NDArrays..
28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe] jwe parents: 3922 diff changeset	33
28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe] jwe parents: 3922 diff changeset	34 function y = ranks (x, dim)
28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe] jwe parents: 3922 diff changeset	35
28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe] jwe parents: 3922 diff changeset	36 if (nargin != 1 && nargin != 2)
6046 34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe] jwe parents: 5428 diff changeset	37 print_usage ();
4885 28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe] jwe parents: 3922 diff changeset	38 endif
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3200 diff changeset	39
11436 e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 11149 diff changeset	40 if (!isnumeric(x))
e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 11149 diff changeset	41 error ("ranks: 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: 10650 diff changeset	42 endif
cab3b148d4e4 Improve validation of input arguments for base statistics functions. Rik <octave@nomad.inbox5.com> parents: 10650 diff changeset	43
4885 28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe] jwe parents: 3922 diff changeset	44 nd = ndims (x);
28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe] jwe parents: 3922 diff changeset	45 sz = size (x);
28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe] jwe parents: 3922 diff changeset	46 if (nargin != 2)
4886 54b076a24718 [project @ 2004-04-30 04:31:51 by jwe] jwe parents: 4885 diff changeset	47 ## Find the first non-singleton dimension.
10669 cab3b148d4e4 Improve validation of input arguments for base statistics functions. Rik <octave@nomad.inbox5.com> parents: 10650 diff changeset	48 dim = find (sz > 1, 1);
cab3b148d4e4 Improve validation of input arguments for base statistics functions. Rik <octave@nomad.inbox5.com> parents: 10650 diff changeset	49 if (isempty (dim))
4885 28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe] jwe parents: 3922 diff changeset	50 dim = 1;
28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe] jwe parents: 3922 diff changeset	51 endif
28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe] jwe parents: 3922 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: 10687 diff changeset	54 \|\| !(1 <= dim && dim <= nd))
10669 cab3b148d4e4 Improve validation of input arguments for base statistics functions. Rik <octave@nomad.inbox5.com> parents: 10650 diff changeset	55 error ("ranks: DIM must be an integer and a valid dimension");
4885 28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe] jwe parents: 3922 diff changeset	56 endif
3200 781c930425fd [project @ 1998-10-29 05:23:08 by jwe] jwe parents: diff changeset	57 endif
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3200 diff changeset	58
4886 54b076a24718 [project @ 2004-04-30 04:31:51 by jwe] jwe parents: 4885 diff changeset	59 if (sz(dim) == 1)
4885 28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe] jwe parents: 3922 diff changeset	60 y = ones(sz);
28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe] jwe parents: 3922 diff changeset	61 else
8507 cadc73247d65 style fixes John W. Eaton <jwe@octave.org> parents: 8035 diff changeset	62 ## The algorithm works only on dim = 1, so permute if necesary.
4885 28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe] jwe parents: 3922 diff changeset	63 if (dim != 1)
28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe] jwe parents: 3922 diff changeset	64 perm = [1 : nd];
4886 54b076a24718 [project @ 2004-04-30 04:31:51 by jwe] jwe parents: 4885 diff changeset	65 perm(1) = dim;
54b076a24718 [project @ 2004-04-30 04:31:51 by jwe] jwe parents: 4885 diff changeset	66 perm(dim) = 1;
4885 28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe] jwe parents: 3922 diff changeset	67 x = permute (x, perm);
28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe] jwe parents: 3922 diff changeset	68 endif
4886 54b076a24718 [project @ 2004-04-30 04:31:51 by jwe] jwe parents: 4885 diff changeset	69 sz = size (x);
10540 952d4df5b686 Eliminate NaNones and Infones constructs and just use Nan() and Inf() Rik <code@nomad.inbox5.com> parents: 9051 diff changeset	70 infvec = -Inf ([1, sz(2 : end)]);
4942 a0f2839f6ac8 [project @ 2004-08-28 01:29:39 by jwe] jwe parents: 4886 diff changeset	71 [xs, xi] = sort (x);
4885 28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe] jwe parents: 3922 diff changeset	72 eq_el = find (diff ([xs; infvec]) == 0);
28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe] jwe parents: 3922 diff changeset	73 if (isempty (eq_el))
4942 a0f2839f6ac8 [project @ 2004-08-28 01:29:39 by jwe] jwe parents: 4886 diff changeset	74 [eq_el, y] = sort (xi);
4885 28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe] jwe parents: 3922 diff changeset	75 else
10650 f0dc41c824ce Replace calls to deprecated functions. Rik <octave@nomad.inbox5.com> parents: 10549 diff changeset	76 runs = setdiff (eq_el, eq_el+1);
4885 28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe] jwe parents: 3922 diff changeset	77 len = diff (find (diff ([Inf; eq_el; -Inf]) != 1)) + 1;
4942 a0f2839f6ac8 [project @ 2004-08-28 01:29:39 by jwe] jwe parents: 4886 diff changeset	78 [eq_el, y] = sort (xi);
4885 28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe] jwe parents: 3922 diff changeset	79 for i = 1 : length(runs)
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	80 y (xi (runs (i) + [0:(len(i)-1)]) + floor (runs (i) ./ sz(1))
10549 95c3e38098bf Untabify .m scripts Rik <code@nomad.inbox5.com> parents: 10540 diff changeset	81 * sz(1)) = eq_el(runs(i)) + (len(i) - 1) / 2;
4885 28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe] jwe parents: 3922 diff changeset	82 endfor
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	83 endif
4885 28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe] jwe parents: 3922 diff changeset	84 if (dim != 1)
28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe] jwe parents: 3922 diff changeset	85 y = permute (y, perm);
28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe] jwe parents: 3922 diff changeset	86 endif
3200 781c930425fd [project @ 1998-10-29 05:23:08 by jwe] jwe parents: diff changeset	87 endif
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3200 diff changeset	88
3200 781c930425fd [project @ 1998-10-29 05:23:08 by jwe] jwe parents: diff changeset	89 endfunction
11436 e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 11149 diff changeset	90
e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 11149 diff changeset	91
e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 11149 diff changeset	92 %!assert(ranks (1:2:10), 1:5)
e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 11149 diff changeset	93 %!assert(ranks (10:-2:1), 5:-1:1)
e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 11149 diff changeset	94 %!assert(ranks ([2, 1, 2, 4]), [2.5, 1, 2.5, 4])
e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 11149 diff changeset	95 %!assert(ranks (ones(1, 5)), 3*ones(1, 5))
e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 11149 diff changeset	96 %!assert(ranks (1e6ones(1, 5)), 3ones(1, 5))
e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 11149 diff changeset	97 %!assert(ranks (rand (1, 5), 1), ones(1, 5))
e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 11149 diff changeset	98
e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 11149 diff changeset	99 %% Test input validation
e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 11149 diff changeset	100 %!error ranks ()
e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 11149 diff changeset	101 %!error ranks (1, 2, 3)
e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 11149 diff changeset	102 %!error ranks ({1, 2})
e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 11149 diff changeset	103 %!error ranks (true(2,1))
e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 11149 diff changeset	104 %!error ranks (1, 1.5)
e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 11149 diff changeset	105 %!error ranks (1, 0)
e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 11149 diff changeset	106 %!error ranks (1, 3)
e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 11149 diff changeset	107

Mercurial > octave-nkf

annotate scripts/statistics/base/ranks.m @ 12575:d0b799dafede