help pages: toeplitz overhauled. diag, sparse, speye improved
[scilab.git] / scilab / modules / elementary_functions / help / fr_FR / elementarymatrices / eye.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="eye" xml:lang="fr">
3     <refnamediv>
4         <refname>eye</refname>
5         <refpurpose>matrice identité</refpurpose>
6     </refnamediv>
7     <refsynopsisdiv>
8         <title>Séquence d'appel</title>
9         <synopsis>X = eye(m,n)
10             X = eye(A)
11             X = eye()
12         </synopsis>
13     </refsynopsisdiv>
14     <refsection>
15         <title>Paramètres</title>
16         <variablelist>
17             <varlistentry>
18                 <term>A,X</term>
19                 <listitem>
20                     <para>
21                         matrices, hypermatrices ou listes de type <literal>syslin</literal>.
22                     </para>
23                 </listitem>
24             </varlistentry>
25             <varlistentry>
26                 <term>m,n</term>
27                 <listitem>
28                     <para>
29                         valeurs entières : nombre de lignes et nombre de colonnes souhaitées pour <varname>X</varname>
30                     </para>
31                 </listitem>
32             </varlistentry>
33         </variablelist>
34     </refsection>
35     <refsection>
36         <title>Description</title>
37         <para>Renvoie, suivant les arguments, une matrice de dimensions
38             <literal>m</literal>x<literal>n</literal> avec des 1 sur la diagonale
39             principale ou une matrice identité de même taille que <literal>A</literal>.
40             Dans le cas où <varname>A</varname> est une hypermatrice,
41             <varname>X</varname> sera de la forme:
42             <literal>X(i,i,...,i) = 1</literal> avec <literal>i</literal> de 1 à <literal>min(size(A))</literal>.
43         </para>
44         <warning>
45             <literal>eye(10)</literal> est équivalent à
46             <literal>eye(A)</literal> avec <literal>A=10</literal> c'est à dire
47             <literal>1</literal>. Ce n'est pas une matrice identité 10 x 10 !.
48         </warning>
49         <para>
50             Si <literal>A</literal> est un système linéaire représenté par une
51             liste de type <literal>syslin</literal>, <literal>eye(A)</literal> renvoie
52             une <literal>eye</literal> matrice de dimension appropriées : (nombre de
53             sorties x nombre d'entrées).
54         </para>
55         <para>
56             <literal>eye()</literal> renvoie une matrice identité de dimension
57             non définie. Ses dimensions sont définies quand cette matrice est ajoutée
58             à une matrice de dimensions fixées.
59         </para>
60     </refsection>
61     <refsection>
62         <title>Exemples</title>
63         <programlisting role="example"><![CDATA[
64 eye(2,3)
65 A=rand(2,3);eye(A)
66 s=poly(0,'s');A=[s,1;s,s+1];eye(A)
67 A=[1/s,1;s,2];eye(A);
68 A=ssrand(2,2,3);eye(A)
69 [1 2;3 4]+2*eye()
70 eye(zeros(4,4,4,4))
71  ]]></programlisting>
72     </refsection>
73     <refsection role="see also">
74         <title>Voir aussi</title>
75         <simplelist type="inline">
76             <member>
77                 <link linkend="ones">ones</link>
78             </member>
79             <member>
80                 <link linkend="zeros">zeros</link>
81             </member>
82         </simplelist>
83     </refsection>
84     <refsection>
85         <title>Historique</title>
86         <revhistory>
87             <revision>
88                 <revnumber>5.5.0</revnumber>
89                 <revdescription>
90                     <para>Généralisation à toute hypermatrice à N>2 dimensions</para>
91                 </revdescription>
92             </revision>
93         </revhistory>
94     </refsection>
95 </refentry>