7c504a0336c608cf75613ac2799b72afa89927b4
[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>
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                         文字列スカラーまたは正の整数であり,
55                         <literal>"*"</literal>, <literal>"r"</literal>
56                         (または<literal>1</literal>)または
57                         <literal>"c"</literal> (または <literal>2</literal>)を指定可能
58                     </para>
59                 </listitem>
60             </varlistentry>
61             <varlistentry>
62                 <term>m</term>
63                 <listitem>
64                     <para>実数のスカラー, ベクトルまたはハイパー行列, 先験平均</para>
65                 </listitem>
66             </varlistentry>
67         </variablelist>
68     </refsection>
69     <refsection>
70         <title>説明</title>
71         <para>
72             stdev は "標本" 標準偏差を計算します.
73             この値は, Nを数列長としてN-1で正規化されます.
74             <varname>m</varname> が指定された場合, <code>stdev</code> は
75             <varname>m</varname>で定義された先験平均を用いて
76             (Nにより正規化された)平均二乗偏差を計算します.
77         </para>
78         <para>
79             <literal>x</literal>がベクトルまたは行列の場合, <literal>y=stdev(x)</literal> は
80             スカラー<literal>y</literal>に<literal>x</literal>の全エントリの
81             標準偏差を返します.
82         </para>
83         <para>
84             <literal>y=stdev(x,'r')</literal> (または, 等価的に,
85             <literal>y=stdev(x,1)</literal>) は行毎の標準偏差です.
86             これは,行ベクトル<literal>y</literal>の各エントリに
87             <literal>x</literal>の各列の標準偏差を返します.
88         </para>
89         <para>
90             <literal>y=stdev(x,'c')</literal> (または, 等価的に,
91             <literal>y=stdev(x,2)</literal>) は列毎の標準偏差です.
92             これは,行ベクトル<literal>y</literal>の各エントリに
93             <literal>x</literal>の各行の標準偏差を返します.
94         </para>
95         <para>
96             拡張表現として,正の整数<literal>n</literal>を指定して<literal>y=stdev(x,n)</literal>と
97             すると,<literal>n</literal>番目の次元に沿った
98             標準偏差を返します.
99             <literal>n>ndims(x)</literal>の場合,
100             <literal>stdev(x,n)</literal> は <literal>zeros(x)</literal>を返します.
101         </para>
102         <note>
103             <varname>m</varname> がスカラーの場合, 
104             <literal>n</literal>番目の次元方向が
105             <code>mean(x)</code> の大きさに一致するように拡張されます.
106         </note>
107     </refsection>
108     <refsection>
109         <title>例</title>
110         <programlisting role="example"><![CDATA[
111 A = [1 2 10; 7 7.1 7.01];
112 stdev(A)
113 stdev(A, 'r')
114 stdev(A, 'c')
115 stdev(A, 'c', mean(A,'c'))
116 stdev(A, 'c', 1)
117  ]]></programlisting>
118     </refsection>
119     <refsection role="see also">
120         <title>参照</title>
121         <simplelist type="inline">
122             <member>
123                 <link linkend="nanstdev">nanstdev</link>
124             </member>
125             <member>
126                 <link linkend="stdevf">stdevf</link>
127             </member>
128             <member>
129                 <link linkend="sum">sum</link>
130             </member>
131             <member>
132                 <link linkend="median">median</link>
133             </member>
134             <member>
135                 <link linkend="mean">mean</link>
136             </member>
137         </simplelist>
138     </refsection>
139     <refsection>
140         <title>履歴</title>
141         <revhistory>
142             <revision>
143                 <revnumber>5.5.0</revnumber>
144                 <revdescription>
145                     <varname>m</varname>により定義された
146                     先験平均を用いて平均二乗偏差を計算できるようになりました
147                 </revdescription>
148             </revision>
149         </revhistory>
150     </refsection>
151 </refentry>