1 ## Copyright (C) 2001 Paul Kienzle <pkienzle@users.sf.net>
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
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
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/>.
17 ## @deftypefn {Function File} {@var{v} =} nanmean (@var{X})
18 ## @deftypefnx{Function File} {@var{v} =} nanmean (@var{X}, @var{dim})
19 ## Compute the mean value while ignoring NaN values.
21 ## @code{nanmean} is identical to the @code{mean} function except that NaN values
22 ## are ignored. If all values are NaN, the mean is returned as NaN.
24 ## @seealso{mean, nanmin, nanmax, nansum, nanmedian}
27 function v = nanmean (X, varargin)
31 n = sum (!isnan(X), varargin{:});
34 v = sum (X, varargin{:}) ./ n;