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

annotate scripts/statistics/base/center.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	be55736a0783
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, 2000, 2002, 2004, 2005, 2006,
8920 eb63fbe60fab update copyright notices John W. Eaton <jwe@octave.org> parents: 8507 diff changeset	2 ## 2007, 2009 Kurt Hornik
9744 fb3543975ed9 optimize center using bsxfun Jaroslav Hajek <highegg@gmail.com> parents: 8977 diff changeset	3 ## Copyright (C) 2009 VZLU Prague
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3200 diff changeset	4 ##
3922 38c61cbf086c [project @ 2002-05-01 06:48:35 by jwe] jwe parents: 3876 diff changeset	5 ## This file is part of Octave.
38c61cbf086c [project @ 2002-05-01 06:48:35 by jwe] jwe parents: 3876 diff changeset	6 ##
38c61cbf086c [project @ 2002-05-01 06:48:35 by jwe] jwe parents: 3876 diff changeset	7 ## Octave is free software; you can redistribute it and/or modify it
38c61cbf086c [project @ 2002-05-01 06:48:35 by jwe] jwe parents: 3876 diff changeset	8 ## 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	9 ## 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	10 ## your option) any later version.
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3200 diff changeset	11 ##
3922 38c61cbf086c [project @ 2002-05-01 06:48:35 by jwe] jwe parents: 3876 diff changeset	12 ## 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	13 ## WITHOUT ANY WARRANTY; without even the implied warranty of
781c930425fd [project @ 1998-10-29 05:23:08 by jwe] jwe parents: diff changeset	14 ## 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	15 ## General Public License for more details.
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3200 diff changeset	16 ##
3200 781c930425fd [project @ 1998-10-29 05:23:08 by jwe] jwe parents: diff changeset	17 ## 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	18 ## 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	19 ## <http://www.gnu.org/licenses/>.
3200 781c930425fd [project @ 1998-10-29 05:23:08 by jwe] jwe parents: diff changeset	20
3453 71d2e09c15a2 [project @ 2000-01-18 08:32:09 by jwe] jwe parents: 3426 diff changeset	21 ## -- texinfo --
10793 be55736a0783 Grammarcheck the documentation from m-files. Rik <octave@nomad.inbox5.com> parents: 10330 diff changeset	22 ## @deftypefn {Function File} {} center (@var{x})
4844 9f7ef92b50b0 [project @ 2004-04-02 17:26:53 by jwe] jwe parents: 4030 diff changeset	23 ## @deftypefnx {Function File} {} center (@var{x}, @var{dim})
3453 71d2e09c15a2 [project @ 2000-01-18 08:32:09 by jwe] jwe parents: 3426 diff changeset	24 ## If @var{x} is a vector, subtract its mean.
71d2e09c15a2 [project @ 2000-01-18 08:32:09 by jwe] jwe parents: 3426 diff changeset	25 ## If @var{x} is a matrix, do the above for each column.
11436 e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 10793 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: 10793 diff changeset	27 ## @seealso{studentize}
3453 71d2e09c15a2 [project @ 2000-01-18 08:32:09 by jwe] jwe parents: 3426 diff changeset	28 ## @end deftypefn
3200 781c930425fd [project @ 1998-10-29 05:23:08 by jwe] jwe parents: diff changeset	29
5428 2a16423e4aa0 [project @ 2005-08-23 18:38:27 by jwe] jwe parents: 5307 diff changeset	30 ## Author: KH <Kurt.Hornik@wu-wien.ac.at>
3456 434790acb067 [project @ 2000-01-19 06:58:51 by jwe] jwe parents: 3453 diff changeset	31 ## Description: Center by subtracting means
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3200 diff changeset	32
8977 f464119ec165 further simplify some stats funcs Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	33 function retval = center (x, dim)
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3200 diff changeset	34
4844 9f7ef92b50b0 [project @ 2004-04-02 17:26:53 by jwe] jwe parents: 4030 diff changeset	35 if (nargin != 1 && nargin != 2)
6046 34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe] jwe parents: 6024 diff changeset	36 print_usage ();
3200 781c930425fd [project @ 1998-10-29 05:23:08 by jwe] jwe parents: diff changeset	37 endif
781c930425fd [project @ 1998-10-29 05:23:08 by jwe] jwe parents: diff changeset	38
11436 e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	39 if (!isnumeric (x))
e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	40 error ("center: X must be a numeric vector or matrix");
8977 f464119ec165 further simplify some stats funcs Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	41 endif
f464119ec165 further simplify some stats funcs Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	42
10330 e0767a0965f1 fix some stat functions with integers Jaroslav Hajek <highegg@gmail.com> parents: 9744 diff changeset	43 if (isinteger (x))
e0767a0965f1 fix some stat functions with integers Jaroslav Hajek <highegg@gmail.com> parents: 9744 diff changeset	44 x = double (x);
e0767a0965f1 fix some stat functions with integers Jaroslav Hajek <highegg@gmail.com> parents: 9744 diff changeset	45 endif
e0767a0965f1 fix some stat functions with integers Jaroslav Hajek <highegg@gmail.com> parents: 9744 diff changeset	46
11436 e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	47 nd = ndims (x);
e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	48 sz = size (x);
e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	49 if (nargin != 2)
e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	50 ## Find the first non-singleton dimension.
e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	51 dim = find (sz > 1, 1);
e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	52 if (isempty (dim))
e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	53 dim = 1;
e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	54 endif
e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	55 else
e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	56 if (!(isscalar (dim) && dim == fix (dim))
e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	57 \|\| !(1 <= dim && dim <= nd))
e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	58 error ("center: DIM must be an integer and a valid dimension");
e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	59 endif
e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	60 endif
e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	61
e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	62 n = size (x, dim);
e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	63
9744 fb3543975ed9 optimize center using bsxfun Jaroslav Hajek <highegg@gmail.com> parents: 8977 diff changeset	64 if (n == 0)
fb3543975ed9 optimize center using bsxfun Jaroslav Hajek <highegg@gmail.com> parents: 8977 diff changeset	65 retval = x;
8977 f464119ec165 further simplify some stats funcs Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	66 else
9744 fb3543975ed9 optimize center using bsxfun Jaroslav Hajek <highegg@gmail.com> parents: 8977 diff changeset	67 retval = bsxfun (@minus, x, sum (x, dim) / n);
3200 781c930425fd [project @ 1998-10-29 05:23:08 by jwe] jwe parents: diff changeset	68 endif
11436 e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	69
4844 9f7ef92b50b0 [project @ 2004-04-02 17:26:53 by jwe] jwe parents: 4030 diff changeset	70 endfunction
11436 e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	71
e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	72 %!assert(center ([1,2,3]), [-1,0,1])
e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	73 %!assert(center (int8 ([1,2,3])), [-1,0,1])
e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	74 %!assert(center (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: 10793 diff changeset	75 %!assert(center (magic (3)), [3,-4,1;-2,0,2;-1,4,-3])
e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	76
e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	77 %% Test input validation
e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	78 %!error center ()
e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	79 %!error center (1, 2, 3)
e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	80 %!error center ([true true])
e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	81 %!error center (1, ones(2,2))
e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	82 %!error center (1, 1.5)
e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	83 %!error center (1, 0)
e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	84 %!error center (1, 3)

Mercurial > octave-nkf

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