* Bug #13900 fixed - Statistics: making nanmin and nanmax obsolete
[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"
17           xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML"
18           xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org"
19           xml:lang="en" xml:id="nanmax">
20     <refnamediv>
21         <refname>nanmax</refname>
22         <refpurpose>
23           max  (ignoring Nan's) <emphasis role="bold">This function is obsolete</emphasis>,
24           replaced with <link linkend="max">max</link>
25         </refpurpose>
26     </refnamediv>
27     <refsynopsisdiv>
28         <title>Syntax</title>
29         <synopsis>[m,index]=nanmax(x)
30             [m,index]=nanmax(x,'r')
31             [m,index]=nanmax(x,'c')
32         </synopsis>
33     </refsynopsisdiv>
34     <refsection>
35         <title>Arguments</title>
36         <variablelist>
37             <varlistentry>
38                 <term>x</term>
39                 <listitem>
40                     <para>real or complex vector or matrix</para>
41                 </listitem>
42             </varlistentry>
43         </variablelist>
44     </refsection>
45     <refsection>
46         <title>Description</title>
47         <warning>
48           This function is obsolete and will  be removed from Scilab 6.1. Please use
49           <code>max()</code> instead.
50         </warning>
51         <para>
52             This function gives for a real or a numerical matrix
53             <literal> x</literal> his largest  element <literal> m</literal> (but ignoring the
54             NANs).
55         </para>
56         <para>
57             For  <literal>  x</literal>,  a   numerical vector  or  matrix, <literal> m=nanmax(x) </literal>
58             returns in scalar <literal>  m</literal> the largest
59             element  of <literal> x</literal>  (ignoring the NANs). The form
60             <literal>[m,index] =nanmax(x,orient) </literal> gives in addition of the
61             value of the largest element  of <literal> x</literal> (ignoring the
62             NANs) in scalar <literal> m</literal>, the index  of this element in
63             <literal> x</literal>, as a 2-vector.
64         </para>
65         <para>
66             <literal>m=nanmax(x,'r')  </literal> gives  in the 1xsize(x,2) matrix
67             <literal> m</literal> the largest elements  (ignoring the  NANs) of
68             each  column    of   <literal>  x</literal>.    If   the  form
69             <literal>[m,index]=nanmax(x,'r') </literal> is used, the elements of the
70             1xsize(x,2) matrix index are the  indexes of the largest
71             elements (ignoring the NANs) of each column  of x in the
72             corresponding column.
73         </para>
74         <para>
75             m=nanmax(x,'c') gives  in the size(x,2)x1  matrix m  the
76             largest elements (ignoring the NANs)  of each row of  x.
77             If   the   form [m,index]=nanmax(x,'c')   is  used,  the
78             elements of the size(x,2)x1 matrix index are the indexes
79             of the largest elements (ignoring  the NANs) of each row
80             of x in the corresponding row.
81         </para>
82         <para>
83             In   Labostat, NAN values  stand   for missing values  in
84             tables.
85         </para>
86     </refsection>
87     <refsection>
88         <title>Examples</title>
89         <programlisting role="example"><![CDATA[
90             x=[0.2113249 %nan 0.6653811;0.7560439 0.3303271 0.6283918]
91             m=nanmax(x)
92             m=nanmax(x,'r')
93             m=nanmax(x,'c')
94             ]]></programlisting>
95     </refsection>
96     <refsection>
97         <title>Bibliography</title>
98         <para>
99             Wonacott, T.H. &amp; Wonacott, R.J.; Introductory Statistics, fifth edition, J.Wiley &amp; Sons, 1990.
100         </para>
101     </refsection>
102     <refsection>
103         <title>History</title>
104         <revhistory>
105             <revision>
106                 <revnumber>6.0.1</revnumber>
107                 <revremark>
108                     Function tagged as obsolete, to be removed from Scilab 6.1, replaced with
109                     <link linkend="max">max</link>.
110                 </revremark>
111             </revision>
112         </revhistory>
113     </refsection>
114 </refentry>