help pages: toeplitz overhauled. diag, sparse, speye improved
[scilab.git] / scilab / modules / sparse / help / fr_FR / matrixmanip / speye.xml
index 09837fa..66b3a09 100644 (file)
 <?xml version="1.0" encoding="UTF-8"?>
-<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" version="5.0-subset Scilab" xml:id="speye" xml:lang="fr">
-  <refnamediv>
-    <refname>speye</refname>
-    <refpurpose>matrice identité creuse</refpurpose>
-  </refnamediv>
-  <refsynopsisdiv>
-    <title>Séquence d'appel</title>
-    <synopsis>Isp=speye(nrows,ncols)
-      Isp=speye(A)
-    </synopsis>
-  </refsynopsisdiv>
-  <refsection>
-    <title>Paramètres</title>
-    <variablelist>
-      <varlistentry>
-        <term>nrows</term>
-        <listitem>
-          <para>entier (nombre de lignes)</para>
-        </listitem>
-      </varlistentry>
-      <varlistentry>
-        <term>ncols</term>
-        <listitem>
-          <para>entier (nombre de colonnes)</para>
-        </listitem>
-      </varlistentry>
-      <varlistentry>
-        <term>A</term>
-        <listitem>
-          <para>matrice creuse</para>
-        </listitem>
-      </varlistentry>
-      <varlistentry>
-        <term>sp</term>
-        <listitem>
-          <para>matrice identité creuse</para>
-        </listitem>
-      </varlistentry>
-    </variablelist>
-  </refsection>
-  <refsection>
-    <title>Description</title>
-    <para>
-      <literal>Isp=speye(nrows,ncols)</literal> renvoie une matrice
-      identité creuse <literal>Isp</literal> avec <literal>nrows</literal>
-      lignes et <literal>ncols</literal> colonnes.
-    </para>
-    <para>
-      <literal>Isp=speye(A)</literal> renvoie une matrice identité creuse
-      de même taille que <literal>A</literal>. Si
-      <literal>[m,n]=size(A)</literal>, les commandes
-      <literal>speye(m,n)</literal> et <literal>speye(A)</literal> sont
-      équivalentes. En particulier <literal>speye(3)</literal> n'est pas
-      équivalent à <literal>speye(3,3)</literal>.
-    </para>
-  </refsection>
-  <refsection>
-    <title>Exemples</title>
-    <programlisting role="example"><![CDATA[ 
-eye(3,3)-full(speye(3,3))
+<!--
+ * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
+ * Copyright (C) 2008 - INRIA
+ *
+ * Copyright (C) 2012 - 2016 - Scilab Enterprises
+ *
+ * This file is hereby licensed under the terms of the GNU GPL v2.0,
+ * pursuant to article 5.3.4 of the CeCILL v.2.1.
+ * This file was originally licensed under the terms of the CeCILL v2.1,
+ * and continues to be available under such terms.
+ * For more information, see the COPYING file which you should have received
+ * along with this program.
+ *
+ -->
+<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="speye" xml:lang="fr">
+    <refnamediv>
+        <refname>speye</refname>
+        <refpurpose>matrice identité creuse</refpurpose>
+    </refnamediv>
+    <refsynopsisdiv>
+        <title>Séquence d'appel</title>
+        <synopsis>
+            Isp = speye(A)
+            Isp = speye(nrows, ncols)
+        </synopsis>
+    </refsynopsisdiv>
+    <refsection>
+        <title>Paramètres</title>
+        <variablelist>
+            <varlistentry>
+                <term>nrows</term>
+                <listitem>
+                    <para>entier (nombre de lignes)</para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>ncols</term>
+                <listitem>
+                    <para>entier (nombre de colonnes)</para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>A</term>
+                <listitem>
+                    <para>matrice creuse</para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>sp</term>
+                <listitem>
+                    <para>matrice identité creuse</para>
+                </listitem>
+            </varlistentry>
+        </variablelist>
+    </refsection>
+    <refsection>
+        <title>Description</title>
+        <para>
+            <literal>Isp=speye(nrows,ncols)</literal> renvoie une matrice
+            identité creuse <literal>Isp</literal> avec <literal>nrows</literal>
+            lignes et <literal>ncols</literal> colonnes.
+        </para>
+        <para>
+            <literal>Isp=speye(A)</literal> renvoie une matrice identité creuse
+            de même taille que <literal>A</literal>. Si
+            <literal>[m,n]=size(A)</literal>, <literal>speye(A)</literal> et
+            <literal>speye(m,n)</literal> sont équivalentes.
+            <warning>
+                En particulier, <literal>speye(3)</literal> est équivalent à
+                <literal>speye(1,1)</literal>, NON à <literal>speye(3,3)</literal>.
+            </warning>
+        </para>
+    </refsection>
+    <refsection>
+        <title>Exemples</title>
+        <programlisting role="example"><![CDATA[
+eye(3,3) - full(speye(3,3))
  ]]></programlisting>
-  </refsection>
-  <refsection role="see also">
-    <title>Voir aussi</title>
-    <simplelist type="inline">
-      <member>
-        <link linkend="sparse">sparse</link>
-      </member>
-      <member>
-        <link linkend="full">full</link>
-      </member>
-      <member>
-        <link linkend="eye">eye</link>
-      </member>
-      <member>
-        <link linkend="spzeros">spzeros</link>
-      </member>
-      <member>
-        <link linkend="spones">spones</link>
-      </member>
-    </simplelist>
-  </refsection>
+    </refsection>
+    <refsection role="see also">
+        <title>Voir aussi</title>
+        <simplelist type="inline">
+            <member>
+                <link linkend="sparse">sparse</link>
+            </member>
+            <member>
+                <link linkend="full">full</link>
+            </member>
+            <member>
+                <link linkend="eye">eye</link>
+            </member>
+            <member>
+                <link linkend="diag">diag</link>
+            </member>
+            <member>
+                <link linkend="toeplitz">toeplitz</link>
+            </member>
+            <member>
+                <link linkend="spzeros">spzeros</link>
+            </member>
+            <member>
+                <link linkend="spones">spones</link>
+            </member>
+        </simplelist>
+    </refsection>
 </refentry>