octave: scripts/statistics/center.m annotate

annotate scripts/statistics/center.m @ 33623:4517f929c59d bytecode-interpreter tip

maint: Merge default to bytecode-interpreter

author	Arun Giridhar <arungiridhar@gmail.com>
date	Fri, 24 May 2024 16:22:41 -0400
parents	2e484f9f1f18
children

rev	line source
27923 bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	1 ########################################################################
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	2 ##
32632 2e484f9f1f18 maint: update Octave Project Developers copyright for the new year John W. Eaton <jwe@octave.org> parents: 31706 diff changeset	3 ## Copyright (C) 1995-2024 The Octave Project Developers
27918 b442ec6dda5c use centralized file for copyright info for individual contributors John W. Eaton <jwe@octave.org> parents: 26376 diff changeset	4 ##
27923 bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	5 ## See the file COPYRIGHT.md in the top-level directory of this
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	6 ## distribution or <https://octave.org/copyright/>.
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3200 diff changeset	7 ##
3922 38c61cbf086c [project @ 2002-05-01 06:48:35 by jwe] jwe parents: 3876 diff changeset	8 ## This file is part of Octave.
38c61cbf086c [project @ 2002-05-01 06:48:35 by jwe] jwe parents: 3876 diff changeset	9 ##
24534 194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 23839 diff changeset	10 ## 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: 3876 diff changeset	11 ## 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: 23839 diff changeset	12 ## 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	13 ## (at your option) any later version.
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3200 diff changeset	14 ##
3922 38c61cbf086c [project @ 2002-05-01 06:48:35 by jwe] jwe parents: 3876 diff changeset	15 ## 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	16 ## WITHOUT ANY WARRANTY; without even the implied warranty of
22755 3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22323 diff changeset	17 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22323 diff changeset	18 ## GNU General Public License for more details.
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3200 diff changeset	19 ##
3200 781c930425fd [project @ 1998-10-29 05:23:08 by jwe] jwe parents: diff changeset	20 ## 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	21 ## 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: 23839 diff changeset	22 ## <https://www.gnu.org/licenses/>.
27923 bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	23 ##
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	24 ########################################################################
3200 781c930425fd [project @ 1998-10-29 05:23:08 by jwe] jwe parents: diff changeset	25
3453 71d2e09c15a2 [project @ 2000-01-18 08:32:09 by jwe] jwe parents: 3426 diff changeset	26 ## -- texinfo --
30875 5d3faba0342e doc: Ensure documentation lists output argument when it exists for all m-files. Rik <rik@octave.org> parents: 30564 diff changeset	27 ## @deftypefn {} {@var{y} =} center (@var{x})
5d3faba0342e doc: Ensure documentation lists output argument when it exists for all m-files. Rik <rik@octave.org> parents: 30564 diff changeset	28 ## @deftypefnx {} {@var{y} =} center (@var{x}, @var{dim})
20174 d9341b422488 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	29 ## Center data by subtracting its mean.
d9341b422488 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	30 ##
3453 71d2e09c15a2 [project @ 2000-01-18 08:32:09 by jwe] jwe parents: 3426 diff changeset	31 ## If @var{x} is a vector, subtract its mean.
20174 d9341b422488 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	32 ##
3453 71d2e09c15a2 [project @ 2000-01-18 08:32:09 by jwe] jwe parents: 3426 diff changeset	33 ## If @var{x} is a matrix, do the above for each column.
20174 d9341b422488 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	34 ##
11436 e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	35 ## If the optional argument @var{dim} is given, operate along this dimension.
20174 d9341b422488 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	36 ##
d9341b422488 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	37 ## Programming Note: @code{center} has obvious application for normalizing
d9341b422488 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	38 ## statistical data. It is also useful for improving the precision of general
d9341b422488 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	39 ## numerical calculations. Whenever there is a large value that is common
d9341b422488 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	40 ## to a batch of data, the mean can be subtracted off, the calculation
d9341b422488 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	41 ## performed, and then the mean added back to obtain the final answer.
12586 f9b7aa3b88f8 Deprecate studentize(), replace with zscore(). Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	42 ## @seealso{zscore}
3453 71d2e09c15a2 [project @ 2000-01-18 08:32:09 by jwe] jwe parents: 3426 diff changeset	43 ## @end deftypefn
3200 781c930425fd [project @ 1998-10-29 05:23:08 by jwe] jwe parents: diff changeset	44
30875 5d3faba0342e doc: Ensure documentation lists output argument when it exists for all m-files. Rik <rik@octave.org> parents: 30564 diff changeset	45 function y = center (x, dim)
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3200 diff changeset	46
28891 de5f2f9a64ff maint: Use same coding style when checking for a minimum of 1 input. Rik <rik@octave.org> parents: 28886 diff changeset	47 if (nargin < 1)
6046 34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe] jwe parents: 6024 diff changeset	48 print_usage ();
3200 781c930425fd [project @ 1998-10-29 05:23:08 by jwe] jwe parents: diff changeset	49 endif
781c930425fd [project @ 1998-10-29 05:23:08 by jwe] jwe parents: diff changeset	50
12656 6b2f14af2360 Overhaul functions in statistics/base directory. Rik <octave@nomad.inbox5.com> parents: 12586 diff changeset	51 if (! (isnumeric (x) \|\| islogical (x)))
11436 e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	52 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	53 endif
f464119ec165 further simplify some stats funcs Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	54
10330 e0767a0965f1 fix some stat functions with integers Jaroslav Hajek <highegg@gmail.com> parents: 9744 diff changeset	55 if (isinteger (x))
e0767a0965f1 fix some stat functions with integers Jaroslav Hajek <highegg@gmail.com> parents: 9744 diff changeset	56 x = double (x);
e0767a0965f1 fix some stat functions with integers Jaroslav Hajek <highegg@gmail.com> parents: 9744 diff changeset	57 endif
e0767a0965f1 fix some stat functions with integers Jaroslav Hajek <highegg@gmail.com> parents: 9744 diff changeset	58
11436 e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	59 nd = ndims (x);
e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	60 sz = size (x);
e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	61 if (nargin != 2)
e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	62 ## Find the first non-singleton dimension.
12656 6b2f14af2360 Overhaul functions in statistics/base directory. Rik <octave@nomad.inbox5.com> parents: 12586 diff changeset	63 (dim = find (sz > 1, 1)) \|\| (dim = 1);
11436 e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	64 else
21309 7fbecef105ca Allow statistics functions to work over non-existent dimension (bug #33523). Rik <rik@octave.org> parents: 20852 diff changeset	65 if (! (isscalar (dim) && dim == fix (dim) && dim > 0))
11436 e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	66 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	67 endif
e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	68 endif
e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	69
21309 7fbecef105ca Allow statistics functions to work over non-existent dimension (bug #33523). Rik <rik@octave.org> parents: 20852 diff changeset	70 n = size (x, dim);
11436 e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	71
9744 fb3543975ed9 optimize center using bsxfun Jaroslav Hajek <highegg@gmail.com> parents: 8977 diff changeset	72 if (n == 0)
30875 5d3faba0342e doc: Ensure documentation lists output argument when it exists for all m-files. Rik <rik@octave.org> parents: 30564 diff changeset	73 y = x;
8977 f464119ec165 further simplify some stats funcs Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	74 else
23839 724fe19b50dc center.m: Use bsxfun rather than broadcasting (bug #51249). Rik <rik@octave.org> parents: 23220 diff changeset	75 ## FIXME: Use bsxfun, rather than broadcasting, until broadcasting
724fe19b50dc center.m: Use bsxfun rather than broadcasting (bug #51249). Rik <rik@octave.org> parents: 23220 diff changeset	76 ## supports diagonal and sparse matrices (Bugs #41441, #35787).
30875 5d3faba0342e doc: Ensure documentation lists output argument when it exists for all m-files. Rik <rik@octave.org> parents: 30564 diff changeset	77 y = bsxfun (@minus, x, mean (x, dim));
5d3faba0342e doc: Ensure documentation lists output argument when it exists for all m-files. Rik <rik@octave.org> parents: 30564 diff changeset	78 ## y = x - mean (x, dim); # automatic broadcasting
3200 781c930425fd [project @ 1998-10-29 05:23:08 by jwe] jwe parents: diff changeset	79 endif
11436 e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	80
4844 9f7ef92b50b0 [project @ 2004-04-02 17:26:53 by jwe] jwe parents: 4030 diff changeset	81 endfunction
11436 e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	82
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14336 diff changeset	83
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14336 diff changeset	84 %!assert (center ([1,2,3]), [-1,0,1])
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14336 diff changeset	85 %!assert (center (single ([1,2,3])), single ([-1,0,1]))
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14336 diff changeset	86 %!assert (center (int8 ([1,2,3])), [-1,0,1])
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14336 diff changeset	87 %!assert (center (logical ([1, 0, 0, 1])), [0.5, -0.5, -0.5, 0.5])
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14336 diff changeset	88 %!assert (center (ones (3,2,0,2)), zeros (3,2,0,2))
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14336 diff changeset	89 %!assert (center (ones (3,2,0,2, "single")), zeros (3,2,0,2, "single"))
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14336 diff changeset	90 %!assert (center (magic (3)), [3,-4,1;-2,0,2;-1,4,-3])
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14336 diff changeset	91 %!assert (center ([1 2 3; 6 5 4], 2), [-1 0 1; 1 0 -1])
21309 7fbecef105ca Allow statistics functions to work over non-existent dimension (bug #33523). Rik <rik@octave.org> parents: 20852 diff changeset	92 %!assert (center (1, 3), 0)
11436 e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	93
19833 9fc020886ae9 maint: Clean up m-files to follow Octave coding conventions. Rik <rik@octave.org> parents: 19697 diff changeset	94 ## Test input validation
28886 d8318c12d903 test: remove unnecessary BIST tests in m-files checking for excessive number of inputs. Rik <rik@octave.org> parents: 27984 diff changeset	95 %!error <Invalid call> center ()
21309 7fbecef105ca Allow statistics functions to work over non-existent dimension (bug #33523). Rik <rik@octave.org> parents: 20852 diff changeset	96 %!error <DIM must be an integer> center (1, ones (2,2))
7fbecef105ca Allow statistics functions to work over non-existent dimension (bug #33523). Rik <rik@octave.org> parents: 20852 diff changeset	97 %!error <DIM must be an integer> center (1, 1.5)
7fbecef105ca Allow statistics functions to work over non-existent dimension (bug #33523). Rik <rik@octave.org> parents: 20852 diff changeset	98 %!error <DIM must be .* a valid dimension> center (1, 0)

Mercurial > octave

annotate scripts/statistics/center.m @ 33623:4517f929c59d bytecode-interpreter tip