<?xml version="1.0" encoding="UTF-8"?>
<!--
 * Scilab ( https://www.scilab.org/ ) - This file is part of Scilab
 * Copyright (C) 2008 - INRIA
 * Copyright (C) 2015 - Samuel GOUGEON
 *
 * This file must be used under the terms of the CeCILL.
 * This source file is licensed as described in the file COPYING, which
 * you should have received as part of this distribution.  The terms
 * are also available at
 * https://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt
 *
 -->
<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="isreal" xml:lang="pt">
    <refnamediv>
        <refname>isreal</refname>
        <refpurpose>verifica se uma variável é armazenada como real ou complexa.
        </refpurpose>
    </refnamediv>
    <refsynopsisdiv>
        <title>Seqüência de Chamamento</title>
        <synopsis>t = isreal(x)
            t = isreal(x, eps)
        </synopsis>
    </refsynopsisdiv>
    <refsection>
        <title>Parâmetros</title>
        <variablelist>
            <varlistentry>
                <term>x</term>
                <listitem>
                    <para>matriz de números reais ou complexos, ou de polinômios ou de razões de
                    polinômios com coeficientes reais ou complexos.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>eps</term>
                <listitem>
                    <para>um número real positivo ou nulo (default = 0)</para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>t</term>
                <listitem>
                    <para>um booleano</para>
                </listitem>
            </varlistentry>
        </variablelist>
    </refsection>
    <refsection>
        <title>Descrição</title>
        <para>
            <literal>isreal(x)</literal> retorna 'true' (verdadeiro) se
            <literal>x</literal> é armazenado como uma variável real e falso se
            <literal>x</literal> é armazenado com uma parte imaginária (que pode ser
            zero 0).
        </para>
        <para>
            <literal>isreal(x,eps)</literal> retorna 'true' se
            <literal>x</literal> é armazenado como uma variável real ou se o valor
            absoluto máximo dos pontos flutuantes imaginários é menor que ou igual a
            <literal>eps</literal>.
        </para>
    </refsection>
    <refsection>
        <title>Exemplos</title>
        <programlisting role="example"><![CDATA[
isreal([1 2])
isreal(1+0*%i)
isreal(1+0*%i,0)

// Sparse complex matrix:
isreal(sparse([1-%i -3+4*%i]))

// Complex polynomial:
p = (1-2*%s)^2
isreal(p)

// Complex rational fraction:
r = [ (%i-%s)/%s^2 %s/(2-%s)]
isreal(r)
 ]]></programlisting>
    </refsection>
    <refsection role="history">
        <title>Histórico</title>
        <revhistory>
            <revision>
                <revnumber>6.0</revnumber>
                <revdescription>Extension to rationals
                </revdescription>
            </revision>
        </revhistory>
    </refsection>
</refentry>
