669bf26bc92234d2d204a4e3defe427a06ab702b
[scilab.git] / scilab / modules / graphics / help / ja_JP / 2d_plot / comet.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) Serge Steer
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 <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="comet">
16     <refnamediv>
17         <refname>comet</refname>
18         <refpurpose>2次元 comet アニメーションプロット. </refpurpose>
19     </refnamediv>
20     <refsynopsisdiv>
21         <title>呼び出し手順</title>
22         <synopsis>comet(y)</synopsis>
23         <synopsis>comet(x,y)</synopsis>
24         <synopsis>comet(x,fun)</synopsis>
25         <synopsis>comet(x,y,p)</synopsis>
26         <synopsis>comet(x,fun,p)</synopsis>
27         <synopsis>comet(...,"colors",c)</synopsis>
28     </refsynopsisdiv>
29     <refsection>
30         <title>パラメータ</title>
31         <variablelist>
32             <varlistentry>
33                 <term>x</term>
34                 <listitem>
35                     <para>
36                         実数ベクトルまたは行列. 省略された場合,
37                         ベクトル <literal>1:ny</literal> が指定されたと仮定されます.
38                         ただし,<literal>ny</literal> は曲線の点の数(下記参照)です.
39                     </para>
40                 </listitem>
41             </varlistentry>
42             <varlistentry>
43                 <term>y</term>
44                 <listitem>
45                     <para>
46                         長さの実数ベクトルまたは行列.
47                     </para>
48                 </listitem>
49             </varlistentry>
50             <varlistentry>
51                 <term>p</term>
52                 <listitem>
53                     <para>
54                         範囲 <literal>[0 1[</literal> の実数スカラー.
55                         デフォルト値は 0.1です.
56                     </para>
57                 </listitem>
58             </varlistentry>
59             <varlistentry>
60                 <term>fun</term>
61                 <listitem>
62                     <para>
63                         呼び出し手順  <literal>y=fun(x)</literal> のScilab関数.
64                         <varname>fun</varname> は多項式または有理数とすることもできます.
65                     </para>
66                 </listitem>
67             </varlistentry>
68             <varlistentry>
69                 <term>c</term>
70                 <listitem>
71                     <para>
72                         <literal>ny</literal> 色添字のベクトル.
73                     </para>
74                 </listitem>
75             </varlistentry>
76         </variablelist>
77     </refsection>
78     <refsection>
79         <title>説明</title>
80         <para>
81             <literal>(x,y)</literal> が同じ要素数のベクトルの場合,
82             この関数は,
83             <literal>k</literal>を<literal>1</literal> から
84             <literal>size(x,'*')</literal>まで変えて
85             曲線<literal>(x(1:k),y(1:k))</literal>の漸進を示す
86             2次元アニメーションプロットを描画します.
87         </para>
88         <para>
89             このプロットは以下の3つの部分から構成されます:
90             <variablelist>
91                 <varlistentry>
92                     <term>ヘッド</term>
93                     <listitem>
94                         <para>
95                             カレントの位置<literal>(x(i),y(i))</literal>を示すマーカ.
96                         </para>
97                     </listitem>
98                 </varlistentry>
99                 <varlistentry>
100                     <term>ボディ</term>
101                     <listitem>
102                         <para>
103                             ヘッドにつらなる曲線を表示します:曲線の一部
104                             <literal>(x(i-k:i),y(i-k:i))</literal>.
105                         </para>
106                     </listitem>
107                 </varlistentry>
108                 <varlistentry>
109                     <term>テール</term>
110                     <listitem>
111                         <para>
112                             曲線の<literal>(x(1:i-k),y(1:i-k))</literal>の部分を表示.
113                         </para>
114                     </listitem>
115                 </varlistentry>
116             </variablelist>
117             <para>
118                 <literal>comet(x,fun,...)</literal>  は, <literal>comet(x,feval(x,fun),...)</literal> と等価です.
119             </para>
120             <para>
121                 <literal>comet(...,p)</literal> はボディの相対的な長さを設定する
122                 際に使用することができます.
123                 <literal>k</literal> は
124                 <literal>k = round(p*ny)</literal>のように定義できます.
125             </para>
126             <para>
127                 <varname>y</varname> が行列の場合,
128                 曲線のアニメーション表示が,
129                 <literal>(x,y(:,l))</literal>の各組について描画されます.
130                 この場合, <literal>ny</literal> は<varname>y</varname>の
131                 行の数です.
132             </para>
133             <para>
134                 <varname>x</varname> および <varname>y</varname> は
135                 同じ大きさの行列の場合,
136                 各組  <literal>(x(:,l),y(:,l))</literal> 毎に.
137                 アニメーション表示された曲線が描画されます.
138                 この場合, <literal>ny</literal>は
139                 <varname>x</varname>および  <varname>y</varname>の
140                 行の数です.
141             </para>
142             <para>
143                 <literal>comet(...,"colors",c)</literal> は
144                 各曲線の色を設定する際に使用できます.
145             </para>
146         </para>
147     </refsection>
148     <refsection>
149         <title>例</title>
150         <programlisting role="example"><![CDATA[
151 t = linspace(0,10*%pi,500);
152 clf();set(gca(),"isoview","on"); // 等軸に設定
153 comet(t.*sin(t),t.*cos(t))
154     ]]></programlisting>
155         <programlisting role="example"><![CDATA[
156 t = linspace(0,10*%pi,500)';
157 clf();comet(t.*sin(t),[t.*sin(2*t) t.*sin(3*t)])
158     ]]></programlisting>
159         <programlisting role="example"><![CDATA[
160 t = linspace(0,10*%pi,500)';
161 clf();comet(t.*sin(t),[t.*sin(2*t) t.*sin(3*t)],"colors",[3 5])
162     ]]></programlisting>
163         <programlisting role="example"><![CDATA[
164 function y=traj(x),y=1.5*sin(x^2),endfunction
165 clf();comet(linspace(0,5,500),traj)
166     ]]></programlisting>
167         <programlisting role="example"><![CDATA[
168 clf();comet(linspace(-2,4,500),(%s-3)/(%s^3+2*%s^2+1))
169     ]]></programlisting>
170     </refsection>
171     <refsection>
172         <title>参照</title>
173         <simplelist type="inline">
174             <member>
175                 <link linkend="color">color</link>
176             </member>
177             <member>
178                 <link linkend="comet3d">comet3d</link>
179             </member>
180             <member>
181                 <link linkend="paramfplot2d">paramfplot2d</link>
182             </member>
183         </simplelist>
184     </refsection>
185     <refsection>
186         <title>履歴</title>
187         <revhistory>
188             <revision>
189                 <revnumber>5.3.2</revnumber>
190                 <revremark>
191                     関数 <function>comet</function> が導入されました.
192                 </revremark>
193             </revision>
194         </revhistory>
195     </refsection>
196 </refentry>