1 <?xml version="1.0" encoding="UTF-8"?>
2 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="save_format" xml:lang="ja">
4 <refname>save_format</refname>
5 <refpurpose>"save"で作成されるファイルの形式</refpurpose>
9 <para>本文書の目的はデータをScilabでデータ保存に使用されるHDF5形式について規定することです.
11 <para>この形式はSOD (Scilab Open Data) と呼ばれます.</para>
12 <para>SODの最初の公開リリースは Scilab 5.4.0で行われました.</para>
17 相互運用性は近代的なソフトウエアの主要な特性の一つです.
18 この特性をより改善するため, このSEPにおいて HDF5 形式の標準定義
23 エキスポート/インポート機能が開発され, データ交換用に管理されています.
24 これは, 既にデータを保存および交換するためのXcosの基本要素の一つです.
28 <title>サポートされるデータ型</title>
29 <para>全てのScilabデータ型がサポートされます. 例えば:</para>
30 <informaltable border="1">
34 <emphasis role="bold">名前</emphasis>
37 <emphasis role="bold">Scilabにおける例</emphasis>
42 <emphasis role="bold">double</emphasis>
53 <emphasis role="bold">string</emphasis>
57 b=["string 1";"my string 2"];
62 <emphasis role="bold">boolean</emphasis>
71 <emphasis role="bold">integer</emphasis>
75 int8([1 -120 127 312])
82 <emphasis role="bold">polynomial</emphasis>
93 <emphasis role="bold">sparse</emphasis>
97 sp=sparse([1,2;4,5;3,10],[1,2,3])
103 <emphasis role="bold">boolean sparse</emphasis>
107 dense=[%F, %F, %T, %F, %F
117 <emphasis role="bold">list</emphasis>
121 l = list(1,["a" "b"])
127 <emphasis role="bold">tlist</emphasis>
131 t = tlist(["listtype","field1","field2"], [], []);
137 <emphasis role="bold">mlist</emphasis>
141 M=mlist(['V','name','value'],['a','b';'c' 'd'],[1 2; 3 4]);
148 複数の"types"は,<emphasis>tlist</emphasis> または <emphasis>mlist</emphasis>
151 <emphasis>rational</emphasis>, <emphasis>state-space</emphasis>,
152 <emphasis>cell</emphasis> および
153 <emphasis>struct</emphasis>の場合です.
157 <emphasis>void</emphasis>および <emphasis>undefined</emphasis>は,
158 リスト管理において特別な場合を管理するために作成された特殊な要素です.
163 <title>HDF5ファイルの構造</title>
164 <para>Scilab HDF5 アーキテクチャは非常に簡単です. </para>
165 <emphasis role="bold">General</emphasis>
167 各Scilab変数について, ルート位置におけるデータセットが宣言されます.
168 データセットの名前はScilab変数の名前です.
170 <para>例, 以下のコード:</para>
172 emptyuint32matrix = uint32([]);
173 uint32scalar = uint32(1);
174 uint32rowvector = uint32([1 4 7]);
175 uint32colvector = uint32([1;4;7]);
176 uint32matrix = uint32([1 4 7;9 6 3]);
177 save("uint32.sod","emptyuint32matrix","uint32scalar","uint32rowvector","uint32colvector","uint32matrix");
179 <para>produces:</para>
182 <imagedata fileref="../images/img001.png"/>
186 各ルートデータセットは<literal>SCILAB_Class</literal>と呼ばれる
187 属性を有します.この属性は, HDF5ファイルに保持される変数の型を定義します.
190 変数がプリミティブ型で関連する複合値がない場合,
192 それ以外の場合, データセットは実際のデータへのリファレンスを有します.
194 <para>各 SOD ファイルは2つの固有の変数を有します:</para>
198 <literal>SCILAB_scilab_version</literal> ?
199 SODファイルに保存する際に使用された Scilabのバージョンを記述します.
201 <para>例えば, Scilab 5.4.0の場合, このデータは以下となります:</para>
203 <emphasis>SCILAB_scilab_version = scilab-5.4.0</emphasis>
207 <para>SCILAB_sod_version ?
208 SODファイルに保存する際に使用された SOD規約のバージョンを記述します.
210 <para>例えば, Scilab 5.4.0の場合, このデータは以下となります:</para>
212 <emphasis>SCILAB_sod_version = 2</emphasis>
217 データがデータセット内で直線的に保存される型
219 <informaltable border="1">
223 <emphasis role="bold">Scilab 型</emphasis>
226 <emphasis role="bold">HDF5 Scilab 型属性</emphasis>
229 <emphasis role="bold">HDF5 属性</emphasis>
232 <emphasis role="bold">HDF データ型マッピング</emphasis>
240 <para>SCILAB_Class = string</para>
253 <td namest="c2" nameend="c3" align="left">
254 <para>SCILAB_Class = boolean</para>
260 <para>32ビット 整数</para>
267 <td namest="c2" nameend="c3" align="left">
268 <para>SCILAB_Class = integer</para>
271 <para>SCILAB_precision = {8, 16, 32, u8, u16, u32}</para>
273 <td namest="c1" nameend="c2" align="left">
274 <para>8 = 8ビット文字</para>
275 <para>16 = 16ビット整数</para>
276 <para>32 = 32ビット整数</para>
277 <para>u8 = 8ビット符号無し文字</para>
278 <para>u16 = 16ビット符号無し整数</para>
279 <para>u32 = 32ビット符号無し整数</para>
285 これらの型について, Scilabにおける場合と同様に,
286 データは1次元配列に保存されます.データは列方向に保存されます.
289 行列, ベクトルまたはスカラーを再構築するために,
293 5.4.0リリースおよび SOD v2以降,
294 <literal>SCILAB_cols</literal> および<literal>SCILAB_rows</literal> は
295 double, 整数, 多項式および文字列の行列ではもはや使用されなくなりました.
296 SOD はネーティブな多次元HDF5機能を使用します.
299 <emphasis role="bold">例</emphasis>
302 宣言の保存: <code>int32([1 -4 7;-9 6 -3])</code> は,hdfviewで以下のように表示されます:
306 <imagedata fileref="../images/img002.png"/>
309 <para>metadataは以下のようになります:</para>
310 <emphasis role="italic">
311 <para>int32matrix (800, 2)</para>
312 <para>32-bit integer, 3 x 2 => the size of the variable</para>
313 <para>Number of attributes = 2</para>
314 <para>SCILAB_Class = integer</para>
315 <para>SCILAB_precision = 32</para>
319 スカラー値は1行1列の行列に保存されます.
323 空の変数 (<literal>[]</literal>) はtrueに設定された属性<literal>SCILAB_empty</literal>を有します.
326 <emphasis role="bold">データが専用のグループに保存される型</emphasis>
329 Scilabデータ型の多くはグループで保存されます.
330 これにより,値の分離を明確にでき,アクセスも容易になります.
333 グループは"#"で括られた変数から命名されます.例えば,
334 matrixofdoubleと呼ばれるdoubleの行列の場合,
335 ルートデータセットの名前は matrixofdoubleとなり,
337 <emphasis role="strong">#matrixofdouble#</emphasis>となります.
340 再帰的なデータ型(list, mlist, tlist, etc)の場合,
341 サブグループの名前が以下のように構築されます:
344 この <literal>#</literal> によりユニークなIDを作成できるようになります.
345 最初の<literal>#</literal>の数は深さのレベルを示します.
346 例えば, サブリスト <emphasis>###listnested#_#2##_#1##</emphasis>は,
347 2番目のレベ得るに位置することを示します.
350 アンダースコア "_" は深さを表す手段です.
351 通常, "/" 文字がこのような場合に使用されますが,
352 HDF5規約では予約済みキーワードとなっています.
356 カレントの構造における位置と親要素に関する位置の両方の意味で
359 <emphasis>###listnested#_#2##_#1##</emphasis>,
360 は,親要素の3番目の構造の2番目の要素として扱われることを示します
364 例えば, <emphasis>###listnested#_#2##_#1##</emphasis>という名前のグループは,
365 以下の例では値 [32, 42] を指します:
368 listnested=list(2,%i,'f',ones(3,3))
369 listnested(3) = list( %t, [32,42]);
372 <emphasis role="bold">疎行列</emphasis>
375 <emphasis role="strong">Scilab 型:</emphasis> sparse
378 <emphasis role="strong">HDF5 Scilab 型属性:</emphasis> SCILAB_Class = sparse
381 <emphasis role="strong">HDF5 属性: </emphasis>
383 <para>SCILAB_rows = <int></para>
386 <emphasis>SCILAB_cols = <int></emphasis>
390 <emphasis>SCILAB_items = <int></emphasis>
392 <para>疎行列における要素数を定義</para>
394 <emphasis role="strong">ルートデータセットの値:</emphasis>
397 最初の値 (<literal>#0#</literal>):
398 このデータ構造の各要素は各行の非ヌル要素の数を示します.
399 つまり, 最初の要素は疎行列の最初の行の要素数を示します.
402 2番目の値 (<literal>#1#</literal>):
406 3番目の値 (<literal>#2#</literal>):
407 疎行列における要素の実際の値へのリファレンスを保存します
408 (この値は専用のグループに保存されます).
410 <para>例えば, この行列を考えると:</para>
411 <programlisting role="no-scilab-exec">
412 0. 1. 0. 0. 0. 0. 0. 0. 0. 0.
413 0. 0. 0. 0. 0. 0. 0. 0. 0. 0.
414 0. 0. 0. 0. 0. 0. 0. 0. 0. 3.
415 0. 0. 0. 0. 2. 0. 0. 0. 0. 0.
417 <para>これは以下の関数で生成されます:</para>
418 <programlisting role="scilab_code">
419 sparse([1,2;4,5;3,10],[1,2,3])
425 <emphasis>#0#</emphasis> は,<emphasis>1;0;1;1</emphasis>を有します
428 <emphasis>#1#</emphasis> は,<emphasis>2;10;5</emphasis>を有します
431 <emphasis>#2#</emphasis> は,<emphasis>1.0; 3.0; 2.0</emphasis>を有する
432 double(この例では複素数ではありません)の行列を参照します
435 <emphasis role="bold">論理値疎行列</emphasis>
438 <emphasis role="strong">Scilab型:</emphasis> boolean sparse
441 <emphasis role="strong">HDF5 Scilab 型属性:</emphasis> SCILAB_Class = boolean sparse
444 <emphasis>HDF5属性:</emphasis>
447 <emphasis>SCILAB_rows = <int></emphasis>
451 <emphasis>SCILAB_cols = <int></emphasis>
455 <emphasis>SCILAB_items = <int></emphasis>
457 <para>疎行列の要素数を定義</para>
459 <emphasis role="strong">ルートデータセットの値:</emphasis> 疎行列は3つのデータセットを有しますが,
460 論理値疎行列は2つのみです.これは定義される値は自動的にtrueとみなされるためです.
463 最初の値 (<literal>#0#</literal>): このデータ構造の各要素は各行の非ゼロ要素の数を示します.
466 つまり, 最初の要素は疎行列の最初の行の要素数を示します.
469 2番目の値 (<literal>#1#</literal>):
472 <para>以下の論理値疎行列について:</para>
474 dense=[%F, %F, %T, %F, %F
480 <emphasis>#0#</emphasis> は <emphasis>1;1;0;1</emphasis>を有します.
483 <emphasis>#1#</emphasis> は <emphasis>3;1;5</emphasis>を有します.
486 論理値疎行列を再生するために必要な情報は2つのみです.
488 <para>HDFデータ型マッピング:</para>
491 <emphasis role="bold">Double</emphasis>
494 <emphasis role="strong">Scilab 型:</emphasis> double
497 <emphasis role="strong">HDF5 Scilab 型属性:</emphasis> SCILAB_Class = double
500 <emphasis role="strong">ルートデータセットの値:</emphasis>
501 実数および複素数の値は共に<literal>#<variable name>#</literal>と
505 最初の値: 実数値へのリファレンス. 名前は<literal>#0#</literal>.
508 行列が複素数の場合, 2番目の値は複素数の値へのリファレンスとなります. 名前は<literal>#1#</literal>.
511 <emphasis role="strong">HDF データ型マッピング:</emphasis> 64-bit floating-point
514 <emphasis role="bold">多項式</emphasis>
517 <emphasis role="strong">Scilab 型:</emphasis> polynomial
520 <emphasis role="strong">HDF5 Scilab 型属性:</emphasis> SCILAB_Class = polynomial
523 <emphasis role="strong">HDF5 属性: </emphasis>
525 <para>SCILAB_Class = polynomial</para>
526 <para>SCILAB_varname = <string></para>
527 <para>シンボル変数の名前</para>
529 <emphasis>SCILAB_Complex = <boolean></emphasis>
531 <para>多項式が複素数の場合 (そうでない場合は設定されません)</para>
533 <emphasis role="strong">ルートデータセットの値:</emphasis>
536 係数はdoubleの行列の形式で(double記憶領域の関連部分に)保存されます.
537 係数は,複素数にできるため,複素数の行列に保存されることに注意してください.
538 (サブ)グループとデータセットの命名規則は
542 <emphasis role="strong">HDF データ型マッピング:</emphasis> Object reference
545 <emphasis role="bold">list</emphasis>
548 <emphasis role="strong">Scilab 型:</emphasis> list
551 <emphasis role="strong">HDF5 Scilab 型属性:</emphasis>
553 <para>SCILAB_Class = list</para>
555 <emphasis role="strong">HDF5 属性:</emphasis> SCILAB_items = <リストの要素数>
558 <emphasis role="strong">ルートデータセットの値:</emphasis>
561 ルートデータセットに関連して,このデータセットで保存される値は
562 リストに保存された値へのリファレンスです.
563 値は<literal>#<variable name>#</literal>と呼ばれるグループに保存されます.
564 この <literal>#<variable name>#</literal> グループにおいて,
567 その表現は他の場合と同様で,再帰的な構造にもとづきます
568 (種々の型のリストのリストのリストが保存および読込みできることを意味します).
571 (サブ)グループとデータセットの命名規則は本章の先頭に記述されています.
574 <emphasis role="strong">HDF データ型マッピング:</emphasis> Object reference
577 <emphasis role="bold">tlist </emphasis>
580 <emphasis role="strong">Scilab型:</emphasis> tlist
583 <emphasis role="strong">HDF5 Scilab 型属性:</emphasis>
585 <para> SCILAB_Class = tlist</para>
587 <emphasis role="strong">HDF5 属性:</emphasis> cf list
590 <emphasis role="bold">mlist </emphasis>
593 <emphasis role="strong">Scilab type:</emphasis> mlist
596 <emphasis role="strong">HDF5 Scilab 型属性:</emphasis>
598 <para>SCILAB_Class = mlist</para>
600 <emphasis role="strong">HDF5 attributes:</emphasis> cf list
603 <emphasis role="bold">void </emphasis>
606 <emphasis role="strong">Scilab型:</emphasis> void
609 <emphasis role="strong">HDF5 Scilab 型属性:</emphasis>
611 <para>SCILAB_Class = void</para>
613 void値はlist, tlistおよびmlistの非常に特殊な使用法でのみ
617 <programlisting>voidelement_ref=list(1,,3);</programlisting>
619 <emphasis role="bold">undefined </emphasis>
622 <emphasis role="strong">Scilab 型:</emphasis> undefined
625 <emphasis role="strong">HDF5 Scilab 型属性:</emphasis>
627 <para> SCILAB_Class = undefined</para>
629 undefined 値はリストの大きさが増加し, いくつかの要素が未定義となった
634 undefinedelement_ref=list(2,%i,'f',ones(3,3));
635 undefinedelement_ref(6)="toto"
641 これらの変数全てについてサンプルファイルがScilabディストリビューションで
643 これらは,以下のディレクトリで入手可能です:
644 <emphasis>SCI/modules/hdf5/tests/sample_scilab_data/</emphasis>
648 以下のファイルがScilabディストリビューションで提供されています:
650 <emphasis role="italic">
654 <para>booleanscalar.sod
656 <para>booleansparse.sod
658 <para>emptymatrix.sod
660 <para>emptysparse.sod
662 <para>hypermatrixcomplex.sod
664 <para>hypermatrix.sod
676 <para>matricedoublecomplexscalar.sod
678 <para>matricedoublecomplex.sod
680 <para>matricedoublescalar.sod
682 <para>matricedouble.sod
684 <para>matricestringscalar.sod
686 <para>matricestring.sod
690 <para>polynomialscoef.sod
692 <para>polynomials.sod
694 <para>sparsematrix.sod
704 <para>undefinedelement.sod
706 <para>voidelement.sod
711 <title>フォーマットの進化</title>
712 <informaltable border="1">
716 <emphasis role="bold">SOD バージョン</emphasis>
719 <emphasis role="bold">Scilab バージョン</emphasis>
722 <emphasis role="bold">説明</emphasis>
733 <para>Scilab/HDF5 形式の最初のバージョン</para>
741 <para>5.4.0 alpha / beta</para>
744 <para>読込み/保存のデフォルト形式</para>
745 <para>前の形式 (.bin) はまだサポートされます</para>
757 double, 整数, 多項式および文字列について,
759 <emphasis>SCILAB_cols</emphasis> / <emphasis>SCILAB_rows</emphasis>
772 <para>.bin サポートを廃止.</para>
778 <refsection role="see also">
780 <simplelist type="inline">
782 <link linkend="save">save</link>
785 <link linkend="load">load</link>
788 <link linkend="listvarinfile">listvarinfile</link>
791 <link linkend="type">type</link>
794 <link linkend="typeof">typeof</link>