Graphics tests: fix histrogram references
[scilab.git] / scilab / modules / graphics / help / ja_JP / 2d_plot / histplot.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) INRIA - Serge Steer
5  *
6  * This file must be used under the terms of the CeCILL.
7  * This source file is licensed as described in the file COPYING, which
8  * you should have received as part of this distribution.  The terms
9  * are also available at
10  * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt
11  *
12  -->
13 <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="histplot">
14     <refnamediv>
15         <refname>histplot</refname>
16         <refpurpose>ヒストグラムをプロットする</refpurpose>
17     </refnamediv>
18     <refsynopsisdiv>
19         <title>呼び出し手順</title>
20         <synopsis>histplot(n, data, &lt;opt_args&gt;)
21             histplot(x, data, &lt;opt_args&gt;)
22         </synopsis>
23     </refsynopsisdiv>
24     <refsection>
25         <title>引数</title>
26         <variablelist>
27             <varlistentry>
28                 <term>n</term>
29                 <listitem>
30                     <para>正の整数 (クラスの数)</para>
31                 </listitem>
32             </varlistentry>
33             <varlistentry>
34                 <term>x</term>
35                 <listitem>
36                     <para>
37                         クラスを定義する増加方向のベクトル (<literal>x</literal>は2個以上の要素を有します)
38                     </para>
39                 </listitem>
40             </varlistentry>
41             <varlistentry>
42                 <term>data</term>
43                 <listitem>
44                     <para>ベクトル (解析するデータ)</para>
45                 </listitem>
46             </varlistentry>
47             <varlistentry>
48                 <term>&lt;opt_args&gt;</term>
49                 <listitem>
50                     <para>
51                         一連の命令 <literal>key1=value1,key2=value2</literal>
52                         ,... を表します.ただし,<literal>key1</literal>,
53                         <literal>key2,...</literal> は任意の<link linkend="plot2d">plot2d</link> の
54                         オプションのパラメータ (<literal>style,strf,leg,
55                             rect,nax, logflag,frameflag, axesflag
56                         </literal>
57                         )またはnormalizationとすることができます.
58                         この最後のパラメータの場合,対応する値は論理値スカラー(デフォルト値: %t)とする必要があります.
59                     </para>
60                 </listitem>
61             </varlistentry>
62         </variablelist>
63     </refsection>
64     <refsection>
65         <title>説明</title>
66         <para>
67             この関数は,クラス<literal>x</literal>を用いて<literal>data</literal>ベクトル
68             のヒストグラム(柱状グラフ)をプロットします.
69             <literal>x</literal>のかわりにクラスの数<literal>n</literal>が指令された場合,
70             クラスは等間隔で<emphasis>dx = (x(n+1)-x(1))/n</emphasis>として
71             <emphasis>x(1) = min(data) &lt;  x(2) = x(1) + dx  &lt;  ...  &lt; x(n+1) = max(data)</emphasis>
72             となるように選択されます.
73         </para>
74         <para> クラスはC1 = [x(1), x(2)]およびi &gt;= 2の時にCi = ( x(i), x(i+1)]
75             により定義されます.
76             <literal>data</literal>の総数 Nmax  (Nmax = length(data))となり,
77             Ciに含まれる<literal>data</literal>要素の数 Niは
78             <literal>normalization</literal>が true (デフォルト)の場合には
79             <emphasis>Ni/(Nmax (x(i+1)-x(i)))</emphasis>となります.
80             そうでない場合, <emphasis>Ni</emphasis> となります.
81               正規化が行われる場合,このヒストグラムは以下を制約を満たします:
82         </para>
83         <programlisting role=""><![CDATA[
84  x(n+1)
85 /
86 |   h(x) dx = 1,  when x(1)<=min(data) and max(data) <= x(n+1))
87 /
88 x(1)
89
90     ]]></programlisting>
91         <para>
92             任意の <link linkend="plot2d">plot2d</link> (オプション) パラメータを指定できます;
93             例えば,色番号2 (標準カラーマップを使用する場合には青)のヒストグラムをプロットする場合や,
94             矩形 [-3,3]x[0,0.5] の内側へのプロットを制限する場合,
95             <literal>histplot(n,data, style=2, rect=[-3,0,3,0.5])</literal>
96             を使用することができます.
97         </para>
98         <para>
99             デモを参照するには <literal>histplot()</literal>コマンドを入力してください.
100         </para>
101     </refsection>
102     <refsection>
103         <title>例</title>
104         <scilab:image>
105             d=rand(1,10000,'normal');
106             clf();histplot(20,d,leg='rand(1,10000,''normal'')',style=16, rect=[-3,0,3,0.5]);
107         </scilab:image>
108     </refsection>
109     <refsection>
110         <title>例</title>
111         <simplelist>
112             <member>
113                 例 #1: ガウス乱数標本の種々のヒストグラム
114                 <programlisting role="example"><![CDATA[
115 d=rand(1,10000,'normal');  // ガウス乱数標本
116 clf();histplot(20,d)
117 clf();histplot(20,d,normalization=%f)
118 clf();histplot(20,d,leg='rand(1,10000,''normal'')',style=5)
119 clf();histplot(20,d,leg='rand(1,10000,''normal'')',style=16, rect=[-3,0,3,0.5]);
120 ]]></programlisting>
121             </member>
122             <member>
123                 例 #2: 二項分布 (B(6,0.5)) 乱数標本のヒストグラム
124                 <programlisting role="example"><![CDATA[
125 d = grand(1000,1,"bin", 6, 0.5);
126 c = linspace(-0.5,6.5,8);
127 clf()
128 subplot(2,1,1)
129 histplot(c, d, style=2)
130 xtitle("normalized histogram")
131 subplot(2,1,2)
132 histplot(c, d, normalization=%f, style=5)
133 xtitle("non normalized histogram")
134 ]]></programlisting>
135             </member>
136             <member>
137                 例 #3: 指数乱数標本のヒストグラム
138                 <programlisting role="example"><![CDATA[
139 lambda = 2;
140 X = grand(100000,1,"exp", 1/lambda);
141 Xmax = max(X);
142 clf()
143 histplot(40, X, style=2)
144 x = linspace(0,max(Xmax),100)';
145 plot2d(x,lambda*exp(-lambda*x),strf="000",style=5)
146 legend(["exponential random sample histogram" "exact density curve"]);
147 ]]></programlisting>
148             </member>
149         </simplelist>
150     </refsection>
151     <refsection role="see also">
152         <title>参照</title>
153         <simplelist type="inline">
154             <member>
155                 <link linkend="hist3d">hist3d</link>
156             </member>
157             <member>
158                 <link linkend="plot2d">plot2d</link>
159             </member>
160             <member>
161                 <link linkend="bar">bar</link>
162             </member>
163             <member>
164                 <link linkend="dsearch">dsearch</link>
165             </member>
166         </simplelist>
167     </refsection>
168 </refentry>