Revert f56158b2 "[doc] string pages improved" for specific files where
[scilab.git] / scilab / modules / string / help / en_US / emptystr.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  *
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="en" xml:id="emptystr">
17     <refnamediv>
18         <refname>emptystr</refname>
19         <refpurpose>zero length string</refpurpose>
20     </refnamediv>
21     <refsynopsisdiv>
22         <title>Syntax</title>
23         <synopsis>s = emptystr()
24             s = emptystr(a)
25             s = emptystr(m, n)
26         </synopsis>
27     </refsynopsisdiv>
28     <refsection>
29         <title>Arguments</title>
30         <variablelist>
31             <varlistentry>
32                 <term>a</term>
33                 <listitem>
34                     <para>
35                         a matrix of size <literal>mx n</literal>.
36                     </para>
37                 </listitem>
38             </varlistentry>
39             <varlistentry>
40                 <term>s</term>
41                 <listitem>
42                     <para>a matrix of character strings.</para>
43                 </listitem>
44             </varlistentry>
45             <varlistentry>
46                 <term>m, n</term>
47                 <listitem>
48                     <para>integers</para>
49                 </listitem>
50             </varlistentry>
51         </variablelist>
52     </refsection>
53     <refsection>
54         <title>Description</title>
55         <para>
56             The <function>emptystr</function> function returns a matrix of zero
57             length character strings.
58         </para>
59         <para>
60             With no input argument <function>emptystr</function> returns a zero
61             length character string.
62         </para>
63         <para>
64             With a matrix <varname>a</varname> for input argument
65             <function>emptystr</function> returns a zero length character
66             strings matrix of the same size.
67         </para>
68         <para>
69             With two integer arguments <function>emptystr</function> returns a
70             <varname>m</varname> <literal>x</literal> <varname>n</varname> zero
71             length character strings matrix.
72         </para>
73     </refsection>
74     <refsection>
75         <title>Examples</title>
76         <programlisting role="example"><![CDATA[
77 x=emptystr();
78 for k=1:10
79     x = x + ',' + string(k)
80     emptystr(1,k) + string(k)
81 end
82  ]]></programlisting>
83     </refsection>
84     <refsection role="see also">
85         <title>See also</title>
86         <simplelist type="inline">
87             <member>
88                 <link linkend="part">part</link>
89             </member>
90             <member>
91                 <link linkend="length">length</link>
92             </member>
93             <member>
94                 <link linkend="string">string</link>
95             </member>
96         </simplelist>
97     </refsection>
98 </refentry>