octave_packages/statistics-1.1.3/nanmax.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}, @var{idx}] =} nanmax (@var{X})
  18 ## @deftypefnx{Function File} {[@var{v}, @var{idx}] =} nanmax (@var{X}, @var{Y})
  19 ## Find the maximal element while ignoring NaN values.
  20 ##
  21 ## @code{nanmax} is identical to the @code{max} function except that NaN values
  22 ## are ignored.  If all values in a column are NaN, the maximum is
  23 ## returned as NaN rather than [].
  24 ##
  25 ## @seealso{max, nansum, nanmin, nanmean, nanmedian}
  26 ## @end deftypefn
  27
  28 function [v, idx] = nanmax (X, Y, DIM)
  29   if nargin < 1 || nargin > 3
  30     print_usage;
  31   elseif nargin == 1 || (nargin == 2 && isempty(Y))
  32     nanvals = isnan(X);
  33     X(nanvals) = -Inf;
  34     v = max (X);
  35     v(all(nanvals)) = NaN;
  36   elseif (nargin == 3 && isempty(Y))
  37     nanvals = isnan(X);
  38     X(nanvals) = -Inf;
  39     v = max (X,[],DIM);
  40     v(all(nanvals,DIM)) = NaN;
  41   else
  42     Xnan = isnan(X);
  43     Ynan = isnan(Y);
  44     X(Xnan) = -Inf;
  45     Y(Ynan) = -Inf;
  46     if (nargin == 3)
  47       v = max(X,Y,DIM);
  48     else
  49       v = max(X,Y);
  50     endif
  51     v(Xnan & Ynan) = NaN;
  52   endif
  53 endfunction