Mercurial > hg > octave-lyh
view scripts/statistics/base/center.m @ 10687:a8ce6bdecce5
Improve documentation strings.
author | Rik <octave@nomad.inbox5.com> |
---|---|
date | Tue, 08 Jun 2010 20:22:38 -0700 |
parents | e0767a0965f1 |
children | be55736a0783 |
line wrap: on
line source
## Copyright (C) 1995, 1996, 1997, 1998, 2000, 2002, 2004, 2005, 2006, ## 2007, 2009 Kurt Hornik ## Copyright (C) 2009 VZLU Prague ## ## This file is part of Octave. ## ## Octave is free software; you can redistribute it and/or modify it ## under the terms of the GNU General Public License as published by ## the Free Software Foundation; either version 3 of the License, or (at ## your option) any later version. ## ## Octave is distributed in the hope that it will be useful, but ## WITHOUT ANY WARRANTY; without even the implied warranty of ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU ## General Public License for more details. ## ## You should have received a copy of the GNU General Public License ## along with Octave; see the file COPYING. If not, see ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- ## @deftypefn {Function File} {} center (@var{x}) ## @deftypefnx {Function File} {} center (@var{x}, @var{dim}) ## If @var{x} is a vector, subtract its mean. ## If @var{x} is a matrix, do the above for each column. ## If the optional argument @var{dim} is given, perform the above ## operation along this dimension ## @end deftypefn ## Author: KH <Kurt.Hornik@wu-wien.ac.at> ## Description: Center by subtracting means function retval = center (x, dim) if (nargin != 1 && nargin != 2) print_usage (); endif if (nargin < 2) dim = [find(size (x) != 1, 1), 1](1); # First non-singleton dim. endif n = size (x, dim); if (isinteger (x)) x = double (x); endif if (n == 0) retval = x; else retval = bsxfun (@minus, x, sum (x, dim) / n); endif endfunction