[doc] misc. patchs & small improvements
[scilab.git] / scilab / modules / io / help / ja_JP / read.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) XXXX-2008 - INRIA
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  -->
16 <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="read">
17     <refnamediv>
18         <refname>read</refname>
19         <refpurpose>行列を読み込む </refpurpose>
20     </refnamediv>
21     <refsynopsisdiv>
22         <title>呼び出し手順</title>
23         <synopsis>x = read(file-desc,m,n,[format])
24             [x]=read(file-desc,m,n,k,format)
25         </synopsis>
26     </refsynopsisdiv>
27     <refsection>
28         <title>パラメータ</title>
29         <variablelist>
30             <varlistentry>
31                 <term>file-desc</term>
32                 <listitem>
33                     <para>ファイル名を指定する文字列または論理ユニットを
34                         指定する整数値(file参照).
35                     </para>
36                 </listitem>
37             </varlistentry>
38             <varlistentry>
39                 <term>m, n</term>
40                 <listitem>
41                     <para>整数 (行列 xの次元).
42                         行の数が未知の場合には m=-1を設定します.
43                         この場合,ファイル全体が読み込まれます.
44                     </para>
45                 </listitem>
46             </varlistentry>
47             <varlistentry>
48                 <term>format</term>
49                 <listitem>
50                     <para>文字列,"Fortran" 形式で指定します. この文字列は右括弧で始まり,
51                         左括弧で終わる必要があります. format では
52                         浮動小数点数または文字列編集モードを混用することができません.
53                     </para>
54                 </listitem>
55             </varlistentry>
56             <varlistentry>
57                 <term>k</term>
58                 <listitem>
59                     <para>整数または整数のベクトル</para>
60                 </listitem>
61             </varlistentry>
62         </variablelist>
63     </refsection>
64     <refsection>
65         <title>説明</title>
66         <para>
67             ファイル<literal>file-desc</literal> (文字列または整数)から
68             <literal>mxn</literal> 行列 <literal>x</literal>
69             (文字連鎖の場合,<literal>n=1</literal>)を行毎に読み込みます.
70             行列<literal>x</literal>の各行は,
71             <literal>file-desc</literal>ファイルの新しい行で
72             始まります.
73             <literal>format</literal>に基づき,
74             <literal>x</literal>行列の指定した行は
75             <literal>file-desc</literal>ファイルの複数の行から読み込む
76             ことができます.
77         </para>
78         <para>
79             結果の型は指定されたformatに依存します.
80             formatが<literal>(d,e,f,g)</literal>記述子のみを有する場合,
81             この関数は数値データを読み込みます(結果は実数の行列です).
82         </para>
83         <para>
84             format が <literal>a</literal>記述子のみを含む場合,
85             この関数は文字列を読み込みます
86             (結果は文字列列ベクトルです).
87             この場合, n は1である必要があります.
88             警告: 文字列の長さが 4093 よりも長い場合,丸められます.
89         </para>
90         <para>
91             <literal>format</literal>の例:
92         </para>
93         <programlisting role=""><![CDATA[
94 (1x,e10.3,5x,3(f3.0))
95 (10x,a20)
96  ]]></programlisting>
97         <para>
98             formatが省略された場合,データが数値フリー形式で読み込まれます:
99             空白,カンマおよびスラッシュをデータセパレータとして
100             使用でき,
101             値 v が n 回現れることを指定するためにn*v を使用できます.
102         </para>
103         <para>
104             読み込むレコード数のベクトル(行毎に1レコード)である
105             パラメータ<literal>k</literal>を使用する場合,
106             ファイルの直接アクセスを使用できます.
107             この場合,<literal>m</literal> は
108             <literal>m=prod(size(k))</literal>となります.
109         </para>
110         <para>
111             キーボードから読み込むには,
112             <literal>read(%io(1),...)</literal>を使用してください.
113         </para>
114         <note>
115             データファイルの最後の行は,  認識されるために,改行で終わる必要があります.
116         </note>
117     </refsection>
118     <refsection>
119         <title>例</title>
120         <programlisting role="example"><![CDATA[
121 if getos() == 'Windows' then unix('del foo');
122 else unix('rm -f foo'); end
123 A=rand(3,5); write('foo',A);
124 B=read('foo',3,5)
125 B=read('foo',-1,5)
126 read(%io(1),1,1,'(a)')  // ユーザ入力を待つ
127  ]]></programlisting>
128     </refsection>
129     <refsection role="see also">
130         <title>参照</title>
131         <simplelist type="inline">
132             <member>
133                 <link linkend="write">write</link>
134             </member>
135             <member>
136                 <link linkend="write">load</link>
137             </member>
138             <member>
139                 <link linkend="file">file</link>
140             </member>
141             <member>
142                 <link linkend="readb">readb</link>
143             </member>
144             <member>
145                 <link linkend="x_dialog">x_dialog</link>
146             </member>
147             <member>
148                 <link linkend="mscanf">mscanf</link>
149             </member>
150             <member>
151                 <link linkend="mfscanf">mfscanf</link>
152             </member>
153             <member>
154                 <link linkend="msscanf">msscanf</link>
155             </member>
156             <member>
157                 <link linkend="fscanfMat">fscanfMat</link>
158             </member>
159         </simplelist>
160     </refsection>
161 </refentry>