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

annotate scripts/statistics/base/mode.m @ 9069:634274aaa183

Cleanup documentation for stats.texi Grammarcheck input .txi files Spellcheck .texi files

author	Rik <rdrider0-list@yahoo.com>
date	Sun, 29 Mar 2009 09:24:44 -0700
parents	1bf0ce0930be
children	16f53d29049f

rev	line source
8920 eb63fbe60fab update copyright notices John W. Eaton <jwe@octave.org> parents: 7606 diff changeset	1 ## Copyright (C) 2007, 2008 David Bateman
6863 3c64128e621c [project @ 2007-09-05 07:52:48 by dbateman] dbateman parents: diff changeset	2 ##
3c64128e621c [project @ 2007-09-05 07:52:48 by dbateman] dbateman parents: diff changeset	3 ## This file is part of Octave.
3c64128e621c [project @ 2007-09-05 07:52:48 by dbateman] dbateman parents: diff changeset	4 ##
3c64128e621c [project @ 2007-09-05 07:52:48 by dbateman] dbateman parents: diff changeset	5 ## Octave is free software; you can redistribute it and/or modify it
3c64128e621c [project @ 2007-09-05 07:52:48 by dbateman] dbateman parents: 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: 7007 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: 7007 diff changeset	8 ## your option) any later version.
6863 3c64128e621c [project @ 2007-09-05 07:52:48 by dbateman] dbateman parents: diff changeset	9 ##
3c64128e621c [project @ 2007-09-05 07:52:48 by dbateman] dbateman parents: diff changeset	10 ## Octave is distributed in the hope that it will be useful, but
3c64128e621c [project @ 2007-09-05 07:52:48 by dbateman] dbateman parents: diff changeset	11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
3c64128e621c [project @ 2007-09-05 07:52:48 by dbateman] dbateman parents: diff changeset	12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
3c64128e621c [project @ 2007-09-05 07:52:48 by dbateman] dbateman parents: diff changeset	13 ## General Public License for more details.
3c64128e621c [project @ 2007-09-05 07:52:48 by dbateman] dbateman parents: diff changeset	14 ##
3c64128e621c [project @ 2007-09-05 07:52:48 by dbateman] dbateman 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: 7007 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: 7007 diff changeset	17 ## <http://www.gnu.org/licenses/>.
6863 3c64128e621c [project @ 2007-09-05 07:52:48 by dbateman] dbateman parents: diff changeset	18
3c64128e621c [project @ 2007-09-05 07:52:48 by dbateman] dbateman parents: diff changeset	19 ## -- texinfo --
3c64128e621c [project @ 2007-09-05 07:52:48 by dbateman] dbateman parents: diff changeset	20 ## @deftypefn {Function File} {[@var{m}, @var{f}, @var{c}] =} mode (@var{x}, @var{dim})
9051 1bf0ce0930be Grammar check TexInfo in all .m files Rik <rdrider0-list@yahoo.com> parents: 8920 diff changeset	21 ## Count the most frequently appearing value. @code{mode} counts the
6863 3c64128e621c [project @ 2007-09-05 07:52:48 by dbateman] dbateman parents: diff changeset	22 ## frequency along the first non-singleton dimension and if two or more
9069 634274aaa183 Cleanup documentation for stats.texi Rik <rdrider0-list@yahoo.com> parents: 9051 diff changeset	23 ## values have the same frequency returns the smallest of the two in
9051 1bf0ce0930be Grammar check TexInfo in all .m files Rik <rdrider0-list@yahoo.com> parents: 8920 diff changeset	24 ## @var{m}. The dimension along which to count can be specified by the
6863 3c64128e621c [project @ 2007-09-05 07:52:48 by dbateman] dbateman parents: diff changeset	25 ## @var{dim} parameter.
3c64128e621c [project @ 2007-09-05 07:52:48 by dbateman] dbateman parents: diff changeset	26 ##
3c64128e621c [project @ 2007-09-05 07:52:48 by dbateman] dbateman parents: diff changeset	27 ## The variable @var{f} counts the frequency of each of the most frequently
9051 1bf0ce0930be Grammar check TexInfo in all .m files Rik <rdrider0-list@yahoo.com> parents: 8920 diff changeset	28 ## occurring elements. The cell array @var{c} contains all of the elements
6863 3c64128e621c [project @ 2007-09-05 07:52:48 by dbateman] dbateman parents: diff changeset	29 ## with the maximum frequency .
3c64128e621c [project @ 2007-09-05 07:52:48 by dbateman] dbateman parents: diff changeset	30 ## @end deftypefn
3c64128e621c [project @ 2007-09-05 07:52:48 by dbateman] dbateman parents: diff changeset	31
3c64128e621c [project @ 2007-09-05 07:52:48 by dbateman] dbateman parents: diff changeset	32 function [m, f, c] = mode (x, dim)
3c64128e621c [project @ 2007-09-05 07:52:48 by dbateman] dbateman parents: diff changeset	33
3c64128e621c [project @ 2007-09-05 07:52:48 by dbateman] dbateman parents: diff changeset	34 if (nargin < 1 \|\| nargin > 2)
3c64128e621c [project @ 2007-09-05 07:52:48 by dbateman] dbateman parents: diff changeset	35 print_usage ();
3c64128e621c [project @ 2007-09-05 07:52:48 by dbateman] dbateman parents: diff changeset	36 endif
3c64128e621c [project @ 2007-09-05 07:52:48 by dbateman] dbateman parents: diff changeset	37
3c64128e621c [project @ 2007-09-05 07:52:48 by dbateman] dbateman parents: diff changeset	38 nd = ndims (x);
3c64128e621c [project @ 2007-09-05 07:52:48 by dbateman] dbateman parents: diff changeset	39 sz = size (x);
3c64128e621c [project @ 2007-09-05 07:52:48 by dbateman] dbateman parents: diff changeset	40
3c64128e621c [project @ 2007-09-05 07:52:48 by dbateman] dbateman parents: diff changeset	41 if (nargin != 2)
3c64128e621c [project @ 2007-09-05 07:52:48 by dbateman] dbateman parents: diff changeset	42 ## Find the first non-singleton dimension.
3c64128e621c [project @ 2007-09-05 07:52:48 by dbateman] dbateman parents: diff changeset	43 dim = 1;
3c64128e621c [project @ 2007-09-05 07:52:48 by dbateman] dbateman parents: diff changeset	44 while (dim < nd + 1 && sz(dim) == 1)
3c64128e621c [project @ 2007-09-05 07:52:48 by dbateman] dbateman parents: diff changeset	45 dim = dim + 1;
3c64128e621c [project @ 2007-09-05 07:52:48 by dbateman] dbateman parents: diff changeset	46 endwhile
3c64128e621c [project @ 2007-09-05 07:52:48 by dbateman] dbateman parents: diff changeset	47 if (dim > nd)
3c64128e621c [project @ 2007-09-05 07:52:48 by dbateman] dbateman parents: diff changeset	48 dim = 1;
3c64128e621c [project @ 2007-09-05 07:52:48 by dbateman] dbateman parents: diff changeset	49 endif
3c64128e621c [project @ 2007-09-05 07:52:48 by dbateman] dbateman parents: diff changeset	50 else
3c64128e621c [project @ 2007-09-05 07:52:48 by dbateman] dbateman parents: diff changeset	51 if (! (isscalar (dim) && dim == round (dim))
3c64128e621c [project @ 2007-09-05 07:52:48 by dbateman] dbateman parents: diff changeset	52 && dim > 0
3c64128e621c [project @ 2007-09-05 07:52:48 by dbateman] dbateman parents: diff changeset	53 && dim < (nd + 1))
3c64128e621c [project @ 2007-09-05 07:52:48 by dbateman] dbateman parents: diff changeset	54 error ("mode: dim must be an integer and valid dimension");
3c64128e621c [project @ 2007-09-05 07:52:48 by dbateman] dbateman parents: diff changeset	55 endif
3c64128e621c [project @ 2007-09-05 07:52:48 by dbateman] dbateman parents: diff changeset	56 endif
3c64128e621c [project @ 2007-09-05 07:52:48 by dbateman] dbateman parents: diff changeset	57
3c64128e621c [project @ 2007-09-05 07:52:48 by dbateman] dbateman parents: diff changeset	58 sz2 = sz;
3c64128e621c [project @ 2007-09-05 07:52:48 by dbateman] dbateman parents: diff changeset	59 sz2 (dim) = 1;
3c64128e621c [project @ 2007-09-05 07:52:48 by dbateman] dbateman parents: diff changeset	60 sz3 = ones (1, nd);
3c64128e621c [project @ 2007-09-05 07:52:48 by dbateman] dbateman parents: diff changeset	61 sz3 (dim) = sz (dim);
3c64128e621c [project @ 2007-09-05 07:52:48 by dbateman] dbateman parents: diff changeset	62
7606 704b7a1098d0 Fix for mode.m NDArrays and row vectors David Bateman <dbateman@free.fr> parents: 7287 diff changeset	63 if (issparse (x))
704b7a1098d0 Fix for mode.m NDArrays and row vectors David Bateman <dbateman@free.fr> parents: 7287 diff changeset	64 t2 = sparse (sz(1), sz(2));
704b7a1098d0 Fix for mode.m NDArrays and row vectors David Bateman <dbateman@free.fr> parents: 7287 diff changeset	65 else
704b7a1098d0 Fix for mode.m NDArrays and row vectors David Bateman <dbateman@free.fr> parents: 7287 diff changeset	66 t2 = zeros (sz);
704b7a1098d0 Fix for mode.m NDArrays and row vectors David Bateman <dbateman@free.fr> parents: 7287 diff changeset	67 endif
704b7a1098d0 Fix for mode.m NDArrays and row vectors David Bateman <dbateman@free.fr> parents: 7287 diff changeset	68
6863 3c64128e621c [project @ 2007-09-05 07:52:48 by dbateman] dbateman parents: diff changeset	69 if (dim != 1)
7606 704b7a1098d0 Fix for mode.m NDArrays and row vectors David Bateman <dbateman@free.fr> parents: 7287 diff changeset	70 perm = [dim, 1:dim-1, dim+1:nd];
704b7a1098d0 Fix for mode.m NDArrays and row vectors David Bateman <dbateman@free.fr> parents: 7287 diff changeset	71 t2 = permute (t2, perm);
6863 3c64128e621c [project @ 2007-09-05 07:52:48 by dbateman] dbateman parents: diff changeset	72 endif
3c64128e621c [project @ 2007-09-05 07:52:48 by dbateman] dbateman parents: diff changeset	73
3c64128e621c [project @ 2007-09-05 07:52:48 by dbateman] dbateman parents: diff changeset	74 xs = sort (x, dim);
3c64128e621c [project @ 2007-09-05 07:52:48 by dbateman] dbateman parents: diff changeset	75 t = cat (dim, true (sz2), diff (xs, 1, dim) != 0);
3c64128e621c [project @ 2007-09-05 07:52:48 by dbateman] dbateman parents: diff changeset	76
3c64128e621c [project @ 2007-09-05 07:52:48 by dbateman] dbateman parents: diff changeset	77 if (dim != 1)
7606 704b7a1098d0 Fix for mode.m NDArrays and row vectors David Bateman <dbateman@free.fr> parents: 7287 diff changeset	78 t2 (permute (t != 0, perm)) = diff ([find(permute (t, perm))(:); prod(sz)+1]);
6863 3c64128e621c [project @ 2007-09-05 07:52:48 by dbateman] dbateman parents: diff changeset	79 f = max (ipermute (t2, perm), [], dim);
3c64128e621c [project @ 2007-09-05 07:52:48 by dbateman] dbateman parents: diff changeset	80 xs = permute (xs, perm);
3c64128e621c [project @ 2007-09-05 07:52:48 by dbateman] dbateman parents: diff changeset	81 else
7606 704b7a1098d0 Fix for mode.m NDArrays and row vectors David Bateman <dbateman@free.fr> parents: 7287 diff changeset	82 t2 (t) = diff ([find(t)(:); prod(sz)+1]);
6863 3c64128e621c [project @ 2007-09-05 07:52:48 by dbateman] dbateman parents: diff changeset	83 f = max (t2, [], dim);
3c64128e621c [project @ 2007-09-05 07:52:48 by dbateman] dbateman parents: diff changeset	84 endif
3c64128e621c [project @ 2007-09-05 07:52:48 by dbateman] dbateman parents: diff changeset	85
3c64128e621c [project @ 2007-09-05 07:52:48 by dbateman] dbateman parents: diff changeset	86 c = cell (sz2);
7287 3f29467c1667 [project @ 2007-12-11 17:03:32 by jwe] jwe parents: 7208 diff changeset	87 if (issparse (x))
3f29467c1667 [project @ 2007-12-11 17:03:32 by jwe] jwe parents: 7208 diff changeset	88 m = sparse (sz2(1), sz2(2));
3f29467c1667 [project @ 2007-12-11 17:03:32 by jwe] jwe parents: 7208 diff changeset	89 else
3f29467c1667 [project @ 2007-12-11 17:03:32 by jwe] jwe parents: 7208 diff changeset	90 m = zeros (sz2);
3f29467c1667 [project @ 2007-12-11 17:03:32 by jwe] jwe parents: 7208 diff changeset	91 endif
6863 3c64128e621c [project @ 2007-09-05 07:52:48 by dbateman] dbateman parents: diff changeset	92 for i = 1 : prod (sz2)
7208 a730e47fda4d [project @ 2007-11-28 02:32:41 by jwe] jwe parents: 7197 diff changeset	93 c{i} = xs (t2 (:, i) == f(i), i);
6863 3c64128e621c [project @ 2007-09-05 07:52:48 by dbateman] dbateman parents: diff changeset	94 m (i) = c{i}(1);
3c64128e621c [project @ 2007-09-05 07:52:48 by dbateman] dbateman parents: diff changeset	95 endfor
3c64128e621c [project @ 2007-09-05 07:52:48 by dbateman] dbateman parents: diff changeset	96 endfunction
3c64128e621c [project @ 2007-09-05 07:52:48 by dbateman] dbateman parents: diff changeset	97
3c64128e621c [project @ 2007-09-05 07:52:48 by dbateman] dbateman parents: diff changeset	98 %!test
3c64128e621c [project @ 2007-09-05 07:52:48 by dbateman] dbateman parents: diff changeset	99 %! [m, f, c] = mode (toeplitz (1:5));
3c64128e621c [project @ 2007-09-05 07:52:48 by dbateman] dbateman parents: diff changeset	100 %! assert (m, [1,2,2,2,1]);
3c64128e621c [project @ 2007-09-05 07:52:48 by dbateman] dbateman parents: diff changeset	101 %! assert (f, [1,2,2,2,1]);
3c64128e621c [project @ 2007-09-05 07:52:48 by dbateman] dbateman parents: diff changeset	102 %! assert (c, {[1;2;3;4;5],[2],[2;3],[2],[1;2;3;4;5]});
3c64128e621c [project @ 2007-09-05 07:52:48 by dbateman] dbateman parents: diff changeset	103 %!test
3c64128e621c [project @ 2007-09-05 07:52:48 by dbateman] dbateman parents: diff changeset	104 %! [m, f, c] = mode (toeplitz (1:5), 2);
3c64128e621c [project @ 2007-09-05 07:52:48 by dbateman] dbateman parents: diff changeset	105 %! assert (m, [1;2;2;2;1]);
3c64128e621c [project @ 2007-09-05 07:52:48 by dbateman] dbateman parents: diff changeset	106 %! assert (f, [1;2;2;2;1]);
3c64128e621c [project @ 2007-09-05 07:52:48 by dbateman] dbateman parents: diff changeset	107 %! assert (c, {[1;2;3;4;5];[2];[2;3];[2];[1;2;3;4;5]});
3c64128e621c [project @ 2007-09-05 07:52:48 by dbateman] dbateman parents: diff changeset	108 %!test
3c64128e621c [project @ 2007-09-05 07:52:48 by dbateman] dbateman parents: diff changeset	109 %! a = sprandn (32, 32, 0.05);
3c64128e621c [project @ 2007-09-05 07:52:48 by dbateman] dbateman parents: diff changeset	110 %! [m, f, c] = mode (a);
3c64128e621c [project @ 2007-09-05 07:52:48 by dbateman] dbateman parents: diff changeset	111 %! [m2, f2, c2] = mode (full (a));
7287 3f29467c1667 [project @ 2007-12-11 17:03:32 by jwe] jwe parents: 7208 diff changeset	112 %! assert (m, sparse (m2));
3f29467c1667 [project @ 2007-12-11 17:03:32 by jwe] jwe parents: 7208 diff changeset	113 %! assert (f, sparse (f2));
3f29467c1667 [project @ 2007-12-11 17:03:32 by jwe] jwe parents: 7208 diff changeset	114 %! assert (c, cellfun (@(x) sparse (0), c2, 'UniformOutput', false));
7606 704b7a1098d0 Fix for mode.m NDArrays and row vectors David Bateman <dbateman@free.fr> parents: 7287 diff changeset	115
704b7a1098d0 Fix for mode.m NDArrays and row vectors David Bateman <dbateman@free.fr> parents: 7287 diff changeset	116 %!assert(mode([2,3,1,2,3,4],1),[2,3,1,2,3,4])
704b7a1098d0 Fix for mode.m NDArrays and row vectors David Bateman <dbateman@free.fr> parents: 7287 diff changeset	117 %!assert(mode([2,3,1,2,3,4],2),2)
704b7a1098d0 Fix for mode.m NDArrays and row vectors David Bateman <dbateman@free.fr> parents: 7287 diff changeset	118 %!assert(mode([2,3,1,2,3,4]),2)
704b7a1098d0 Fix for mode.m NDArrays and row vectors David Bateman <dbateman@free.fr> parents: 7287 diff changeset	119
704b7a1098d0 Fix for mode.m NDArrays and row vectors David Bateman <dbateman@free.fr> parents: 7287 diff changeset	120 %!assert(mode([2;3;1;2;3;4],1),2)
704b7a1098d0 Fix for mode.m NDArrays and row vectors David Bateman <dbateman@free.fr> parents: 7287 diff changeset	121 %!assert(mode([2;3;1;2;3;4],2),[2;3;1;2;3;4])
704b7a1098d0 Fix for mode.m NDArrays and row vectors David Bateman <dbateman@free.fr> parents: 7287 diff changeset	122 %!assert(mode([2;3;1;2;3;4]),2)
704b7a1098d0 Fix for mode.m NDArrays and row vectors David Bateman <dbateman@free.fr> parents: 7287 diff changeset	123
704b7a1098d0 Fix for mode.m NDArrays and row vectors David Bateman <dbateman@free.fr> parents: 7287 diff changeset	124 %!shared x
704b7a1098d0 Fix for mode.m NDArrays and row vectors David Bateman <dbateman@free.fr> parents: 7287 diff changeset	125 %! x(:,:,1) = toeplitz (1:3);
704b7a1098d0 Fix for mode.m NDArrays and row vectors David Bateman <dbateman@free.fr> parents: 7287 diff changeset	126 %! x(:,:,2) = circshift (toeplitz (1:3), 1);
704b7a1098d0 Fix for mode.m NDArrays and row vectors David Bateman <dbateman@free.fr> parents: 7287 diff changeset	127 %! x(:,:,3) = circshift (toeplitz (1:3), 2);
704b7a1098d0 Fix for mode.m NDArrays and row vectors David Bateman <dbateman@free.fr> parents: 7287 diff changeset	128 %!test
704b7a1098d0 Fix for mode.m NDArrays and row vectors David Bateman <dbateman@free.fr> parents: 7287 diff changeset	129 %! [m, f, c] = mode (x, 1);
704b7a1098d0 Fix for mode.m NDArrays and row vectors David Bateman <dbateman@free.fr> parents: 7287 diff changeset	130 %! assert (reshape (m, [3, 3]), [1 1 1; 2 2 2; 1 1 1])
704b7a1098d0 Fix for mode.m NDArrays and row vectors David Bateman <dbateman@free.fr> parents: 7287 diff changeset	131 %! assert (reshape (f, [3, 3]), [1 1 1; 2 2 2; 1 1 1])
704b7a1098d0 Fix for mode.m NDArrays and row vectors David Bateman <dbateman@free.fr> parents: 7287 diff changeset	132 %! c = reshape (c, [3, 3]);
704b7a1098d0 Fix for mode.m NDArrays and row vectors David Bateman <dbateman@free.fr> parents: 7287 diff changeset	133 %! assert (c{1}, [1; 2; 3])
704b7a1098d0 Fix for mode.m NDArrays and row vectors David Bateman <dbateman@free.fr> parents: 7287 diff changeset	134 %! assert (c{2}, 2)
704b7a1098d0 Fix for mode.m NDArrays and row vectors David Bateman <dbateman@free.fr> parents: 7287 diff changeset	135 %! assert (c{3}, [1; 2; 3])
704b7a1098d0 Fix for mode.m NDArrays and row vectors David Bateman <dbateman@free.fr> parents: 7287 diff changeset	136 %!test
704b7a1098d0 Fix for mode.m NDArrays and row vectors David Bateman <dbateman@free.fr> parents: 7287 diff changeset	137 %! [m, f, c] = mode (x, 2);
704b7a1098d0 Fix for mode.m NDArrays and row vectors David Bateman <dbateman@free.fr> parents: 7287 diff changeset	138 %! assert (reshape (m, [3, 3]), [1 1 2; 2 1 1; 1 2 1])
704b7a1098d0 Fix for mode.m NDArrays and row vectors David Bateman <dbateman@free.fr> parents: 7287 diff changeset	139 %! assert (reshape (f, [3, 3]), [1 1 2; 2 1 1; 1 2 1])
704b7a1098d0 Fix for mode.m NDArrays and row vectors David Bateman <dbateman@free.fr> parents: 7287 diff changeset	140 %! c = reshape (c, [3, 3]);
704b7a1098d0 Fix for mode.m NDArrays and row vectors David Bateman <dbateman@free.fr> parents: 7287 diff changeset	141 %! assert (c{1}, [1; 2; 3])
704b7a1098d0 Fix for mode.m NDArrays and row vectors David Bateman <dbateman@free.fr> parents: 7287 diff changeset	142 %! assert (c{2}, 2)
704b7a1098d0 Fix for mode.m NDArrays and row vectors David Bateman <dbateman@free.fr> parents: 7287 diff changeset	143 %! assert (c{3}, [1; 2; 3])
704b7a1098d0 Fix for mode.m NDArrays and row vectors David Bateman <dbateman@free.fr> parents: 7287 diff changeset	144 %!test
704b7a1098d0 Fix for mode.m NDArrays and row vectors David Bateman <dbateman@free.fr> parents: 7287 diff changeset	145 %! [m, f, c] = mode (x, 3);
704b7a1098d0 Fix for mode.m NDArrays and row vectors David Bateman <dbateman@free.fr> parents: 7287 diff changeset	146 %! assert (reshape (m, [3, 3]), [1 2 1; 1 2 1; 1 2 1])
704b7a1098d0 Fix for mode.m NDArrays and row vectors David Bateman <dbateman@free.fr> parents: 7287 diff changeset	147 %! assert (reshape (f, [3, 3]), [1 2 1; 1 2 1; 1 2 1])
704b7a1098d0 Fix for mode.m NDArrays and row vectors David Bateman <dbateman@free.fr> parents: 7287 diff changeset	148 %! c = reshape (c, [3, 3]);
704b7a1098d0 Fix for mode.m NDArrays and row vectors David Bateman <dbateman@free.fr> parents: 7287 diff changeset	149 %! assert (c{1}, [1; 2; 3])
704b7a1098d0 Fix for mode.m NDArrays and row vectors David Bateman <dbateman@free.fr> parents: 7287 diff changeset	150 %! assert (c{2}, [1; 2; 3])
704b7a1098d0 Fix for mode.m NDArrays and row vectors David Bateman <dbateman@free.fr> parents: 7287 diff changeset	151 %! assert (c{3}, [1; 2; 3])

Mercurial > octave-nkf

annotate scripts/statistics/base/mode.m @ 9069:634274aaa183