* Bug #13900 fixed - Statistics: making nanmin and nanmax obsolete
[scilab.git] / scilab / modules / statistics / help / ja_JP / 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="ja" xml:id="nanmax">
20     <refnamediv>
21         <refname>nanmax</refname>
22         <refpurpose>最大値  (Nanを無視) <emphasis role="bold">This function is obsolete</emphasis>,
23           replaced with <link linkend="max">max</link>
24         </refpurpose>
25     </refnamediv>
26     <refsynopsisdiv>
27         <title>呼び出し手順</title>
28         <synopsis>[m,index]=nanmax(x)
29             [m,index]=nanmax(x,'r')
30             [m,index]=nanmax(x,'c')
31         </synopsis>
32     </refsynopsisdiv>
33     <refsection>
34         <title>パラメータ</title>
35         <variablelist>
36             <varlistentry>
37                 <term>x</term>
38                 <listitem>
39                     <para>実数または複素数のベクトルまたは行列</para>
40                 </listitem>
41             </varlistentry>
42         </variablelist>
43     </refsection>
44     <refsection>
45         <title>説明</title>
46         <warning>
47           This function is obsolete and will  be removed from Scilab 6.1. Please use
48           <code>max()</code> instead.
49         </warning>
50         <para>
51             この関数は,ある実数または数値行列<literal>x</literal>について,
52             最大の要素<literal>m</literal> (NaNは無視)を出力します.
53         </para>
54         <para>
55             <literal>x</literal>が数値ベクトルまたは行列の場合,
56             <literal>m=nanmax(x</literal>はスカラー<literal>m</literal>に
57             <literal>x</literal>に最大の要素(NaNを無視)を
58             返します.
59             <literal>[m,index] =nanmax(x,orient)</literal>は,
60             <literal>x</literal>の(NaNを無視した)最大要素の値を
61             スカラー<literal>m</literal>,そして,
62             <literal>x</literal>におけるこの要素のインデックスを
63             出力します.
64         </para>
65         <para>
66             <literal>m=nanmax(x,'r')</literal> は,
67             <literal>x</literal>の各列の(NaNを無視した)最大要素を
68             1行size(x,2)列の行列に出力します.
69             <literal>[m,index]=nanmax(x,'r')</literal>を使用した場合,
70             1行size(x,2)列の行列indexはその対応する列がxの各列の最大要素の
71             インデクスとなります.
72         </para>
73         <para>
74             m=nanmax(x,'c') は,size(x,2)x1行列mに
75             xの各行の(NaNを無視した)最大要素を出力します.
76             [m,index]=nanmax(x,'c')を使用した場合,
77             size(x,2)x1行列indexは,対応する行がxの各行の
78             (NaNを無視した)最大要素のインデックスとなります.
79         </para>
80         <para>
81             Labostatでは, NAN 値は表における欠損値を意味します.
82         </para>
83     </refsection>
84     <refsection>
85         <title>例</title>
86         <programlisting role="example"><![CDATA[
87 x=[0.2113249 %nan 0.6653811;0.7560439 0.3303271 0.6283918]
88 m=nanmax(x)
89 m=nanmax(x,'r')
90 m=nanmax(x,'c')
91  ]]></programlisting>
92     </refsection>
93     <refsection>
94         <title>参考文献</title>
95         <para>
96             Wonacott, T.H. &amp; Wonacott, R.J.; Introductory Statistics, fifth edition, J.Wiley &amp; Sons, 1990.
97         </para>
98     </refsection>
99     <refsection>
100         <title>History</title>
101         <revhistory>
102             <revision>
103                 <revnumber>6.0.1</revnumber>
104                 <revremark>
105                   Function tagged as obsolete, to be removed from Scilab 6.1, replaced with
106                   <link linkend="max">max</link>.
107                 </revremark>
108             </revision>
109         </revhistory>
110     </refsection>
111 </refentry>