* Bug 15431 fixed [doc]: empty [] better documented
[scilab.git] / scilab / modules / string / help / ru_RU / 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) DIGITEO - 2012 - Allan CORNET
6  * Copyright (C) 2012 - 2016 - Scilab Enterprises
7  * Copyright (C) 2019 - Samuel GOUGEON
8  *
9  * This file is hereby licensed under the terms of the GNU GPL v2.0,
10  * pursuant to article 5.3.4 of the CeCILL v.2.1.
11  * This file was originally licensed under the terms of the CeCILL v2.1,
12  * and continues to be available under such terms.
13  * For more information, see the COPYING file which you should have received
14  * along with this program.
15  *
16  -->
17 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"
18           xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns4="http://www.w3.org/1999/xhtml"
19           xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook"
20           xmlns:scilab="http://www.scilab.org" xml:id="string" xml:lang="ru">
21     <refnamediv>
22         <refname>string</refname>
23         <refpurpose>преобразование в строку</refpurpose>
24     </refnamediv>
25     <refsynopsisdiv>
26         <title>Синтаксис</title>
27         <synopsis>
28             text = string(x)
29             [out, in, text] = string(SciFun)
30         </synopsis>
31     </refsynopsisdiv>
32     <refsection>
33         <title>Аргументы</title>
34         <variablelist>
35             <varlistentry>
36                 <term>x</term>
37                 <listitem>
38                     <para>
39                         булева, комплексная, вещественная, целочисленная, полиномиальная матрица,
40                         неявный размер, библиотека или функция.
41                     </para>
42                 </listitem>
43             </varlistentry>
44             <varlistentry>
45                 <term>SciFun</term>
46                 <listitem>
47                     <para>
48                         a function in Scilab language (handle of type 13, not its name as a string).
49                     </para>
50                 </listitem>
51             </varlistentry>
52         </variablelist>
53     </refsection>
54     <refsection>
55         <title>Описание</title>
56         <para>
57             Функция <function>string</function> преобразует матрицу
58             <varname>x</varname> в матрицу строк.
59         </para>
60         <para>
61             Если <varname>SciFun</varname> является функцией,
62             то <literal>[out, in, text] = string(SciFun)</literal> возвращает три вектора строк:
63             <itemizedlist>
64                 <listitem>
65                     <varname>out</varname> - вектор выходных переменных,
66                 </listitem>
67                 <listitem>
68                     <varname>in</varname> - вектор входных переменных, а
69                 </listitem>
70                 <listitem>
71                     <varname>text</varname> - вектор (вектор-столбец) исходного кода функции.
72                 </listitem>
73             </itemizedlist>
74         </para>
75         <para>
76             Если <varname>x</varname> является переменной типа
77             <literal>lib</literal> (библиотекой), то <varname>text</varname>
78             является вектор-столбцом символьных строк. Первый элемент содержит
79             путь до файла библиотеки, а другой - имя функций, которые она
80             определяет.
81         </para>
82         <warning>
83             Для комплексной, вещественной, целочисленной, полиномиальной
84             матрицы вывод функции <function>string</function> управляется с
85             помощью функции <link linkend="format">format</link> (см. примеры).
86         </warning>
87         <para>
88             Note that string([]) returns [] (unchanged).
89         </para>
90     </refsection>
91     <refsection>
92         <title>Примеры</title>
93         <programlisting role="example">
94             string(rand(2, 2))
95
96             deff("y = mymacro(x)", "y = x + 1")
97             [out, in, text] = string(mymacro)
98             x = 123.356;
99             disp("Результат равен " + string(x));
100
101             disp("/" + string(~%t) + "/");
102             disp("/" + string(%i+1) + "/");
103             disp("/" + string(int16(-123)) + "/");
104             disp("/" + string(1 + %s + %s^3) + "/");
105
106             string(corelib)
107
108             v = format();
109             disp(string(%pi))
110             format(24);
111             disp(string(%pi))
112             format(v(2))
113
114             string(1:4:$)
115         </programlisting>
116     </refsection>
117     <refsection role="see also">
118         <title>Смотрите также</title>
119         <simplelist type="inline">
120             <member>
121                 <link linkend="format">format</link>
122             </member>
123             <member>
124                 <link linkend="sci2exp">sci2exp</link>
125             </member>
126             <member>
127                 <link linkend="msprintf">msprintf</link>
128             </member>
129             <member>
130                 <link linkend="tree2code">tree2code</link>
131             </member>
132             <member>
133                 <link linkend="pol2str">pol2str</link>
134             </member>
135             <member>
136                 <link linkend="execstr">execstr</link>
137             </member>
138             <member>
139                 <link linkend="evstr">evstr</link>
140             </member>
141             <member>
142                 <link linkend="strtod">strtod</link>
143             </member>
144             <member>
145                 <link linkend="csvTextScan">csvTextScan</link>
146             </member>
147         </simplelist>
148     </refsection>
149     <refsection>
150         <title>История</title>
151         <revhistory>
152             <revision>
153                 <revnumber>5.4.0</revnumber>
154                 <revremark>
155                     implicitlist typeof input accepted.
156                 </revremark>
157             </revision>
158         </revhistory>
159     </refsection>
160 </refentry>