help pages: toeplitz overhauled. diag, sparse, speye improved
[scilab.git] / scilab / modules / sparse / help / pt_BR / 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:ns4="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="pt">
20     <refnamediv>
21         <refname>speye</refname>
22         <refpurpose>matriz identidade esparsa</refpurpose>
23     </refnamediv>
24     <refsynopsisdiv>
25         <title>Seqüência de Chamamento</title>
26         <synopsis>
27             Isp = speye(A)
28             Isp = speye(nrows, ncols)
29         </synopsis>
30     </refsynopsisdiv>
31     <refsection>
32         <title>Parâmetros</title>
33         <variablelist>
34             <varlistentry>
35                 <term>nrows</term>
36                 <listitem>
37                     <para>inteiro (número de linhas) </para>
38                 </listitem>
39             </varlistentry>
40             <varlistentry>
41                 <term>ncols</term>
42                 <listitem>
43                     <para>inteiro (número de colunas) </para>
44                 </listitem>
45             </varlistentry>
46             <varlistentry>
47                 <term>A</term>
48                 <listitem>
49                     <para>matriz esparsa </para>
50                 </listitem>
51             </varlistentry>
52             <varlistentry>
53                 <term>sp</term>
54                 <listitem>
55                     <para>matriz identidade esparsa </para>
56                 </listitem>
57             </varlistentry>
58         </variablelist>
59     </refsection>
60     <refsection>
61         <title>Descrição</title>
62         <para>
63             <literal>Isp=speye(nrows,ncols)</literal> retorna uma matriz
64             identidade esparsa <literal>Isp</literal> com <literal>nrows</literal>
65             linhas e , <literal>ncols</literal> colunas (matrizes identidades
66             não-quadradas têm um número máximo de algarismos 1 na diagonal
67             principal).
68         </para>
69         <para>
70             <literal>Isp=speye(A)</literal> retorna uma matriz identidade
71             esparsa com as mesmas dimensões de <literal>A</literal>.
72             Se<literal>[m,n]=size(A)</literal>, <literal>speye(m,n)</literal> e
73             <literal>speye(A)</literal> são equivalentes.
74             <warning>
75                 Em particular <literal>speye(3)</literal> não é equivalente a <literal>speye(3,3)</literal>.
76             </warning>
77         </para>
78     </refsection>
79     <refsection>
80         <title>Exemplos</title>
81         <programlisting role="example"><![CDATA[
82 eye(3,3) - full(speye(3,3))
83  ]]></programlisting>
84     </refsection>
85     <refsection role="see also">
86         <title>Ver Também</title>
87         <simplelist type="inline">
88             <member>
89                 <link linkend="sparse">sparse</link>
90             </member>
91             <member>
92                 <link linkend="full">full</link>
93             </member>
94             <member>
95                 <link linkend="eye">eye</link>
96             </member>
97             <member>
98                 <link linkend="diag">diag</link>
99             </member>
100             <member>
101                 <link linkend="toeplitz">toeplitz</link>
102             </member>
103             <member>
104                 <link linkend="spzeros">spzeros</link>
105             </member>
106             <member>
107                 <link linkend="spones">spones</link>
108             </member>
109         </simplelist>
110     </refsection>
111 </refentry>