help pages: toeplitz overhauled. diag, sparse, speye improved
[scilab.git] / scilab / modules / elementary_functions / help / fr_FR / elementarymatrices / diag.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  *
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"
17           xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="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="diag" xml:lang="fr">
20     <refnamediv>
21         <refname>diag</refname>
22         <refpurpose>extraction de diagonale ou construction d'une matrice avec un vecteur en diagonal
23         </refpurpose>
24     </refnamediv>
25     <refsynopsisdiv>
26         <title>Séquence d'appel</title>
27         <synopsis>
28            y = diag(vm)
29            y = diag(vm, k)
30         </synopsis>
31     </refsynopsisdiv>
32     <refsection>
33         <title>Paramètres</title>
34         <variablelist>
35             <varlistentry>
36                 <term>vm</term>
37                 <listitem>
38                     <para>vecteur ou matrice (stockage plein ou creux)</para>
39                 </listitem>
40             </varlistentry>
41             <varlistentry>
42                 <term>k</term>
43                 <listitem>
44                     <para>entier (valeur par défaut 0)</para>
45                 </listitem>
46             </varlistentry>
47             <varlistentry>
48                 <term>y</term>
49                 <listitem>
50                     <para>vecteur ou matrice</para>
51                 </listitem>
52             </varlistentry>
53         </variablelist>
54     </refsection>
55     <refsection>
56         <title>Description</title>
57         <para>
58             Pour <literal>vm</literal> un n-vecteur (ligne ou colonne)
59             <literal>diag(vm)</literal> renvoie une matrice diagonale avec les
60             composantes de <literal>vm</literal> sur la diagonale principale.
61         </para>
62         <para>
63             <literal>diag(vm,k)</literal> est une matrice
64             <literal>(n+abs(k))x(n+abs(k))</literal> avec les composantes de
65             <literal>vm</literal> sur la kième diagonale. <literal>k=0</literal>
66             correspond à la diagonale principale <literal>k&gt;0</literal> correspond
67             aux diagonales supérieures et <literal>k&lt;0</literal> aux diagonales
68             inférieures.
69         </para>
70         <para>
71             Pour une matrice <literal>vm</literal>,
72             <literal>diag(vm,k)</literal> est le vecteur colonne dont les composantes
73             sont les termes de la kième diagonale de <literal>vm</literal>.
74             <literal>diag(vm)</literal> est la diagonale principale de
75             <literal>vm</literal>. <literal>diag(diag(x))</literal> est une matrice
76             diagonale.
77         </para>
78         <para>
79             Si <literal>vm</literal> est une matrice creuse
80             <literal>diag(vm,k)</literal> renvoie une matrice creuse.
81         </para>
82         <para>Pour construire un système linéaire diagonal, utilisez
83             <literal>sysdiag</literal>.
84         </para>
85         <para>
86             Notez que <literal>eye(A).*A</literal> renvoie une matrice diagonale
87             avec les termes diagonaux de <literal>A</literal>. Ceci est valide pour
88             tout type de matrice (constante, polynomiale, rationnelle, système
89             dynamique linéaire, ...).
90         </para>
91     </refsection>
92     <refsection>
93         <title>Exemples</title>
94         <programlisting role="example"><![CDATA[
95 diag([1,2])
96
97 A=[1,2;3,4];
98 diag(A)  // diagonale principale
99 diag(A,1)
100
101 diag(sparse(1:10))  // matrice diagonale creuse
102
103 // Construction d'une matrice tridiagonale de taille 2*m+1
104 m=5;diag(-m:m) +  diag(ones(2*m,1),1) +diag(ones(2*m,1),-1)
105  ]]></programlisting>
106     </refsection>
107     <refsection role="see also">
108         <title>Voir aussi</title>
109         <simplelist type="inline">
110             <member>
111                 <link linkend="toeplitz">toeplitz</link>
112             </member>
113             <member>
114                 <link linkend="eye">eye</link>
115             </member>
116             <member>
117                 <link linkend="sysdiag">sysdiag</link>
118             </member>
119             <member>
120                 <link linkend="spec">spec</link>
121             </member>
122             <member>
123                 <link linkend="bdiag">bdiag</link>
124             </member>
125         </simplelist>
126     </refsection>
127 </refentry>