9a816fbc5cf4d8ba456de55556f3f789f2feccad
[scilab.git] / scilab / modules / statistics / macros / nanmax.sci
1
2 // Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
3 // Copyright (C) 200 - INRIA - Carlos Klimann
4 //
5 // Copyright (C) 2012 - 2016 - Scilab Enterprises
6 //
7 // This file is hereby licensed under the terms of the GNU GPL v2.0,
8 // pursuant to article 5.3.4 of the CeCILL v.2.1.
9 // This file was originally licensed under the terms of the CeCILL v2.1,
10 // and continues to be available under such terms.
11 // For more information, see the COPYING file which you should have received
12 // along with this program.
13 //
14
15
16 function [s,index] = nanmax(x,orient)
17     //
18     //This function gives for a  real or a  numerical matrix x a his largest
19     //element m (but ignoring the NANs).
20     //
21     //For x,  a numerical vector or matrix,  m=nanmax(x) returns in scalar m
22     //the largest  element of x (ignoring the  NANs).  The form  [m,index] =
23     //nanmax(x,orient) gives in addition of the value of the largest element
24     //of x (ignoring the NANs) in scalar m, and    the index of this element
25     //in x, as a  2-vector.
26     //
27     //m=nanmax(x,'r') gives in the 1xsize(x,2) matrix m the largest elements
28     //(ignoring the    NANs)   of each   column    of  x.   If   the    form
29     //[m,index]=nanmax(x,'r')  is used,    the elements of  the  1xsize(x,2)
30     //matrix index are the indexes  of the  largest  elements  (ignoring the
31     //NANs) of each column of x in the corresponding column.
32     //
33     //m=nanmax(x,'c') gives in the size(x,2)x1 matrix m the largest elements
34     //(ignoring    the    NANs) of    each   row   of   x.    If  the   form
35     //[m,index]=nanmax(x,'c') is  used,   the  elements of   the size(x,2)x1
36     //matrix index are  the  indexes of the  largest  elements (ignoring the
37     //NANs) of each row of x in the corresponding row.
38     //
39     //
40     // correction of bug 1239 (Bruno)
41
42     [lhs, rhs] = argn(0)
43     if rhs == 0 then
44         error(msprintf(gettext("%s: Wrong number of input arguments: %d to %d expected.\n"),"nanmax",1,2))
45     end
46     if rhs==1 then  orient="*",end
47     if orient==1 then orient="r",end
48     if orient==2 then orient="c",end
49     if x==[]|(size(x,"*")==1&isnan(x)) then s=[],index=[],return,end
50     isn=isnan(x)
51     x(isn)=-%inf
52     [s,index]=max(x,orient)
53     s(find(and(isn,orient)))=%nan
54
55 endfunction