Home > freetb4matlab > statistics > nanmax.m

nanmax

PURPOSE ^

% Find the maximal element while ignoring NaN values.

SYNOPSIS ^

function [v, idx] = nanmax (X, Y, DIM)

DESCRIPTION ^

% -*- texinfo -*-
% @deftypefn {Function File} {[@var{v}, @var{idx}] =} nanmax (@var{X})
% @deftypefnx{Function File} {[@var{v}, @var{idx}] =} nanmax (@var{X}, @var{Y})
% Find the maximal element while ignoring NaN values.
%
% @code{nanmax} is identical to the @code{max} function except that NaN values
% are ignored.  If all values in a column are NaN, the maximum is 
% returned as NaN rather than []. 
%
% @seealso{max, nansum, nanmin, nanmean, nanmedian}
% @end deftypefn

CROSS-REFERENCE INFORMATION ^

This function calls: This function is called by:
Generated on Sat 16-May-2009 00:04:49 by m2html © 2003