octave: scripts/statistics/ranks.m annotate

annotate scripts/statistics/ranks.m @ 25054:6652d3823428 stable

maint: Update copyright dates in all source files.

author	John W. Eaton <jwe@octave.org>
date	Fri, 30 Mar 2018 09:19:05 -0400
parents	fdc9ce839afd
children	31b443b5a6c1

rev	line source
25054 6652d3823428 maint: Update copyright dates in all source files. John W. Eaton <jwe@octave.org> parents: 24547 diff changeset	1 ## Copyright (C) 1995-2018 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 ##
24534 194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 23220 diff changeset	5 ## Octave is free software: you can redistribute it and/or modify it
3922 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
24534 194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 23220 diff changeset	7 ## the Free Software Foundation, either version 3 of the License, or
22755 3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22323 diff changeset	8 ## (at 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
22755 3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22323 diff changeset	12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22323 diff changeset	13 ## GNU General Public License for more details.
3426 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
24534 194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 23220 diff changeset	17 ## <https://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 --
20852 516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files. Rik <rik@octave.org> parents: 20174 diff changeset	20 ## @deftypefn {} {} 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
20174 d9341b422488 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	22 ## adjusted for ties.
d9341b422488 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	23 ##
d9341b422488 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	24 ## If the optional argument @var{dim} is given, operate along this dimension.
12575 d0b799dafede Grammarcheck files for 3.4.1 release. Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	25 ## @seealso{spearman, kendall}
3453 71d2e09c15a2 [project @ 2000-01-18 08:32:09 by jwe] jwe parents: 3426 diff changeset	26 ## @end deftypefn
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3200 diff changeset	27
5428 2a16423e4aa0 [project @ 2005-08-23 18:38:27 by jwe] jwe parents: 5307 diff changeset	28 ## Author: KH <Kurt.Hornik@wu-wien.ac.at>
3456 434790acb067 [project @ 2000-01-19 06:58:51 by jwe] jwe parents: 3453 diff changeset	29 ## Description: Compute ranks
3200 781c930425fd [project @ 1998-10-29 05:23:08 by jwe] jwe parents: diff changeset	30
4885 28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe] jwe parents: 3922 diff changeset	31 ## This code was rather ugly, since it didn't use sort due to the
21751 b571fc85953f maint: Use two spaces after period to indicate sentence break. Rik <rik@octave.org> parents: 20852 diff changeset	32 ## fact of how to deal with ties. Now it does use sort and its
b571fc85953f maint: Use two spaces after period to indicate sentence break. Rik <rik@octave.org> parents: 20852 diff changeset	33 ## even uglier! At least it handles NDArrays.
4885 28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe] jwe parents: 3922 diff changeset	34
28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe] jwe parents: 3922 diff changeset	35 function y = ranks (x, dim)
28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe] jwe parents: 3922 diff changeset	36
28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe] jwe parents: 3922 diff changeset	37 if (nargin != 1 && nargin != 2)
6046 34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe] jwe parents: 5428 diff changeset	38 print_usage ();
4885 28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe] jwe parents: 3922 diff changeset	39 endif
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3200 diff changeset	40
12656 6b2f14af2360 Overhaul functions in statistics/base directory. Rik <octave@nomad.inbox5.com> parents: 12575 diff changeset	41 if (! (isnumeric (x) \|\| islogical (x)))
11436 e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 11149 diff changeset	42 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	43 endif
cab3b148d4e4 Improve validation of input arguments for base statistics functions. Rik <octave@nomad.inbox5.com> parents: 10650 diff changeset	44
4885 28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe] jwe parents: 3922 diff changeset	45 nd = ndims (x);
28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe] jwe parents: 3922 diff changeset	46 sz = size (x);
28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe] jwe parents: 3922 diff changeset	47 if (nargin != 2)
4886 54b076a24718 [project @ 2004-04-30 04:31:51 by jwe] jwe parents: 4885 diff changeset	48 ## Find the first non-singleton dimension.
12656 6b2f14af2360 Overhaul functions in statistics/base directory. Rik <octave@nomad.inbox5.com> parents: 12575 diff changeset	49 (dim = find (sz > 1, 1)) \|\| (dim = 1);
4885 28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe] jwe parents: 3922 diff changeset	50 else
11436 e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 11149 diff changeset	51 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	52 \|\| !(1 <= dim && dim <= nd))
10669 cab3b148d4e4 Improve validation of input arguments for base statistics functions. Rik <octave@nomad.inbox5.com> parents: 10650 diff changeset	53 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	54 endif
3200 781c930425fd [project @ 1998-10-29 05:23:08 by jwe] jwe parents: diff changeset	55 endif
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3200 diff changeset	56
4886 54b076a24718 [project @ 2004-04-30 04:31:51 by jwe] jwe parents: 4885 diff changeset	57 if (sz(dim) == 1)
14868 5d3a684236b0 maint: Use Octave coding conventions for cuddling parentheses in scripts directory Rik <octave@nomad.inbox5.com> parents: 14363 diff changeset	58 y = ones (sz);
4885 28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe] jwe parents: 3922 diff changeset	59 else
8507 cadc73247d65 style fixes John W. Eaton <jwe@octave.org> parents: 8035 diff changeset	60 ## 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	61 if (dim != 1)
28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe] jwe parents: 3922 diff changeset	62 perm = [1 : nd];
4886 54b076a24718 [project @ 2004-04-30 04:31:51 by jwe] jwe parents: 4885 diff changeset	63 perm(1) = dim;
54b076a24718 [project @ 2004-04-30 04:31:51 by jwe] jwe parents: 4885 diff changeset	64 perm(dim) = 1;
4885 28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe] jwe parents: 3922 diff changeset	65 x = permute (x, perm);
28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe] jwe parents: 3922 diff changeset	66 endif
4886 54b076a24718 [project @ 2004-04-30 04:31:51 by jwe] jwe parents: 4885 diff changeset	67 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	68 infvec = -Inf ([1, sz(2 : end)]);
4942 a0f2839f6ac8 [project @ 2004-08-28 01:29:39 by jwe] jwe parents: 4886 diff changeset	69 [xs, xi] = sort (x);
4885 28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe] jwe parents: 3922 diff changeset	70 eq_el = find (diff ([xs; infvec]) == 0);
28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe] jwe parents: 3922 diff changeset	71 if (isempty (eq_el))
4942 a0f2839f6ac8 [project @ 2004-08-28 01:29:39 by jwe] jwe parents: 4886 diff changeset	72 [eq_el, y] = sort (xi);
4885 28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe] jwe parents: 3922 diff changeset	73 else
10650 f0dc41c824ce Replace calls to deprecated functions. Rik <octave@nomad.inbox5.com> parents: 10549 diff changeset	74 runs = setdiff (eq_el, eq_el+1);
4885 28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe] jwe parents: 3922 diff changeset	75 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	76 [eq_el, y] = sort (xi);
14868 5d3a684236b0 maint: Use Octave coding conventions for cuddling parentheses in scripts directory Rik <octave@nomad.inbox5.com> parents: 14363 diff changeset	77 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	78 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	79 * 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	80 endfor
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	81 endif
4885 28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe] jwe parents: 3922 diff changeset	82 if (dim != 1)
28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe] jwe parents: 3922 diff changeset	83 y = permute (y, perm);
28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe] jwe parents: 3922 diff changeset	84 endif
3200 781c930425fd [project @ 1998-10-29 05:23:08 by jwe] jwe parents: diff changeset	85 endif
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3200 diff changeset	86
3200 781c930425fd [project @ 1998-10-29 05:23:08 by jwe] jwe parents: diff changeset	87 endfunction
11436 e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 11149 diff changeset	88
e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 11149 diff changeset	89
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	90 %!assert (ranks (1:2:10), 1:5)
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	91 %!assert (ranks (10:-2:1), 5:-1:1)
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	92 %!assert (ranks ([2, 1, 2, 4]), [2.5, 1, 2.5, 4])
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	93 %!assert (ranks (ones (1, 5)), 3*ones (1, 5))
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	94 %!assert (ranks (1e6ones (1, 5)), 3ones (1, 5))
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	95 %!assert (ranks (rand (1, 5), 1), ones (1, 5))
11436 e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 11149 diff changeset	96
19833 9fc020886ae9 maint: Clean up m-files to follow Octave coding conventions. Rik <rik@octave.org> parents: 19697 diff changeset	97 ## Test input validation
11436 e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 11149 diff changeset	98 %!error ranks ()
e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 11149 diff changeset	99 %!error ranks (1, 2, 3)
e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 11149 diff changeset	100 %!error ranks ({1, 2})
12656 6b2f14af2360 Overhaul functions in statistics/base directory. Rik <octave@nomad.inbox5.com> parents: 12575 diff changeset	101 %!error ranks (['A'; 'B'])
11436 e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 11149 diff changeset	102 %!error ranks (1, 1.5)
e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 11149 diff changeset	103 %!error ranks (1, 0)
e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 11149 diff changeset	104 %!error ranks (1, 3)

Mercurial > octave

annotate scripts/statistics/ranks.m @ 25054:6652d3823428 stable