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