help format: (fr) added
[scilab.git] / scilab / modules / elementary_functions / help / fr_FR / floating_point / format.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) 2016 - Samuel GOUGEON
5  * Copyright (C) 2012 - 2016 - Scilab Enterprises
6  *
7  * This file is hereby licensed under the terms of the GNU GPL v2.0,
8  * pursuant to article 5.3.4 of the CeCILL v.2.1.
9  * This file was originally licensed under the terms of the CeCILL v2.1,
10  * and continues to be available under such terms.
11  * For more information, see the COPYING file which you should have received
12  * along with this program.
13  *
14  -->
15 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"
16           xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml"
17                   xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook"
18                   xmlns:scilab="http://www.scilab.org" xml:id="format" xml:lang="fr">
19     <refnamediv>
20         <refname>format</refname>
21         <refpurpose>configure le format par défaut d'affichage des nombres décimaux</refpurpose>
22     </refnamediv>
23     <refsynopsisdiv>
24         <title>Syntaxe</title>
25         <synopsis>
26             format(mode)
27             format(width)
28             format(mode, width)
29             format(wm)
30             v = format()
31         </synopsis>
32     </refsynopsisdiv>
33     <refsection role="parameters">
34         <title>Paramètres</title>
35         <variablelist>
36             <varlistentry>
37                 <term>mode</term>
38                 <listitem>
39                     <para>Type d'affichage :
40                         <itemizedlist>
41                           <listitem>1 or "v": format
42                             <emphasis role="bold">v</emphasis>ariable auto-adaptatif
43                             (automatique) : pour chaque nombre décimal ou complexe
44                             à afficher, Scilab choisit soit la représentation
45                             directe (ex: -143.8757), soit le format scientifique
46                             avec <emphasis role="bold">e</emphasis>xposant
47                             (ex: -1.438E+02) le plus adapté, permettant d'afficher
48                             un maximum de digits de la mantisse.
49                           </listitem>
50                           <listitem>
51                               0 or "e": force l'utilisation du format scientifique
52                               avec <emphasis role="bold">e</emphasis>xposant, pour
53                               tous les nombres décimaux.
54                           </listitem>
55                       </itemizedlist>
56                   </para>
57                 </listitem>
58             </varlistentry>
59             <varlistentry>
60                 <term>width</term>
61                 <listitem>
62                     <para>
63                         largeur des nombres = nombre total de caractères utilisé
64                         pour chaque nombre, tout inclus : signe et digits de la
65                         mantisse, séparateur décimal ("."), symbole de l'exposant
66                         ("D", "E"), signe et digits de l'exposant. Par défaut,
67                         <literal>width = 10</literal> caractères sont utilisés.
68                     </para>
69                 </listitem>
70             </varlistentry>
71             <varlistentry>
72                 <term>wm</term>
73                 <listitem>
74                     <para>vecteur de 2 entiers configurant le format :</para>
75                     <para><literal>wm(1)</literal> est la largeur des nombres</para>
76                     <para><literal>wm(2)</literal> est le type du format :
77                       0 pour <literal>'e'</literal> et 1 pour <literal>'v'</literal>
78                     </para>
79                 </listitem>
80             </varlistentry>
81             <varlistentry>
82                 <term>v</term>
83                 <listitem>
84                     <para>vecteur à 2 nombres retournés comme paramètres du format actif :
85                         <itemizedlist>
86                           <listitem><literal>v(1)</literal> représente le type du format :
87                             0 pour <literal>'e'</literal> et 1 pour <literal>'v'</literal>
88                           </listitem>
89                           <listitem><literal>v(2)</literal> est le nombre de
90                             caractères utilisés pour formater chaque nombre.
91                           </listitem>
92                          </itemizedlist>
93                      </para>
94                  </listitem>
95             </varlistentry>
96         </variablelist>
97     </refsection>
98     <refsection role="description">
99         <title>Description</title>
100         <note>Pour les nombres complexes, chaque partie réelle et imaginaire
101         décimale est formatée selon <literal>format(..)</literal>.
102         La largeur totale d'un nombre complexe est par conséquent deux fois
103         celle spécifiée par <literal>format(..)</literal> + 1 caractère
104         (symbole "i").
105         </note>
106         <note>
107             Les entiers encodés ne sont jamais formatables/formatés selon
108             la notation "e"xponentielle, même si ce format est forcé pour
109             les nombres décimaux. Pour eux, le séparateur décimal "." est
110             inutile et n'apparait pas. Cette absence permet de les distinguer
111             des entiers décimaux, qui eux présentent un ".".
112         </note>
113         <note>
114             Le choix d'un format() large permet de faire apparaitre des
115             digits au delà de la précision relative <literal>%eps</literal>.
116             Ceux-ci sont alors mis à zéro.
117         </note>
118         <warning>Le format décimal fixé avec
119             <function>format(..)</function> est un paramètre global :
120             quel que soit le lieu où il est utilisé, il est ensuite appliqué
121             partout dans Scilab et Xcos.
122         </warning>
123         <para>Dans les versions anciennes de Scilab, en format automatique "v",
124             les éléments d'une matrice inférieurs à <literal>%eps</literal> fois
125             la valeur maximum absolue de l'ensemble de ses éléments étaient
126             formatés à "0". Ce n'est plus le cas : la fonction
127             <literal>clean</literal> peut être utilisée pour fixer les digits
128             de faible poids à 0.
129         </para>
130     </refsection>
131     <refsection role="examples">
132         <title>Exemples</title>
133         <programlisting role="example"><![CDATA[
134 // format() n'est pas appliqué aux entiers encodés
135 // -----------------------------------------------
136 format("e",8)
137 int32(2.^grand(3,5,"uin",0,30))
138
139 // format() impacte l'affichage en console, disp(), string(), sci2exp(),...
140 // ---------------------------------------------------------------------
141 a = %pi; p = %pi + %z - %e*%z^2;
142 format("v",10);
143 a, p
144 disp(a,p)
145 string(a), string(p)
146 [sci2exp(a) sci2exp(p)]
147
148 format("e",15);
149 a, p
150 disp(a,p)
151 string(a), string(p)
152 [sci2exp(a) sci2exp(p)]
153 format("v",10); // reset
154
155 // format() configure le nombre de caractères. Le nombre de digits peut varier
156 // -------------------------------------------
157 format("v",10)
158 %pi*1e-217, s = string(%pi*1e-217)
159 length(s) // le caractère "manquant" est le signe "+" implicit
160
161 // C'est utile pour afficher des matrices aux colonnes bien alignées et sans blancs
162 [ -1.234 %pi*1e-10 %nan ; %e*1e137 -%inf 54312]
163
164 // Avec Scilab 6.0, les digits au delà de %eps sont mis à zéro :
165 format(22)
166 %pi
167
168 // format() a un impact global
169 // ---------------------------
170 function myfun()
171     format("e",20)
172 endfunction
173 format("v", 10)
174 disp(%pi)
175 myfun()
176 // Il agit partout, quel que soit le lieu où il a été utilisé en dernier
177 disp(%pi)
178 format("v",10) // reset
179  ]]></programlisting>
180     </refsection>
181     <refsection role="see also">
182         <title>Voir aussi</title>
183         <simplelist type="inline">
184             <member>
185                 <link linkend="number_properties">numbers_properties</link>
186             </member>
187             <member>
188                 <link linkend="string">string</link>
189             </member>
190             <member>
191                 <link linkend="sci2exp">sci2exp</link>
192             </member>
193             <member>
194                 <link linkend="disp">disp</link>
195             </member>
196             <member>
197                 <link linkend="print">print</link>
198             </member>
199             <member>
200                 <link linkend="clean">clean</link>
201             </member>
202             <member>
203                 <link linkend="printf_conversion">C-like format</link>
204             </member>
205             <member>
206                 <link linkend="mprintf">mprintf</link>
207             </member>
208             <member>
209                 <link linkend="msprintf">msprintf</link>
210             </member>
211             <member>
212                 <link linkend="mfprintf">mfprintf</link>
213             </member>
214       </simplelist>
215     </refsection>
216     <refsection role="history">
217         <title>Historique</title>
218         <revhistory>
219             <revision>
220                 <revnumber>6.0</revnumber>
221                 <revdescription>Pour les format() (excessivement) longs, les
222                 digits affichés au delà de la précision numérique relative %eps
223                 apparaissent maintenant comme des zéros.
224                 </revdescription>
225             </revision>
226         </revhistory>
227     </refsection>
228 </refentry>