f7c9167aec60ca48948f4dd17b66f71b80dae9b8
[scilab.git] / scilab / modules / statistics / help / en_US / data_missing_values / nanmax.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!--
3  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
4  * Copyright (C) 2000 - INRIA - Carlos Klimann
5  *
6  * Copyright (C) 2012 - 2016 - Scilab Enterprises
7  *
8  * This file is hereby licensed under the terms of the GNU GPL v2.0,
9  * pursuant to article 5.3.4 of the CeCILL v.2.1.
10  * This file was originally licensed under the terms of the CeCILL v2.1,
11  * and continues to be available under such terms.
12  * For more information, see the COPYING file which you should have received
13  * along with this program.
14  *
15  -->
16 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:lang="en" xml:id="nanmax">
17     <refnamediv>
18         <refname>nanmax</refname>
19         <refpurpose>max  (ignoring Nan's) </refpurpose>
20     </refnamediv>
21     <refsynopsisdiv>
22         <title>Syntax</title>
23         <synopsis>[m,index]=nanmax(x)
24             [m,index]=nanmax(x,'r')
25             [m,index]=nanmax(x,'c')
26         </synopsis>
27     </refsynopsisdiv>
28     <refsection>
29         <title>Arguments</title>
30         <variablelist>
31             <varlistentry>
32                 <term>x</term>
33                 <listitem>
34                     <para>real or complex vector or matrix</para>
35                 </listitem>
36             </varlistentry>
37         </variablelist>
38     </refsection>
39     <refsection>
40         <title>Description</title>
41         <para>
42             This function gives for a real or a numerical matrix
43             <literal> x</literal> his largest  element <literal> m</literal> (but ignoring the
44             NANs).
45         </para>
46         <para>
47             For  <literal>  x</literal>,  a   numerical vector  or  matrix, <literal> m=nanmax(x) </literal>
48             returns in scalar <literal>  m</literal> the largest
49             element  of <literal> x</literal>  (ignoring the NANs). The form
50             <literal>[m,index] =nanmax(x,orient) </literal> gives in addition of the
51             value of the largest element  of <literal> x</literal> (ignoring the
52             NANs) in scalar <literal> m</literal>, the index  of this element in
53             <literal> x</literal>, as a 2-vector.
54         </para>
55         <para>
56             <literal>m=nanmax(x,'r')  </literal> gives  in the 1xsize(x,2) matrix
57             <literal> m</literal> the largest elements  (ignoring the  NANs) of
58             each  column    of   <literal>  x</literal>.    If   the  form
59             <literal>[m,index]=nanmax(x,'r') </literal> is used, the elements of the
60             1xsize(x,2) matrix index are the  indexes of the largest
61             elements (ignoring the NANs) of each column  of x in the
62             corresponding column.
63         </para>
64         <para>
65             m=nanmax(x,'c') gives  in the size(x,2)x1  matrix m  the
66             largest elements (ignoring the NANs)  of each row of  x.
67             If   the   form [m,index]=nanmax(x,'c')   is  used,  the
68             elements of the size(x,2)x1 matrix index are the indexes
69             of the largest elements (ignoring  the NANs) of each row
70             of x in the corresponding row.
71         </para>
72         <para>
73             In   Labostat, NAN values  stand   for missing values  in
74             tables.
75         </para>
76     </refsection>
77     <refsection>
78         <title>Examples</title>
79         <programlisting role="example"><![CDATA[
80 x=[0.2113249 %nan 0.6653811;0.7560439 0.3303271 0.6283918]
81 m=nanmax(x)
82 m=nanmax(x,'r')
83 m=nanmax(x,'c')
84  ]]></programlisting>
85     </refsection>
86     <refsection>
87         <title>Bibliography</title>
88         <para>
89             Wonacott, T.H. &amp; Wonacott, R.J.; Introductory Statistics, fifth edition, J.Wiley &amp; Sons, 1990.
90         </para>
91     </refsection>
92 </refentry>