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

annotate scripts/statistics/base/studentize.m @ 11436:e151e23f73bc

Overhaul base statistics functions and documentation of same. Add or improve input validation. Add input validation tests. Add functional tests. Improve or re-write documentation strings.

author	Rik <octave@nomad.inbox5.com>
date	Mon, 03 Jan 2011 21:23:08 -0800
parents	fe3c3dfc07eb
children	fd0a3ac60b0e

rev	line source
7017 a1dbe9d80eee [project @ 2007-10-12 21:27:11 by jwe] jwe parents: 7016 diff changeset	1 ## Copyright (C) 1995, 1996, 1997, 1998, 1999, 2000, 2002, 2004, 2005,
9245 16f53d29049f update copyright notices John W. Eaton <jwe@octave.org> parents: 9051 diff changeset	2 ## 2006, 2007, 2009 Kurt Hornik
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3388 diff changeset	3 ##
3922 38c61cbf086c [project @ 2002-05-01 06:48:35 by jwe] jwe parents: 3458 diff changeset	4 ## This file is part of Octave.
38c61cbf086c [project @ 2002-05-01 06:48:35 by jwe] jwe parents: 3458 diff changeset	5 ##
38c61cbf086c [project @ 2002-05-01 06:48:35 by jwe] jwe parents: 3458 diff changeset	6 ## Octave is free software; you can redistribute it and/or modify it
38c61cbf086c [project @ 2002-05-01 06:48:35 by jwe] jwe parents: 3458 diff changeset	7 ## 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	8 ## 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	9 ## your option) any later version.
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3388 diff changeset	10 ##
3922 38c61cbf086c [project @ 2002-05-01 06:48:35 by jwe] jwe parents: 3458 diff changeset	11 ## 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	12 ## WITHOUT ANY WARRANTY; without even the implied warranty of
781c930425fd [project @ 1998-10-29 05:23:08 by jwe] jwe parents: diff changeset	13 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3388 diff changeset	14 ## General Public License for more details.
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3388 diff changeset	15 ##
3200 781c930425fd [project @ 1998-10-29 05:23:08 by jwe] jwe parents: diff changeset	16 ## 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	17 ## 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	18 ## <http://www.gnu.org/licenses/>.
3200 781c930425fd [project @ 1998-10-29 05:23:08 by jwe] jwe parents: diff changeset	19
3453 71d2e09c15a2 [project @ 2000-01-18 08:32:09 by jwe] jwe parents: 3426 diff changeset	20 ## -- texinfo --
11436 e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 11149 diff changeset	21 ## @deftypefn {Function File} {} studentize (@var{x})
e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 11149 diff changeset	22 ## @deftypefnx {Function File} {} studentize (@var{x}, @var{dim})
3453 71d2e09c15a2 [project @ 2000-01-18 08:32:09 by jwe] jwe parents: 3426 diff changeset	23 ## If @var{x} is a vector, subtract its mean and divide by its standard
3200 781c930425fd [project @ 1998-10-29 05:23:08 by jwe] jwe parents: diff changeset	24 ## deviation.
781c930425fd [project @ 1998-10-29 05:23:08 by jwe] jwe parents: diff changeset	25 ##
4885 28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe] jwe parents: 4030 diff changeset	26 ## If @var{x} is a matrix, do the above along the first non-singleton
11436 e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 11149 diff changeset	27 ## dimension.
e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 11149 diff changeset	28 ## 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	29 ## @seealso{center}
3453 71d2e09c15a2 [project @ 2000-01-18 08:32:09 by jwe] jwe parents: 3426 diff changeset	30 ## @end deftypefn
3200 781c930425fd [project @ 1998-10-29 05:23:08 by jwe] jwe parents: diff changeset	31
5428 2a16423e4aa0 [project @ 2005-08-23 18:38:27 by jwe] jwe parents: 5307 diff changeset	32 ## Author: KH <Kurt.Hornik@wu-wien.ac.at>
3456 434790acb067 [project @ 2000-01-19 06:58:51 by jwe] jwe parents: 3453 diff changeset	33 ## Description: Subtract mean and divide by standard deviation
3200 781c930425fd [project @ 1998-10-29 05:23:08 by jwe] jwe parents: diff changeset	34
4885 28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe] jwe parents: 4030 diff changeset	35 function t = studentize (x, dim)
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3388 diff changeset	36
4885 28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe] jwe parents: 4030 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 ();
3200 781c930425fd [project @ 1998-10-29 05:23:08 by jwe] jwe parents: diff changeset	39 endif
781c930425fd [project @ 1998-10-29 05:23:08 by jwe] jwe parents: diff changeset	40
11436 e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 11149 diff changeset	41 if (! isnumeric(x))
e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 11149 diff changeset	42 error ("studentize: X must be a numeric vector or matrix");
e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 11149 diff changeset	43 endif
e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 11149 diff changeset	44
e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 11149 diff changeset	45 if (isinteger (x))
e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 11149 diff changeset	46 x = double (x);
10669 cab3b148d4e4 Improve validation of input arguments for base statistics functions. Rik <octave@nomad.inbox5.com> parents: 10549 diff changeset	47 endif
cab3b148d4e4 Improve validation of input arguments for base statistics functions. Rik <octave@nomad.inbox5.com> parents: 10549 diff changeset	48
4885 28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe] jwe parents: 4030 diff changeset	49 nd = ndims (x);
28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe] jwe parents: 4030 diff changeset	50 sz = size (x);
28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe] jwe parents: 4030 diff changeset	51 if (nargin != 2)
4886 54b076a24718 [project @ 2004-04-30 04:31:51 by jwe] jwe parents: 4885 diff changeset	52 ## Find the first non-singleton dimension.
10669 cab3b148d4e4 Improve validation of input arguments for base statistics functions. Rik <octave@nomad.inbox5.com> parents: 10549 diff changeset	53 dim = find (sz > 1, 1);
cab3b148d4e4 Improve validation of input arguments for base statistics functions. Rik <octave@nomad.inbox5.com> parents: 10549 diff changeset	54 if (isempty (dim))
4885 28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe] jwe parents: 4030 diff changeset	55 dim = 1;
3200 781c930425fd [project @ 1998-10-29 05:23:08 by jwe] jwe parents: diff changeset	56 endif
781c930425fd [project @ 1998-10-29 05:23:08 by jwe] jwe parents: diff changeset	57 else
11436 e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 11149 diff changeset	58 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	59 \|\| !(1 <= dim && dim <= nd))
10669 cab3b148d4e4 Improve validation of input arguments for base statistics functions. Rik <octave@nomad.inbox5.com> parents: 10549 diff changeset	60 error ("studentize: DIM must be an integer and a valid dimension");
4885 28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe] jwe parents: 4030 diff changeset	61 endif
28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe] jwe parents: 4030 diff changeset	62 endif
28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe] jwe parents: 4030 diff changeset	63
4886 54b076a24718 [project @ 2004-04-30 04:31:51 by jwe] jwe parents: 4885 diff changeset	64 c = sz(dim);
11436 e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 11149 diff changeset	65 if (c == 0)
e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 11149 diff changeset	66 t = x;
e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 11149 diff changeset	67 else
e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 11149 diff changeset	68 idx = ones (1, nd);
e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 11149 diff changeset	69 idx(dim) = c;
e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 11149 diff changeset	70 t = x - repmat (mean (x, dim), idx);
e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 11149 diff changeset	71 t = t ./ repmat (max (cat (dim, std(t, [], dim), ! any (t, dim)), [], dim), idx);
e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 11149 diff changeset	72 endif
4885 28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe] jwe parents: 4030 diff changeset	73
28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe] jwe parents: 4030 diff changeset	74 endfunction
11436 e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 11149 diff changeset	75
e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 11149 diff changeset	76 %!assert(studentize ([1,2,3]), [-1,0,1])
e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 11149 diff changeset	77 %!assert(studentize (int8 ([1,2,3])), [-1,0,1])
e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 11149 diff changeset	78 #%!assert(studentize (ones (3,2,0,2)), zeros (3,2,0,2))
e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 11149 diff changeset	79 %!assert(studentize ([2,0,-2;0,2,0;-2,-2,2]), [1,0,-1;0,1,0;-1,-1,1])
e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 11149 diff changeset	80
e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 11149 diff changeset	81 %% Test input validation
e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 11149 diff changeset	82 %!error studentize ()
e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 11149 diff changeset	83 %!error studentize (1, 2, 3)
e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 11149 diff changeset	84 %!error studentize ([true true])
e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 11149 diff changeset	85 %!error studentize (1, ones(2,2))
e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 11149 diff changeset	86 %!error studentize (1, 1.5)
e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 11149 diff changeset	87 %!error studentize (1, 0)
e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 11149 diff changeset	88 %!error studentize (1, 3)
e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 11149 diff changeset	89

Mercurial > hg > octave-nkf

annotate scripts/statistics/base/studentize.m @ 11436:e151e23f73bc