Mercurial > forge
diff main/statistics/nanmax.m @ 0:6b33357c7561 octave-forge
Initial revision
author | pkienzle |
---|---|
date | Wed, 10 Oct 2001 19:54:49 +0000 |
parents | |
children | 147d05c7af81 |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/main/statistics/nanmax.m Wed Oct 10 19:54:49 2001 +0000 @@ -0,0 +1,36 @@ +## Copyright (C) 2001 Paul Kienzle +## +## This program 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 2 of the License, or +## (at your option) any later version. +## +## This program 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 this program; if not, write to the Free Software +## Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + +## [v, idx] = nanmax(X [, dim]); +## nanmax is identical to the max function except that NaN values are +## treated as -Inf, and so are ignored. If all values are NaN, the +## maximum is returned as -Inf. [Is this behaviour compatible?] +## +## See also: nansum, nanmin, nanmean, nanmedian +function [v, idx] = nanmax (X, ...) + if nargin < 1 + usage ("[v, idx] = nanmax(X [, dim])"); + else + dfi = do_fortran_indexing; + unwind_protect + do_fortran_indexing = 1; + X(isnan(X)) = -Inf; + [v,idx] = max (X, all_va_args); + unwind_protect_cleanup + do_fortran_indexing = dfi; + end_unwind_protect + endif +endfunction