help pages: toeplitz overhauled. diag, sparse, speye improved
[scilab.git] / scilab / modules / elementary_functions / help / fr_FR / elementarymatrices / toeplitz.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) 2017 - 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="toeplitz" xml:lang="fr">
21     <refnamediv>
22         <refname>toeplitz</refname>
23         <refpurpose>matrice de Toeplitz, à bandes diagonales constantes choisies</refpurpose>
24     </refnamediv>
25     <refsynopsisdiv>
26         <title>Séquence d'appel</title>
27         <synopsis>
28             A = toeplitz(c)
29             A = toeplitz(c, r)
30         </synopsis>
31     </refsynopsisdiv>
32     <refsection>
33         <title>Paramètres</title>
34         <variablelist>
35             <varlistentry>
36                 <term>c, r</term>
37                 <listitem>
38                     <para>
39                         vecteurs ou matrices de booléens, nombres, polynômes, fractions rationelles,
40                         ou textes, denses ou creux (booléens ou nombres).
41                     </para>
42                     <para>
43                         <varname>c</varname> fournit les valeurs attendues sur la 1ère colonne et
44                         le long des diagonales inférieures. <varname>r</varname> fournit les valeurs
45                         attendues sur la 1ère ligne et le long des diagonales supérieures.
46                     </para>
47                     <para>
48                         Si les deux <literal>c</literal> et <literal>r</literal> sont fournis,
49                         il faut que <literal>c(1)==r(1)</literal>.
50                     </para>
51                     <para>
52                         Les types de <varname>c</varname> et <varname>r</varname> doivent être
53                         compatibles par concaténation.
54                     </para>
55                 </listitem>
56             </varlistentry>
57             <varlistentry>
58                 <term>A</term>
59                 <listitem>
60                     <para>
61                      Matrice du type de <varname>c</varname> et <varname>r</varname>
62                     (avec les priorités habituelles pour le typage).
63                     </para>
64                     <para>
65                         <varname>A</varname> est de taille <literal>[size(c,"*"), size(c,"*")]</literal>
66                         ou <literal>[size(c,"*"), size(r,"*")]</literal>.
67                     </para>
68                     <para>
69                         <varname>A</varname> est encodée creuse si <varname>c</varname> ou
70                         <varname>r</varname> ou les deux sont encodées creuses.
71                     </para>
72                 </listitem>
73             </varlistentry>
74         </variablelist>
75     </refsection>
76     <refsection>
77         <title>Description</title>
78         <para>
79             Renvoie la matrice de Toeplitz dont la première ligne est
80             <literal>r</literal> et la première colonne est <literal>c</literal>.
81             <literal>toeplitz(c)</literal> renvoie la matrice de Toeplitz symétrique.
82         </para>
83     </refsection>
84     <refsection>
85         <title>Exemples</title>
86         <programlisting role="example"><![CDATA[
87 toeplitz(0:3)
88  ]]></programlisting>
89     <screen><![CDATA[
90 --> toeplitz(0:3)
91  ans  =
92    0.   1.   2.   3.
93    1.   0.   1.   2.
94    2.   1.   0.   1.
95    3.   2.   1.   0.
96 ]]></screen>
97     <para/>
98     <programlisting role="example"><![CDATA[
99 toeplitz([0 1 0 0 ], [0 -1 -2 0 0 0])
100  ]]></programlisting>
101     <screen><![CDATA[
102 --> toeplitz([0 1 0 0 ], [0 -1 -2 0 0 0])
103  ans  =
104    0.  -1.  -2.   0.   0.   0.
105    1.   0.  -1.  -2.   0.   0.
106    0.   1.   0.  -1.  -2.   0.
107    0.   0.   1.   0.  -1.  -2.
108 ]]></screen>
109     <para/>
110     <para>Avec des tableaux encodés creux : </para>
111     <programlisting role="example"><![CDATA[
112 v = [0 1:2 0 0];
113 S = toeplitz(v, sparse(-v));
114 typeof(S)
115 full(S)
116  ]]></programlisting>
117     <screen><![CDATA[
118 --> typeof(S)
119  ans  =
120  sparse
121
122 --> full(S)
123  ans  =
124    0.  -1.  -2.   0.   0.
125    1.   0.  -1.  -2.   0.
126    2.   1.   0.  -1.  -2.
127    0.   2.   1.   0.  -1.
128    0.   0.   2.   1.   0.
129 ]]></screen>
130     <para/>
131     <para>Avec du texte : </para>
132     <programlisting role="example"><![CDATA[
133 toeplitz(["-" "A" "B" "C"],["-" "a" "b" "c" "d" "e"])
134  ]]></programlisting>
135     <screen><![CDATA[
136 --> toeplitz(["-" "A" "B" "C"],["-" "a" "b" "c" "d" "e"])
137  ans  =
138 !-  a  b  c  d  e  !
139 !A  -  a  b  c  d  !
140 !B  A  -  a  b  c  !
141 !C  B  A  -  a  b  !
142 ]]></screen>
143     <para/>
144     <para>Avec des polynômes : </para>
145     <programlisting role="example"><![CDATA[
146 toeplitz([%s %s^2 %s^3], [%s 1:4])
147  ]]></programlisting>
148     <screen><![CDATA[
149 --> toeplitz([%s %s^2 %s^3], [%s 1:4])
150  ans  =
151    s    1    2   3   4
152
153     2
154    s    s    1   2   3
155
156     3    2
157    s    s    s   1   2
158 ]]></screen>
159     <para/>
160     </refsection>
161     <refsection role="see also">
162         <title>Voir aussi</title>
163         <simplelist type="inline">
164             <member>
165                 <link linkend="diag">diag</link>
166             </member>
167             <member>
168                 <link linkend="eye">eye</link>
169             </member>
170             <member>
171                 <link linkend="testmatrix">testmatrix</link>
172             </member>
173         </simplelist>
174     </refsection>
175 </refentry>