Xcos documentation: improve the rendering for data structures
[scilab.git] / scilab / modules / xcos / help / ja_JP / scilab_data_structures / scicos_sim.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!--
3  * Scicos
4  * 
5  * Copyright (C) INRIA - METALAU Project <scicos@inria.fr> (HTML version)
6  * Copyright (C) DIGITEO - Scilab Consortium (XML Docbook version)
7  * 
8  * This program is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License as published by
10  * the Free Software Foundation; either version 2 of the License, or
11  *  (at your option) any later version.
12  * 
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  * 
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the Free Software
20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
21  * 
22  * See the file ./license.txt
23  -->
24 <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="scicos_sim">
25     <refnamediv>
26         <refname>scicos_sim</refname>
27         <refpurpose>sim構造体の定義</refpurpose>
28     </refnamediv>
29     <refsection id="Module_scicos_sim">
30         <title>モジュール</title>
31         <itemizedlist>
32             <listitem>
33                 <para>
34                     <link linkend="xcos">xcos</link>
35                 </para>
36             </listitem>
37         </itemizedlist>
38     </refsection>
39     <refsection id="sim_scicos_sim">
40         <title>sim</title>
41         <para>
42             scs型のScilab型指定リスト(tlist).
43             コンパイル結果に基づく静的配列を保持します.
44             この配列はシミュレーション中に変更されません.
45         </para>
46         <para>
47         </para>
48         <para>
49         </para>
50         <para>
51             大きさ : 33.
52         </para>
53         <para>
54             型 : scilab tlist.
55         </para>
56         <para>
57         </para>
58         <itemizedlist>
59             <listitem>
60                 <para>
61                     <emphasis role="bold">funs</emphasis>
62                 </para>
63                 <para>
64                     計算用関数またはscilab関数の名前を保持するリスト.
65                 </para>
66                 <para> 
67                     大きさ : ブロック数.
68                 </para>
69                 <para>
70                     型 : 文字列またはscilab関数のリスト.
71                 </para>
72             </listitem>
73             <listitem>
74                 <para>
75                     <emphasis role="bold">xptr</emphasis>
76                 </para>
77                 <para> 
78                     連続時間状態量レジスタxへのベクトルポインタ.
79                     ブロックiの連続時間状態量は,
80                     state.x(sim.xptr(i):sim.xptr(i+1)-1) です.
81                 </para>
82                 <para> 
83                     大きさ : ブロック数 + 1.
84                 </para>
85                 <para>
86                     型 : 整数の列ベクトル.
87                 </para>
88             </listitem>
89             <listitem>
90                 <para>
91                     <emphasis role="bold">zptr</emphasis>
92                 </para>
93                 <para> 
94                     離散時間状態量レジスタzへのベクトルポインタ.
95                     ブロックiの離散時間状態量は,
96                     state.z(sim.zptr(i):sim.zptr(i+1)-1) です.
97                 </para>
98                 <para> 
99                     大きさ : ブロック数 + 1.
100                 </para>
101                 <para>
102                     型 : 整数の列ベクトル.
103                 </para>
104             </listitem>
105             <listitem>
106                 <para>
107                     <emphasis role="bold">ozptr</emphasis>
108                 </para>
109                 <para> 
110                     オブジェクト離散状態量レジスタozへのベクトルポインタ.
111                     ブロックiのオブジェクト離散状態量は,
112                     state.oz(sim.ozptr(i):sim.ozptr(i+1)-1) です.
113                 </para>
114                 <para> 
115                     大きさ : ブロック数 + 1.
116                 </para>
117                 <para>
118                     型 : 整数の列ベクトル.
119                 </para>
120             </listitem>
121             <listitem>
122                 <para>
123                     <emphasis role="bold">zcptr</emphasis>
124                 </para>
125                 <para> ゼロ交差面へのベクトルポインタ.</para>
126                 <para> レジスタ. このベクトルは,ブロック毎のゼロ交差の使用数を指定します.
127                 </para>
128                 <para> 
129                     大きさ : ブロック数 + 1.
130                 </para>
131                 <para>
132                     型 : 整数の列ベクトル.
133                 </para>
134             </listitem>
135             <listitem>
136                 <para>
137                     <emphasis role="bold">inpptr</emphasis>
138                 </para>
139                 <para> (sim.inpptr(i+1)-sim.inpptr(i)) 
140                     は,i番目のブロックの標準入力ポートの数を指定します.
141                 </para>
142                 <para> 
143                     inpptr(i) は,間接参照テーブルinplnkの中の
144                     i番目のブロックの入力の先頭を指します.
145                 </para>
146                 <para> 
147                     大きさ : ブロック数 + 1.
148                 </para>
149                 <para>
150                     型 : 整数の列ベクトル.
151                 </para>
152             </listitem>
153             <listitem>
154                 <para>
155                     <emphasis role="bold">outptr</emphasis>
156                 </para>
157                 <para> (sim.outptr(i+1)-sim.outptr(i)) は,
158                     i番目のブロックの標準出力ポートの数を指定します.
159                 </para>
160                 <para> outptr(i) は,
161                     間接参照テーブルoutlnkの中の
162                     i番目のブロックの出力の先頭を指します.
163                 </para>
164                 <para> 
165                     大きさ : ブロック数 + 1.
166                 </para>
167                 <para>
168                     型 : 整数の列ベクトル.
169                 </para>
170             </listitem>
171             <listitem>
172                 <para>
173                     <emphasis role="bold">inplnk</emphasis>
174                 </para>
175                 <para> (cpr.sim.inplnk(cpr.sim.inpptr(i)-1+j)) は,
176                     i番目のブロックのj番目の入力ポートに接続された
177                     リンクの添字です.
178                     ただし,jは1から(cpr.sim.inpptr(i+1)-cpr.sim.inpptr(i))の範囲です.
179                 </para>
180                 <para> 
181                     大きさ : 標準入力ポートの総数.
182                 </para>
183                 <para>
184                     型 : 整数の列ベクトル.
185                 </para>
186             </listitem>
187             <listitem>
188                 <para>
189                     <emphasis role="bold">outlnk</emphasis>
190                 </para>
191                 <para> (cpr.sim.outlnk(cpr.sim.outptr(i)-1+j)) は,
192                     i番目のブロックのj番目の出力ポートに接続された
193                     リンクの添字です.
194                     ただし,jは1から(cpr.sim.outptr(i+1)-cpr.sim.outptr(i)) の範囲です.
195                 </para>
196                 <para> 
197                     大きさ : 標準出力ポートの総数.
198                 </para>
199                 <para>
200                     型 : 整数の列ベクトル.
201                 </para>
202             </listitem>
203             <listitem>
204                 <para>
205                     <emphasis role="bold">rpar</emphasis>
206                 </para>
207                 <para> 
208                     全ブロックの実数パラメータレジスタの結合により得られた
209                     実数パラメータのベクトル
210                 </para>
211                 <para> 
212                     大きさ : 実数パラメータの総数.
213                 </para>
214                 <para>
215                     型 : 実数の列ベクトル.
216                 </para>
217             </listitem>
218             <listitem>
219                 <para>
220                     <emphasis role="bold">rpptr</emphasis>
221                 </para>
222                 <para> 
223                     実数パラメータレジスタrparへのベクトルポインタ.
224                     ブロックiの実数パラメータは,
225                     sim.rpar(sim.rpptr(i):sim.rpptr(i+1)-1) です.
226                 </para>
227                 <para> 
228                     大きさ : ブロック数 + 1.
229                 </para>
230                 <para>
231                     型 : 整数の列ベクトル.
232                 </para>
233             </listitem>
234             <listitem>
235                 <para>
236                     <emphasis role="bold">ipar</emphasis>
237                 </para>
238                 <para> 
239                     全てのブロックの整数パラメータレジスタの結合により得られた
240                     整数パラメータのベクトル.
241                 </para>
242                 <para> 
243                     大きさ : 整数パラメータの総数.
244                 </para>
245                 <para>
246                     型 : 整数の列ベクトル.
247                 </para>
248             </listitem>
249             <listitem>
250                 <para>
251                     <emphasis role="bold">ipptr</emphasis>
252                 </para>
253                 <para> 
254                     整数パラメータレジスタiparを指すベクトルポインタ.
255                     ブロックiの整数パラメータは,
256                     sim.ipar(sim.ipptr(i):sim.ipptr(i+1)-1)です.
257                 </para>
258                 <para> 
259                     大きさ : ブロック数 + 1.
260                 </para>
261                 <para>
262                     型 : 実数の列ベクトル.
263                 </para>
264             </listitem>
265             <listitem>
266                 <para>
267                     <emphasis role="bold">opar</emphasis>
268                 </para>
269                 <para> 
270                     全てのブロックのオブジェクトパラメータのリストの結合により得られた
271                     オブジェクトパラメータのリスト.
272                 </para>
273                 <para> 
274                     大きさ : オブジェクトパラメータの総数.
275                 </para>
276                 <para>
277                     型 : scilabオブジェクトのリスト.
278                 </para>
279             </listitem>
280             <listitem>
281                 <para>
282                     <emphasis role="bold">opptr</emphasis>
283                 </para>
284                 <para> 
285                     オブジェクトパラメータのリストoparを指すベクトルポインタ.
286                     ブロックiのオブジェクトパラメータは,
287                     sim.opar(sim.opptr(i):sim.opptr(i+1)-1) です.
288                 </para>
289                 <para> 
290                     大きさ : ブロック数 + 1.
291                 </para>
292                 <para>
293                     型 : 整数の列ベクトル.
294                 </para>
295             </listitem>
296             <listitem>
297                 <para>
298                     <emphasis role="bold">clkptr</emphasis>
299                 </para>
300                 <para> 
301                     出力アクティベーションポートを指すベクトルポインタ.
302                 </para>
303                 <para> (cpr.sim.clkptr(i):cpr.sim.clkptr(i+1)-1) は
304                     ブロックiの出力イベントポートの数を指定します.
305                 </para>
306                 <para> 
307                     大きさ : ブロック数 + 1.
308                 </para>
309                 <para>
310                     型 : 整数の列ベクトル.
311                 </para>
312             </listitem>
313             <listitem>
314                 <para>
315                     <emphasis role="bold">ordptr</emphasis>
316                 </para>
317                 <para> 
318                     指定したアクティベーションに対応するordclkの場所を指定する
319                     ordclkへのベクトルポインタ.
320                 </para>
321                 <para> (cpr.sim.ordptr(i):cpr.sim.ordptr(i+1)-1) は,
322                     番号iの出力イベントポートによりアクティブとなるブロックの数を示す
323                     ordclk内の範囲を指します.
324                 </para>
325                 <para> 
326                     大きさ : アクティベーションのソースの数 + 1.
327                 </para>
328                 <para>
329                     型 : 整数の列ベクトル.
330                 </para>
331             </listitem>
332             <listitem>
333                 <para>
334                     <emphasis role="bold">execlk</emphasis>
335                 </para>
336                 <para> 不使用.</para>
337                 <para> 
338                     大きさ : -
339                     型 : 実数の行列.
340                 </para>
341             </listitem>
342             <listitem>
343                 <para>
344                     <emphasis role="bold">ordclk</emphasis>
345                 </para>
346                 <para> 
347                     出力アクティベーションポートによりアクティブ化されたブロックに関連付けられた
348                     行列. 最初の列はブロック番号,2列目はブロックがコールされた際のイベントコードを有します.
349                 </para>
350                 <para> 
351                     大きさ : アクティベーションのソースを合計したブロックの総数.
352                 </para>
353                 <para>
354                     型 : 整数行列.
355                 </para>
356             </listitem>
357             <listitem>
358                 <para>
359                     <emphasis role="bold">cord</emphasis>
360                 </para>
361                 <para> 常にアクティブなブロックに関連付けられた行列.</para>
362                 <para> 
363                     最初の列はブロック番号,2列目はブロックがコールされた際のイベントコードを有します.
364                 </para>
365                 <para> 
366                     大きさ : ncord.
367                 </para>
368                 <para>
369                     型 : 整数行列.
370                 </para>
371             </listitem>
372             <listitem>
373                 <para>
374                     <emphasis role="bold">oord</emphasis>
375                 </para>
376                 <para> cordのサブセット. 
377                     連続系状態量の微係数の計算に作用する出力を有する行列のブロック.
378                 </para>
379                 <para> 
380                     大きさ : noord.
381                 </para>
382                 <para>
383                     型 : 整数行列.
384                 </para>
385             </listitem>
386             <listitem>
387                 <para>
388                     <emphasis role="bold">zord</emphasis>
389                 </para>
390                 <para> zordのサブセット. 
391                     ゼロ交差面の計算に作用する出力を有する行列のブロック.
392                 </para>
393                 <para> 
394                     大きさ : nzord.
395                 </para>
396                 <para>
397                     型 : 整数行列.
398                 </para>
399             </listitem>
400             <listitem>
401                 <para>
402                     <emphasis role="bold">critev</emphasis>
403                 </para>
404                 <para> 
405                     アクティベーションの数と同じ大きさのベクトルで,その値は0または1です.
406                     値1は,
407                     連続時間ソルバーをコールドスタートする必要があるという意味で,
408                     アクティベーションがクリティカルであることを示します.
409                 </para>
410                 <para> 
411                     大きさ : アクティベーションのソースの数.
412                 </para>
413                 <para>
414                     型 : 整数の列ベクトル.
415                 </para>
416             </listitem>
417             <listitem>
418                 <para>
419                     <emphasis role="bold">nb</emphasis>
420                 </para>
421                 <para> 
422                     ブロックの数. 
423                     このブロック数は,
424                     c_pass2がいくつかの条件ブロックで二重化される可能性があるため,
425                     ダイアグラムの元のブロック数と異なる可能性があることに注意してください.
426                 </para>
427                 <para> 
428                     大きさ : 1.
429                 </para>
430                 <para>
431                     型 : 整数.
432                 </para>
433             </listitem>
434             <listitem>
435                 <para>
436                     <emphasis role="bold">ztyp</emphasis>
437                 </para>
438                 <para> ブロック数と同じ大きさのベクトル.</para>
439                 <para> 
440                     エントリ1は,
441                     ダイアグラムのコンテキストに現れないとしても,
442                     このブロックがゼロ交差する可能性があることを示します.
443                     通常,シミュレータでは使用されません.
444                 </para>
445                 <para> 
446                     大きさ : ブロック数.
447                 </para>
448                 <para>
449                     型 : 整数の列ベクトル.
450                 </para>
451             </listitem>
452             <listitem>
453                 <para>
454                     <emphasis role="bold">nblk</emphasis>
455                 </para>
456                 <para> 非使用. nbに設定.</para>
457                 <para> 
458                     大きさ : 1
459                     型 : 整数.
460                 </para>
461             </listitem>
462             <listitem>
463                 <para>
464                     <emphasis role="bold">ndcblk</emphasis>
465                 </para>
466                 <para> 非使用.</para>
467                 <para> 
468                     大きさ : -
469                     型 : 整数.
470                 </para>
471             </listitem>
472             <listitem>
473                 <para>
474                     <emphasis role="bold">subscr</emphasis>
475                 </para>
476                 <para> 非使用.</para>
477                 <para> 
478                     大きさ : 0
479                     型 : empty real.
480                 </para>
481             </listitem>
482             <listitem>
483                 <para>
484                     <emphasis role="bold">funtyp</emphasis>
485                 </para>
486                 <para>
487                     ブロックの計算用関数の型を示すブロックの数と同じ大きさのベクトル.
488                     ブロック型は 0 から 5の範囲です.
489                 </para>
490                 <para> 
491                     現在では,4型 (C言語) および5型(Scilab言語)の計算用関数のみを使用することが
492                     規定されています.しかし,古いブロックも使用できます.
493                 </para>
494                 <para> 
495                     大きさ : ブロック数.
496                 </para>
497                 <para>
498                     型 : 整数列ベクトル.
499                 </para>
500             </listitem>
501             <listitem>
502                 <para>
503                     <emphasis role="bold">iord</emphasis>
504                 </para>
505                 <para> 
506                     シミュレーションの開始時にアクティブ化されるブロックに関連付けられた行列.
507                     この行列は,定数ブロックおよび常にアクティブなブロックから継承した
508                     ブロックを有します.
509                 </para>
510                 <para> 
511                     大きさ : niord.
512                 </para>
513                 <para>
514                     型 : 整数行列.
515                 </para>
516             </listitem>
517             <listitem>
518                 <para>
519                     <emphasis role="bold">labels</emphasis>
520                 </para>
521                 <para> 
522                     ブロックのラベルを保持するブロックの数と同じ大きさの文字列ベクトル.
523                 </para>
524                 <para> 
525                     大きさ : ブロック数.
526                 </para>
527                 <para>
528                     型 : 文字列の列ベクトル.
529                 </para>
530             </listitem>
531             <listitem>
532                 <para>
533                     <emphasis role="bold">modptr</emphasis>
534                 </para>
535                 <para> ブロックモードへのベクトルポインタ.</para>
536                 <para> 
537                     大きさ : ブロック数 + 1.
538                 </para>
539                 <para>
540                     型 : 整数の列ベクトル.
541                 </para>
542             </listitem>
543         </itemizedlist>
544     </refsection>
545     <refsection id="Filecontent_scicos_sim">
546         <title>ファイルの内容</title>
547         <itemizedlist>
548             <listitem>
549                 <para> SCI/modules/scicos/macros/scicos_scicos/scicos_sim.sci</para>
550             </listitem>
551         </itemizedlist>
552     </refsection>
553 </refentry>