* Bug 15431 fixed [doc]: empty [] better documented
[scilab.git] / scilab / modules / string / help / ja_JP / string.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 -
5  * Copyright (C) 2012 - 2016 - Scilab Enterprises
6  * Copyright (C) 2019 - Samuel GOUGEON
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"
17           xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML"
18           xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org"
19           xml:lang="ja" xml:id="string">
20     <refnamediv>
21         <refname>string</refname>
22         <refpurpose>文字列に変換</refpurpose>
23     </refnamediv>
24     <refsynopsisdiv>
25         <title>呼び出し手順</title>
26         <synopsis>
27             text = string(x)
28             [out, in, text] = string(SciFun)
29         </synopsis>
30     </refsynopsisdiv>
31     <refsection>
32         <title>引数</title>
33         <variablelist>
34             <varlistentry>
35                 <term>x</term>
36                 <listitem>
37                     <para>
38                         論理値, 複素数, 実数, 整数, 多項式行列, 暗黙の大きさ, またはライブラリ.
39                     </para>
40                 </listitem>
41             </varlistentry>
42             <varlistentry>
43                 <term>SciFun</term>
44                 <listitem>
45                     <para>
46                         a function in Scilab language (handle of type 13, not its name as a string).
47                     </para>
48                 </listitem>
49             </varlistentry>
50         </variablelist>
51     </refsection>
52     <refsection>
53         <title>説明</title>
54         <para>
55             <function>string</function>関数は
56             行列<varname>x</varname> を文字列の行列に変換します.
57         </para>
58         <para>
59             <literal>SciFun</literal>が関数の場合,
60             <code>[out, in, text] = string(SciFun)</code> は
61             3つの文字列ベクトルを返します:
62             <itemizedlist>
63                 <listitem>
64                     <varname>out</varname> は出力変数のベクトル,
65                 </listitem>
66                 <listitem>
67                     <varname>in</varname> は入力変数のベクトル, そして
68                 </listitem>
69                 <listitem>
70                     <varname>text</varname> は関数のソースコードの(列)ベクトルです.
71                 </listitem>
72             </itemizedlist>
73         </para>
74         <para>
75             <literal>x</literal>が <literal>lib</literal>変数の場合,
76             <varname>text</varname>は文字列の列ベクトルとなります.
77             最初の要素は,ライブラリファイルのパス,
78             その他の要素は定義する関数の名前を有します.
79         </para>
80         <warning>
81             複素数, 実数, 整数, 多項式行列の場合,
82             <function>string</function> の出力は
83             <link linkend="format">format</link> function (例参照)で管理されます.
84         </warning>
85         <para>
86             string([]) は []を返すことに注意してください.
87         </para>
88     </refsection>
89     <refsection>
90         <title>例</title>
91         <programlisting role="example"><![CDATA[
92             string(rand(2, 2))
93
94             deff("y = mymacro(x)", "y = x + 1")
95             [out, in, text] = string(mymacro)
96             x = 123.356;
97             disp("Result is " + string(x));
98
99             disp("/" + string(~%t) + "/");
100             disp("/" + string(%i+1) + "/");
101             disp("/" + string(int16(-123)) + "/");
102             disp("/" + string(1 + %s + %s^3) + "/");
103
104             string(corelib)
105
106             v = format();
107             disp(string(%pi))
108             format(24);
109             disp(string(%pi))
110             format(v(2))
111
112             string(1:4:$)
113  ]]></programlisting>
114     </refsection>
115     <refsection role="see also">
116         <title>参照</title>
117         <simplelist type="inline">
118             <member>
119                 <link linkend="format">format</link>
120             </member>
121             <member>
122                 <link linkend="sci2exp">sci2exp</link>
123             </member>
124             <member>
125                 <link linkend="msprintf">msprintf</link>
126             </member>
127             <member>
128                 <link linkend="tree2code">tree2code</link>
129             </member>
130             <member>
131                 <link linkend="pol2str">pol2str</link>
132             </member>
133             <member>
134                 <link linkend="execstr">execstr</link>
135             </member>
136             <member>
137                 <link linkend="evstr">evstr</link>
138             </member>
139             <member>
140                 <link linkend="strtod">strtod</link>
141             </member>
142             <member>
143                 <link linkend="csvTextScan">csvTextScan</link>
144             </member>
145         </simplelist>
146     </refsection>
147     <refsection>
148         <title>履歴</title>
149         <revhistory>
150             <revision>
151                 <revnumber>5.4.0</revnumber>
152                 <revremark>
153                     暗黙の大きさの型が入力引数として管理されます.
154                 </revremark>
155             </revision>
156         </revhistory>
157     </refsection>
158 </refentry>