[statistics] corrected %hm_stdev to fix all tests in statistics
[scilab.git] / scilab / modules / statistics / help / ja_JP / descriptive_statistics / stdev.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) 2013 - Scilab Enterprises - Paul Bignier: added mean squared deviation
5  *                                                         (third input argument)
6  * Copyright (C) 2000 - INRIA -
7  *
8  * Copyright (C) 2012 - 2016 - Scilab Enterprises
9  *
10  * This file is hereby licensed under the terms of the GNU GPL v2.0,
11  * pursuant to article 5.3.4 of the CeCILL v.2.1.
12  * This file was originally licensed under the terms of the CeCILL v2.1,
13  * and continues to be available under such terms.
14  * For more information, see the COPYING file which you should have received
15  * along with this program.
16  *
17  -->
18 <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="ja" xml:id="stdev">
19     <refnamediv>
20         <refname>stdev</refname>
21         <refpurpose>
22             ベクトル/行列エントリの標準偏差 (行または列毎)
23         </refpurpose>
24     </refnamediv>
25     <refsynopsisdiv>
26         <title>呼び出し手順</title>
27         <synopsis>
28             y = stdev(x)
29             y = stdev(x, '*')
30             y = stdev(x, 'r')
31             y = stdev(x, 'c')
32             y = stdev(x, orien, m)
33         </synopsis>
34     </refsynopsisdiv>
35     <refsection role="parameters">
36         <title>引数</title>
37         <variablelist>
38             <varlistentry>
39                 <term>x, y</term>
40                 <listitem>
41                     <para>実数のベクトル, 行列またはハイパー行列</para>
42                 </listitem>
43             </varlistentry>
44             <varlistentry>
45                 <term>y</term>
46                 <listitem>
47                     <para>実数のベクトル, 行列またはハイパー行列</para>
48                 </listitem>
49             </varlistentry>
50             <varlistentry>
51                 <term>orien</term>
52                 <listitem>
53                     <para>
54                         <literal>"*"</literal> (default), <literal>"r"</literal> or 1,
55                         <literal>"c"</literal> or 2, or integer&lt;=ndims(x): direction along
56                         which calculations are performed.
57                     </para>
58                 </listitem>
59             </varlistentry>
60             <varlistentry>
61                 <term>m</term>
62                 <listitem>
63                     <para>実数のスカラー, ベクトルまたはハイパー行列, 先験平均</para>
64                 </listitem>
65             </varlistentry>
66         </variablelist>
67     </refsection>
68     <refsection role="description">
69         <title>説明</title>
70         <para>
71             stdev は "標本" 標準偏差を計算します.
72             この値は, Nを数列長としてN-1で正規化されます.
73             <varname>m</varname> が指定された場合, <code>stdev</code> は
74             <varname>m</varname>で定義された先験平均を用いて
75             (Nにより正規化された)平均二乗偏差を計算します.
76         </para>
77         <para>
78             <literal>x</literal>がベクトルまたは行列の場合, <literal>y=stdev(x)</literal> は
79             スカラー<literal>y</literal>に<literal>x</literal>の全エントリの
80             標準偏差を返します.
81         </para>
82         <para>
83             <literal>y=stdev(x,'r')</literal> (または, 等価的に,
84             <literal>y=stdev(x,1)</literal>) は行毎の標準偏差です.
85             これは,行ベクトル<literal>y</literal>の各エントリに
86             <literal>x</literal>の各列の標準偏差を返します.
87         </para>
88         <para>
89             <literal>y=stdev(x,'c')</literal> (または, 等価的に,
90             <literal>y=stdev(x,2)</literal>) は列毎の標準偏差です.
91             これは,行ベクトル<literal>y</literal>の各エントリに
92             <literal>x</literal>の各行の標準偏差を返します.
93         </para>
94         <para>
95             拡張表現として,正の整数<literal>n</literal>を指定して<literal>y=stdev(x,n)</literal>と
96             すると,<literal>n</literal>番目の次元に沿った
97             標準偏差を返します.
98         </para>
99         <note>
100             <varname>m</varname> がスカラーの場合, 
101             <literal>n</literal>番目の次元方向が
102             <code>mean(x)</code> の大きさに一致するように拡張されます.
103         </note>
104     </refsection>
105     <refsection role="examples">
106         <title>例</title>
107         <programlisting role="example"><![CDATA[
108 A = [1 2 10; 7 7.1 7.01];
109 stdev(A)
110 stdev(A, 'r')
111 stdev(A, 'c')
112 stdev(A,  2 )
113
114 // Deviation from a known (a-priori, built-in) mean:
115 A = grand(10, 10, "nor", 7.5, 3);
116 stdev(A) / 3             // unknown mean => assessed from A before computing stdev
117 stdev(A, '*', 7.5) / 3   // using the theoretical built-in mean
118
119 // With an hypermatrix:
120 A = grand(3, 5, 30, "nor", 4.1, 1.5);
121 stdev(A) / 1.5
122 sd = stdev(A, 3, 4.1) / 1.5
123 mean(sd)
124  ]]></programlisting>
125     </refsection>
126     <refsection role="see also">
127         <title>参照</title>
128         <simplelist type="inline">
129             <member>
130                 <link linkend="nanstdev">nanstdev</link>
131             </member>
132             <member>
133                 <link linkend="stdevf">stdevf</link>
134             </member>
135             <member>
136                 <link linkend="sum">sum</link>
137             </member>
138             <member>
139                 <link linkend="median">median</link>
140             </member>
141             <member>
142                 <link linkend="mean">mean</link>
143             </member>
144         </simplelist>
145     </refsection>
146     <refsection role="history">
147         <title>履歴</title>
148         <revhistory>
149             <revision>
150                 <revnumber>5.5.0</revnumber>
151                 <revdescription>
152                     <varname>m</varname>により定義された
153                     先験平均を用いて平均二乗偏差を計算できるようになりました
154                 </revdescription>
155             </revision>
156             <revision>
157                 <revnumber>6.0</revnumber>
158                 <revdescription>
159                     stdev(x, orien>ndims(x)) no longer returns zeros(x) but yields an error.
160                 </revdescription>
161             </revision>
162         </revhistory>
163     </refsection>
164 </refentry>