* Bug 15431 fixed [doc]: empty [] better documented
[scilab.git] / scilab / modules / string / help / fr_FR / 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:ns3="http://www.w3.org/1999/xhtml"
18           xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook"
19           xmlns:scilab="http://www.scilab.org" xml:id="string" xml:lang="fr">
20     <refnamediv>
21         <refname>string</refname>
22         <refpurpose>conversion en chaîne de caractères</refpurpose>
23     </refnamediv>
24     <refsynopsisdiv>
25         <title>Séquence d'appel</title>
26         <synopsis>
27             text = string(x)
28             [out, in, text] = string(SciFun)
29         </synopsis>
30     </refsynopsisdiv>
31     <refsection>
32         <title>Paramètres</title>
33         <variablelist>
34             <varlistentry>
35                 <term>x</term>
36                 <listitem>
37                     <para>Booléen, complexe, réel, entier, polynôme matrice,
38                         bibliotheque ou fonction
39                     </para>
40                 </listitem>
41             </varlistentry>
42             <varlistentry>
43                 <term>SciFun</term>
44                 <listitem>
45                     <para>
46                         function en langage Scilab (identifiant de type 13, non son nom comme texte).
47                     </para>
48                 </listitem>
49             </varlistentry>
50         </variablelist>
51     </refsection>
52     <refsection>
53         <title>Description</title>
54         <para>Convertit une matrice en matrice de chaînes de caractères.</para>
55         <para>
56             Si <varname>SciFun</varname> est une fonction,
57             <literal>[out, in, text] = string(SciFun)</literal>
58             retourne 3 vecteurs de chaînes de caractères :
59             <itemizedlist>
60                 <listitem>
61                     <varname>out</varname> est le vecteur des noms de ses variables de sortie,
62                 </listitem>
63                 <listitem>
64                     <varname>in</varname> est le vecteur des noms de ses variables d'entrée, et
65                 </listitem>
66                 <listitem>
67                     <varname>text</varname> est le vecteur colonne des lignes de code source de la fonction.
68                 </listitem>
69             </itemizedlist>
70         </para>
71         <para>
72             Si <varname>x</varname> est une variable bibliotheque
73             <literal>lib</literal>, text est un vecteur colonne de chaînes de
74             caractères. Le premier élément contient le chemin de la bibliothèque et
75             l'autre élément le nom des fonctions qui sont définies dans cette
76             bibliothèque.
77         </para>
78         <warning>
79             pour les types Booléen, complexe, réel, entier, polynôme, fraction rationnelle, le
80             format texte des nombres et coefficients produits par <literal>string</literal>
81             est déterminé par la fonction <link linkend="format">format</link> (voir exemples).
82         </warning>
83         <para>
84             Notez que string([]) renvoie [] (inchangée).
85         </para>
86     </refsection>
87     <refsection>
88         <title>Exemples</title>
89         <programlisting role="example"><![CDATA[
90 string(rand(2, 2))
91
92 deff("y = mymacro(x)", "y = x + 1")
93 [out, in, text] = string(mymacro)
94 x = 123.356;
95 disp("Result is " + string(x));
96
97 disp("/" + string(~%t) + "/");
98 disp("/" + string(%i+1) + "/");
99 disp("/" + string(int16(-123)) + "/");
100 disp("/" + string(1 + %s + %s^3) + "/");
101
102 string(corelib)
103
104 v = format();
105 disp(string(%pi))
106 format(24);
107 disp(string(%pi))
108 format(v(2))
109
110 string(1:4:$)
111  ]]></programlisting>
112     </refsection>
113     <refsection role="see also">
114         <title>Voir aussi</title>
115         <simplelist type="inline">
116             <member>
117                 <link linkend="format">format</link>
118             </member>
119             <member>
120                 <link linkend="sci2exp">sci2exp</link>
121             </member>
122             <member>
123                 <link linkend="msprintf">msprintf</link>
124             </member>
125             <member>
126                 <link linkend="tree2code">tree2code</link>
127             </member>
128             <member>
129                 <link linkend="pol2str">pol2str</link>
130             </member>
131             <member>
132                 <link linkend="execstr">execstr</link>
133             </member>
134             <member>
135                 <link linkend="evstr">evstr</link>
136             </member>
137             <member>
138                 <link linkend="strtod">strtod</link>
139             </member>
140             <member>
141                 <link linkend="csvTextScan">csvTextScan</link>
142             </member>
143         </simplelist>
144     </refsection>
145     <refsection>
146         <title>Historique</title>
147         <revhistory>
148             <revision>
149                 <revnumber>5.4.0</revnumber>
150                 <revremark>
151                     implicitlist typeof input accepted.
152                 </revremark>
153             </revision>
154         </revhistory>
155     </refsection>
156 </refentry>