66b3a093e6e8f05fb435625b64a07cc348029f8a
[scilab.git] / scilab / modules / sparse / help / fr_FR / matrixmanip / speye.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="speye" xml:lang="fr">
20     <refnamediv>
21         <refname>speye</refname>
22         <refpurpose>matrice identité creuse</refpurpose>
23     </refnamediv>
24     <refsynopsisdiv>
25         <title>Séquence d'appel</title>
26         <synopsis>
27             Isp = speye(A)
28             Isp = speye(nrows, ncols)
29         </synopsis>
30     </refsynopsisdiv>
31     <refsection>
32         <title>Paramètres</title>
33         <variablelist>
34             <varlistentry>
35                 <term>nrows</term>
36                 <listitem>
37                     <para>entier (nombre de lignes)</para>
38                 </listitem>
39             </varlistentry>
40             <varlistentry>
41                 <term>ncols</term>
42                 <listitem>
43                     <para>entier (nombre de colonnes)</para>
44                 </listitem>
45             </varlistentry>
46             <varlistentry>
47                 <term>A</term>
48                 <listitem>
49                     <para>matrice creuse</para>
50                 </listitem>
51             </varlistentry>
52             <varlistentry>
53                 <term>sp</term>
54                 <listitem>
55                     <para>matrice identité creuse</para>
56                 </listitem>
57             </varlistentry>
58         </variablelist>
59     </refsection>
60     <refsection>
61         <title>Description</title>
62         <para>
63             <literal>Isp=speye(nrows,ncols)</literal> renvoie une matrice
64             identité creuse <literal>Isp</literal> avec <literal>nrows</literal>
65             lignes et <literal>ncols</literal> colonnes.
66         </para>
67         <para>
68             <literal>Isp=speye(A)</literal> renvoie une matrice identité creuse
69             de même taille que <literal>A</literal>. Si
70             <literal>[m,n]=size(A)</literal>, <literal>speye(A)</literal> et
71             <literal>speye(m,n)</literal> sont équivalentes.
72             <warning>
73                 En particulier, <literal>speye(3)</literal> est équivalent à
74                 <literal>speye(1,1)</literal>, NON à <literal>speye(3,3)</literal>.
75             </warning>
76         </para>
77     </refsection>
78     <refsection>
79         <title>Exemples</title>
80         <programlisting role="example"><![CDATA[
81 eye(3,3) - full(speye(3,3))
82  ]]></programlisting>
83     </refsection>
84     <refsection role="see also">
85         <title>Voir aussi</title>
86         <simplelist type="inline">
87             <member>
88                 <link linkend="sparse">sparse</link>
89             </member>
90             <member>
91                 <link linkend="full">full</link>
92             </member>
93             <member>
94                 <link linkend="eye">eye</link>
95             </member>
96             <member>
97                 <link linkend="diag">diag</link>
98             </member>
99             <member>
100                 <link linkend="toeplitz">toeplitz</link>
101             </member>
102             <member>
103                 <link linkend="spzeros">spzeros</link>
104             </member>
105             <member>
106                 <link linkend="spones">spones</link>
107             </member>
108         </simplelist>
109     </refsection>
110 </refentry>