<?xml version="1.0" encoding="UTF-8"?>
<!--
 * 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:ns3="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="diag" xml:lang="pt">
    <refnamediv>
        <refname>diag</refname>
        <refpurpose>inclusão ou extração diagonal</refpurpose>
    </refnamediv>
    <refsynopsisdiv>
        <title>Seqüência de Chamamento</title>
        <synopsis>
           y = diag(vm)
           y = diag(vm, k)
        </synopsis>
    </refsynopsisdiv>
    <refsection>
        <title>Parâmetros</title>
        <variablelist>
            <varlistentry>
                <term>vm</term>
                <listitem>
                    <para>vetor ou matriz (armazenamento cheio ou esparso)</para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>k</term>
                <listitem>
                    <para>inteiro (o valor padrão é 0)</para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>y</term>
                <listitem>
                    <para>vetor ou matriz</para>
                </listitem>
            </varlistentry>
        </variablelist>
    </refsection>
    <refsection>
        <title>Descrição</title>
        <para>
            Para um n-vetor (linha ou coluna) <literal>vm</literal> ,
            <literal>diag(vm)</literal> retorna uma matriz diagonal com entradas de
            <literal>vm</literal> ao longo da diagonal principal.
        </para>
        <para>
            <literal>diag(vm,k)</literal> é uma matriz
            <literal>(n+abs(k))x(n+abs(k))</literal> com entradas de
            <literal>vm</literal> ao longo da k-ésima diagonal. <literal>k=0</literal>
            é a diagonal principal, <literal>k&gt;0</literal> são as diagonais
            superiores e <literal>k&lt;0</literal> são as diagonais inferiores.
        </para>
        <para>
            Para uma matriz <literal>vm</literal>, <literal>diag(vm,k)</literal>
            é o vetor coluna feito das entradas da k-ésima diagonal de
            <literal>vm</literal>. <literal>diag(vm)</literal> é a diagonal principal
            de <literal>vm</literal>. <literal>diag(diag(x))</literal> é a matriz
            diagonal.
        </para>
        <para>
            Se <literal>vm</literal> é uma matriz esparsa,
            <literal>diag(vm,k)</literal> retorna uma matriz esparsa.
        </para>
        <para>Para construir um sistema linear diagonal, use
            <literal>blockdiag</literal>.
        </para>
        <para>
            Perceba que <literal>eye(A).*A</literal> retorna uma matriz diagonal
            feita das entradas diagonais de <literal>A</literal>. Isto é válido para
            qualquer matriz (constante, de polinômios, de razões de polinômios,
            sistema linear em espaço de estados,...).
        </para>
    </refsection>
    <refsection>
        <title>Exemplos</title>
        <programlisting role="example"><![CDATA[
diag([1,2])

A=[1,2;3,4];
diag(A)  // diagonal principal
diag(A,1)

diag(sparse(1:10))  // matriz diagonal esparsa

// forma de uma matriz triadiagonal de tamanho 2*m+1
m=5;diag(-m:m) +  diag(ones(2*m,1),1) +diag(ones(2*m,1),-1)
 ]]></programlisting>
    </refsection>
    <refsection role="see also">
        <title>Ver Também</title>
        <simplelist type="inline">
            <member>
                <link linkend="toeplitz">toeplitz</link>
            </member>
            <member>
                <link linkend="eye">eye</link>
            </member>
            <member>
                <link linkend="blockdiag">blockdiag</link>
            </member>
            <member>
                <link linkend="spec">spec</link>
            </member>
            <member>
                <link linkend="bdiag">bdiag</link>
            </member>
        </simplelist>
    </refsection>
</refentry>
