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

annotate scripts/statistics/base/center.m @ 20174:d9341b422488 stable

doc: Update more docstrings to have one sentence summary as first line. Reviewed statistics/ and @ftp/ in scripts directory. * scripts/@ftp/ascii.m, scripts/@ftp/binary.m, scripts/@ftp/cd.m, scripts/@ftp/dir.m, scripts/@ftp/ftp.m, scripts/@ftp/mget.m, scripts/@ftp/mput.m, scripts/statistics/base/center.m, scripts/statistics/base/cloglog.m, scripts/statistics/base/cov.m, scripts/statistics/base/gls.m, scripts/statistics/base/histc.m, scripts/statistics/base/iqr.m, scripts/statistics/base/kendall.m, scripts/statistics/base/kurtosis.m, scripts/statistics/base/logit.m, scripts/statistics/base/lscov.m, scripts/statistics/base/mahalanobis.m, scripts/statistics/base/mean.m, scripts/statistics/base/meansq.m, scripts/statistics/base/median.m, scripts/statistics/base/mode.m, scripts/statistics/base/moment.m, scripts/statistics/base/ols.m, scripts/statistics/base/ppplot.m, scripts/statistics/base/prctile.m, scripts/statistics/base/probit.m, scripts/statistics/base/range.m, scripts/statistics/base/ranks.m, scripts/statistics/base/run_count.m, scripts/statistics/base/runlength.m, scripts/statistics/base/skewness.m, scripts/statistics/base/spearman.m, scripts/statistics/base/statistics.m, scripts/statistics/base/std.m, scripts/statistics/base/table.m, scripts/statistics/base/var.m, scripts/statistics/base/zscore.m, scripts/statistics/distributions/betainv.m, scripts/statistics/distributions/binoinv.m, scripts/statistics/distributions/binopdf.m, scripts/statistics/distributions/cauchy_cdf.m, scripts/statistics/distributions/cauchy_inv.m, scripts/statistics/distributions/cauchy_pdf.m, scripts/statistics/distributions/chi2cdf.m, scripts/statistics/distributions/chi2inv.m, scripts/statistics/distributions/chi2pdf.m, scripts/statistics/distributions/discrete_cdf.m, scripts/statistics/distributions/discrete_inv.m, scripts/statistics/distributions/discrete_pdf.m, scripts/statistics/distributions/empirical_cdf.m, scripts/statistics/distributions/empirical_inv.m, scripts/statistics/distributions/empirical_pdf.m, scripts/statistics/distributions/expcdf.m, scripts/statistics/distributions/expinv.m, scripts/statistics/distributions/exppdf.m, scripts/statistics/distributions/finv.m, scripts/statistics/distributions/fpdf.m, scripts/statistics/distributions/gamcdf.m, scripts/statistics/distributions/gaminv.m, scripts/statistics/distributions/gampdf.m, scripts/statistics/distributions/geoinv.m, scripts/statistics/distributions/geopdf.m, scripts/statistics/distributions/hygecdf.m, scripts/statistics/distributions/hygeinv.m, scripts/statistics/distributions/hygepdf.m, scripts/statistics/distributions/kolmogorov_smirnov_cdf.m, scripts/statistics/distributions/laplace_cdf.m, scripts/statistics/distributions/laplace_inv.m, scripts/statistics/distributions/laplace_pdf.m, scripts/statistics/distributions/logistic_inv.m, scripts/statistics/distributions/logncdf.m, scripts/statistics/distributions/logninv.m, scripts/statistics/distributions/lognpdf.m, scripts/statistics/distributions/nbincdf.m, scripts/statistics/distributions/nbininv.m, scripts/statistics/distributions/nbinpdf.m, scripts/statistics/distributions/nbinrnd.m, scripts/statistics/distributions/normcdf.m, scripts/statistics/distributions/norminv.m, scripts/statistics/distributions/normpdf.m, scripts/statistics/distributions/poisscdf.m, scripts/statistics/distributions/poissinv.m, scripts/statistics/distributions/poisspdf.m, scripts/statistics/distributions/stdnormal_cdf.m, scripts/statistics/distributions/stdnormal_pdf.m, scripts/statistics/distributions/tcdf.m, scripts/statistics/distributions/tinv.m, scripts/statistics/distributions/tpdf.m, scripts/statistics/distributions/unidcdf.m, scripts/statistics/distributions/unidinv.m, scripts/statistics/distributions/unidpdf.m, scripts/statistics/distributions/unidrnd.m, scripts/statistics/distributions/unifcdf.m, scripts/statistics/distributions/unifinv.m, scripts/statistics/distributions/wblcdf.m, scripts/statistics/distributions/wblinv.m, scripts/statistics/distributions/wblpdf.m, scripts/statistics/distributions/wienrnd.m, scripts/statistics/models/private/logistic_regression_derivatives.m, scripts/statistics/models/private/logistic_regression_likelihood.m, scripts/statistics/tests/anova.m, scripts/statistics/tests/chisquare_test_homogeneity.m, scripts/statistics/tests/chisquare_test_independence.m, scripts/statistics/tests/cor_test.m, scripts/statistics/tests/f_test_regression.m, scripts/statistics/tests/hotelling_test.m, scripts/statistics/tests/kolmogorov_smirnov_test.m, scripts/statistics/tests/kolmogorov_smirnov_test_2.m, scripts/statistics/tests/kruskal_wallis_test.m, scripts/statistics/tests/manova.m, scripts/statistics/tests/mcnemar_test.m, scripts/statistics/tests/prop_test_2.m, scripts/statistics/tests/run_test.m, scripts/statistics/tests/sign_test.m, scripts/statistics/tests/t_test.m, scripts/statistics/tests/t_test_2.m, scripts/statistics/tests/t_test_regression.m, scripts/statistics/tests/u_test.m, scripts/statistics/tests/var_test.m, scripts/statistics/tests/welch_test.m, scripts/statistics/tests/wilcoxon_test.m, scripts/statistics/tests/z_test.m, scripts/statistics/tests/z_test_2.m: Update more docstrings to have one sentence summary as first line.

