help pages: toeplitz overhauled. diag, sparse, speye improved
[scilab.git] / scilab / modules / elementary_functions / help / fr_FR / elementarymatrices / linspace.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) 2008 - INRIA
5  * Copyright (C) 2016 - Samuel GOUGEON
6  *
7  * Copyright (C) 2012 - 2016 - Scilab Enterprises
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:ns5="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="linspace" xml:lang="fr">
21     <refnamediv>
22         <refname>linspace</refname>
23         <refpurpose>suite de nombres équidistants entre 2 bornes atteintes</refpurpose>
24     </refnamediv>
25     <refsynopsisdiv>
26         <title>Syntaxe</title>
27         <synopsis>
28             row = linspace(x1, x2)
29             row = linspace(x1, x2, n)
30             Matrix = linspace(Col1, Col2)
31             Matrix = linspace(Col1, Col2, n)
32         </synopsis>
33     </refsynopsisdiv>
34     <refsection>
35         <title>Arguments</title>
36         <variablelist>
37             <varlistentry>
38                 <term>x1, x2</term>
39                 <listitem>
40                     <para>
41                         Nombres réels ou complexes scalaires : bornes entre
42                         lesquelles les valeurs doivent être générées.
43                     </para>
44                 </listitem>
45             </varlistentry>
46             <varlistentry>
47                 <term>Col1, Col2</term>
48                 <listitem>
49                     <para>
50                         Vecteurs colonne de nombres réels ou complexes de même
51                         taille.
52                     </para>
53                 </listitem>
54             </varlistentry>
55             <varlistentry>
56                 <term>n</term>
57                 <listitem>
58                     <para>
59                         Nombre entier. Il précise le nombre de valeurs ou de colonnes à générer entre les deux extrémités (extrémités comprises).
60                         100 par défaut.
61                     </para>
62                 </listitem>
63             </varlistentry>
64             <varlistentry>
65                 <term>row</term>
66                 <listitem>
67                     <para>
68                         Vecteur ligne de <literal>n</literal> nombres.
69                     </para>
70                 </listitem>
71             </varlistentry>
72             <varlistentry>
73                 <term>Matrix</term>
74                 <listitem>
75                     <para>
76                         Matrice à <literal>n</literal> colonnes de nombres.
77                     </para>
78                 </listitem>
79             </varlistentry>
80         </variablelist>
81     </refsection>
82     <refsection>
83         <title>Description</title>
84         <para>
85             <literal>linspace(x1, x2)</literal>
86             génère un vecteur ligne de <literal>n</literal> valeurs allant
87             exactement de <literal>x1</literal> à <literal>x2</literal> à
88             pas constant.
89         </para>
90         <note>
91             <para>
92                 La syntaxe <literal>y1:y2</literal> ou <literal>y1:step:y2</literal>
93                 comme <literal>1:0.1:%pi</literal> produit une suite similaire,
94                 mais fixe la valeur de départ <literal>y1</literal> et
95                 <emphasis role="bold">le pas/incrément</emphasis>.
96                 <literal>y2</literal> sert de valeur d'arrêt à ne pas dépasser.
97                 La dernière valeur générée peut elle être inférieure,
98                 <literal>y2</literal> ne figurant alors pas parmi les valeurs
99                 générées.
100             </para>
101             <para>
102                 Au lieu de fixer le pas/incrément, <literal>linspace</literal>
103                 fixe la seconde borne <literal>x2</literal> à exactement
104                 <emphasis role="bold">atteindre</emphasis>, et calcule le pas
105                 en conséquence.
106             </para>
107         </note>
108         <para>
109             Si <literal>x1</literal> ou <literal>x2</literal> sont des nombres
110             complexes, <literal>linspace(x1,x2)</literal> interpole alors
111             séparément la partie réelle de <literal>x1</literal> et <literal>x2</literal>,
112             et d'autre part leur partie imaginaire.
113         </para>
114         <para>
115             Si des vecteurs colonnes <literal>Col1</literal> et <literal>Col2</literal>
116             sont fournis, <literal>linspace</literal> est alors appliquée
117             ligne par ligne :
118             La <literal>Matrix</literal> résultante à le même nombre de lignes,
119             et <literal>n</literal> colonnes, avec
120             <literal>Matrix(i,:) = linspace(Col1(i), Col2(i), n)</literal>.
121         </para>
122     </refsection>
123     <refsection>
124         <title>Exemples</title>
125         <programlisting role="example"><![CDATA[
126 linspace(1, %pi, 0)         // n = 0
127 linspace(1, 2, 10)          // x2 > x1 : suite croissante
128 linspace(2, 1, 10)          // x2 < x1 : suite décroissante
129 linspace(1+%i, 2-2*%i, 5)      // avec des nombres complexes
130 linspace([1:4]', [5:8]', 10)   // avec des colonnes de bornes
131  ]]></programlisting>
132         <screen><![CDATA[--> linspace(1, %pi, 0)    // n = 0
133  ans  =
134     []
135
136 --> linspace(1, 2, 10)    // x2 > x1 : suite croissante
137  ans  =
138    1.   1.111   1.222   1.333   1.444   1.556   1.667   1.778   1.889   2.
139
140
141 --> linspace(2, 1, 10)    // x2 &lt; x1 : suite décroissante
142  ans  =
143    2.   1.889   1.778   1.667   1.556   1.444   1.333   1.222   1.111   1.
144
145
146 --> linspace(1+%i, 2-2*%i, 5)      // avec des nombres complexes
147  ans  =
148    1. +i     1.25 +0.25i   1.5 -0.5i   1.75 -1.25i   2. -2.i
149
150
151 --> linspace([1:4]', [5:8]', 10)   // avec des colonnes de bornes
152  ans  =
153    1.   1.444   1.889   2.333   2.778   3.222   3.667   4.111   4.556   5.
154    2.   2.444   2.889   3.333   3.778   4.222   4.667   5.111   5.556   6.
155    3.   3.444   3.889   4.333   4.778   5.222   5.667   6.111   6.556   7.
156    4.   4.444   4.889   5.333   5.778   6.222   6.667   7.111   7.556   8.
157 ]]></screen>
158     </refsection>
159     <refsection role="see also">
160         <title>Voir aussi</title>
161         <simplelist type="inline">
162             <member>
163                 <link linkend="colon">colon</link>
164             </member>
165             <member>
166                 <link linkend="logspace">logspace</link>
167             </member>
168             <member>
169                 <link linkend="grand">grand</link>
170             </member>
171         </simplelist>
172     </refsection>
173     <refsection>
174         <title>Historique</title>
175         <revhistory>
176             <revision>
177                 <revnumber>5.4.0</revnumber>
178                 <revremark>
179                     <itemizedlist>
180                         <listitem>Des vecteurs colonne de bornes peuvent être utilisées.
181                         </listitem>
182                         <listitem>Le nombre de colonnes générées doit
183                             être obligatoirement un entier.
184                         </listitem>
185                     </itemizedlist>
186                 </revremark>
187             </revision>
188             <revision>
189                 <revnumber>6.0</revnumber>
190                 <revremark>
191                     <itemizedlist>
192                         <listitem>linspace(a, b, n&lt;=0) produit [] au lieu de b.
193                         </listitem>
194                         <listitem>Toute borne %inf ou %nan est détectée et rejetée.
195                         </listitem>
196                     </itemizedlist>
197                 </revremark>
198             </revision>
199         </revhistory>
200     </refsection>
201 </refentry>