octave_packages/statistics-1.1.3/nansum.m

   1 ## Copyright (C) 2001 Paul Kienzle <pkienzle@users.sf.net>
   2 ##
   3 ## This program is free software; you can redistribute it and/or modify it under
   4 ## the terms of the GNU General Public License as published by the Free Software
   5 ## Foundation; either version 3 of the License, or (at your option) any later
   6 ## version.
   7 ##
   8 ## This program is distributed in the hope that it will be useful, but WITHOUT
   9 ## ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  10 ## FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
  11 ## details.
  12 ##
  13 ## You should have received a copy of the GNU General Public License along with
  14 ## this program; if not, see <http://www.gnu.org/licenses/>.
  15
  16 ## -*- texinfo -*-
  17 ## @deftypefn {Function File} {@var{v} =} nansum (@var{X})
  18 ## @deftypefnx{Function File} {@var{v} =} nansum (@var{X}, @var{dim})
  19 ## Compute the sum while ignoring NaN values.
  20 ##
  21 ## @code{nansum} is identical to the @code{sum} function except that NaN values are
  22 ## treated as 0 and so ignored.  If all values are NaN, the sum is
  23 ## returned as 0.
  24 ##
  25 ## @seealso{sum, nanmin, nanmax, nanmean, nanmedian}
  26 ## @end deftypefn
  27
  28 function v = nansum (X, varargin)
  29   if nargin < 1
  30     print_usage;
  31   else
  32     X(isnan(X)) = 0;
  33     v = sum (X, varargin{:});
  34   endif
  35 endfunction