author	Rik <rik@octave.org>
date	Sun, 10 May 2015 16:07:41 -0700
parents	9fc020886ae9
children	a3b9ee5c040a

rev	line source
19697 4197fc428c7d maint: Update copyright notices for 2015. John W. Eaton <jwe@octave.org> parents: 17744 diff changeset	1 ## Copyright (C) 1995-2015 Kurt Hornik
9744 fb3543975ed9 optimize center using bsxfun Jaroslav Hajek <highegg@gmail.com> parents: 8977 diff changeset	2 ## Copyright (C) 2009 VZLU Prague
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3200 diff changeset	3 ##
3922 38c61cbf086c [project @ 2002-05-01 06:48:35 by jwe] jwe parents: 3876 diff changeset	4 ## This file is part of Octave.
38c61cbf086c [project @ 2002-05-01 06:48:35 by jwe] jwe parents: 3876 diff changeset	5 ##
38c61cbf086c [project @ 2002-05-01 06:48:35 by jwe] jwe parents: 3876 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: 3876 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: 3200 diff changeset	10 ##
3922 38c61cbf086c [project @ 2002-05-01 06:48:35 by jwe] jwe parents: 3876 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: 3200 diff changeset	14 ## General Public License for more details.
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3200 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 --
10793 be55736a0783 Grammarcheck the documentation from m-files. Rik <octave@nomad.inbox5.com> parents: 10330 diff changeset	21 ## @deftypefn {Function File} {} center (@var{x})
4844 9f7ef92b50b0 [project @ 2004-04-02 17:26:53 by jwe] jwe parents: 4030 diff changeset	22 ## @deftypefnx {Function File} {} 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	23 ## 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	24 ##
3453 71d2e09c15a2 [project @ 2000-01-18 08:32:09 by jwe] jwe parents: 3426 diff changeset	25 ## 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	26 ##
3453 71d2e09c15a2 [project @ 2000-01-18 08:32:09 by jwe] jwe parents: 3426 diff changeset	27 ## 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	28 ##
11436 e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	29 ## 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	30 ##
d9341b422488 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	31 ## 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	32 ## 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	33 ## 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	34 ## 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	35 ## 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	36 ## @seealso{zscore}
3453 71d2e09c15a2 [project @ 2000-01-18 08:32:09 by jwe] jwe parents: 3426 diff changeset	37 ## @end deftypefn
3200 781c930425fd [project @ 1998-10-29 05:23:08 by jwe] jwe parents: diff changeset	38
5428 2a16423e4aa0 [project @ 2005-08-23 18:38:27 by jwe] jwe parents: 5307 diff changeset	39 ## Author: KH <Kurt.Hornik@wu-wien.ac.at>
3456 434790acb067 [project @ 2000-01-19 06:58:51 by jwe] jwe parents: 3453 diff changeset	40 ## Description: Center by subtracting means
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3200 diff changeset	41
8977 f464119ec165 further simplify some stats funcs Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	42 function retval = center (x, dim)
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3200 diff changeset	43
4844 9f7ef92b50b0 [project @ 2004-04-02 17:26:53 by jwe] jwe parents: 4030 diff changeset	44 if (nargin != 1 && nargin != 2)
6046 34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe] jwe parents: 6024 diff changeset	45 print_usage ();
3200 781c930425fd [project @ 1998-10-29 05:23:08 by jwe] jwe parents: diff changeset	46 endif
781c930425fd [project @ 1998-10-29 05:23:08 by jwe] jwe parents: diff changeset	47
12656 6b2f14af2360 Overhaul functions in statistics/base directory. Rik <octave@nomad.inbox5.com> parents: 12586 diff changeset	48 if (! (isnumeric (x) \|\| islogical (x)))
11436 e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	49 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	50 endif
f464119ec165 further simplify some stats funcs Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	51
10330 e0767a0965f1 fix some stat functions with integers Jaroslav Hajek <highegg@gmail.com> parents: 9744 diff changeset	52 if (isinteger (x))
e0767a0965f1 fix some stat functions with integers Jaroslav Hajek <highegg@gmail.com> parents: 9744 diff changeset	53 x = double (x);
e0767a0965f1 fix some stat functions with integers Jaroslav Hajek <highegg@gmail.com> parents: 9744 diff changeset	54 endif
e0767a0965f1 fix some stat functions with integers Jaroslav Hajek <highegg@gmail.com> parents: 9744 diff changeset	55
11436 e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	56 nd = ndims (x);
e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	57 sz = size (x);
e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	58 if (nargin != 2)
e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	59 ## Find the first non-singleton dimension.
12656 6b2f14af2360 Overhaul functions in statistics/base directory. Rik <octave@nomad.inbox5.com> parents: 12586 diff changeset	60 (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	61 else
e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	62 if (!(isscalar (dim) && dim == fix (dim))
e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	63 \|\| !(1 <= dim && dim <= nd))
e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	64 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	65 endif
e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	66 endif
e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	67
12656 6b2f14af2360 Overhaul functions in statistics/base directory. Rik <octave@nomad.inbox5.com> parents: 12586 diff changeset	68 n = sz(dim);
11436 e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	69
9744 fb3543975ed9 optimize center using bsxfun Jaroslav Hajek <highegg@gmail.com> parents: 8977 diff changeset	70 if (n == 0)
fb3543975ed9 optimize center using bsxfun Jaroslav Hajek <highegg@gmail.com> parents: 8977 diff changeset	71 retval = x;
8977 f464119ec165 further simplify some stats funcs Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	72 else
12656 6b2f14af2360 Overhaul functions in statistics/base directory. Rik <octave@nomad.inbox5.com> parents: 12586 diff changeset	73 retval = bsxfun (@minus, x, mean (x, dim));
3200 781c930425fd [project @ 1998-10-29 05:23:08 by jwe] jwe parents: diff changeset	74 endif
11436 e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	75
4844 9f7ef92b50b0 [project @ 2004-04-02 17:26:53 by jwe] jwe parents: 4030 diff changeset	76 endfunction
11436 e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	77
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14336 diff changeset	78
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14336 diff changeset	79 %!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	80 %!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	81 %!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	82 %!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	83 %!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	84 %!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	85 %!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	86 %!assert (center ([1 2 3; 6 5 4], 2), [-1 0 1; 1 0 -1])
11436 e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	87
19833 9fc020886ae9 maint: Clean up m-files to follow Octave coding conventions. Rik <rik@octave.org> parents: 19697 diff changeset	88 ## Test input validation
11436 e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	89 %!error center ()
e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	90 %!error center (1, 2, 3)
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14336 diff changeset	91 %!error center (1, ones (2,2))
11436 e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	92 %!error center (1, 1.5)
e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	93 %!error center (1, 0)
e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	94 %!error center (1, 3)
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14336 diff changeset	95

Mercurial > octave

annotate scripts/statistics/base/center.m @ 20174:d9341b422488 stable