scilab/modules/elementary_functions/help/pt_BR/searchandsort/find.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) 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" 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="find" xml:lang="pt">
  17     <refnamediv>
  18         <refname>find</refname>
  19         <refpurpose>encontra índices de elementos verdadeiros em uma matriz ou
  20             vetor de booleanos
  21         </refpurpose>
  22     </refnamediv>
  23     <refsynopsisdiv>
  24         <title>Seqüência de Chamamento</title>
  25         <synopsis>[ii]=find(x [,nmax])
  26             [i1,i2,..]=find(x [,nmax])
  27         </synopsis>
  28     </refsynopsisdiv>
  29     <refsection>
  30         <title>Parâmetros</title>
  31         <variablelist>
  32             <varlistentry>
  33                 <term>x</term>
  34                 <listitem>
  35                     <para>pode ser um vetor, matriz ou hipermatriz de booleanos, uma
  36                         matriz ou hipermatriz "padrão".
  37                     </para>
  38                 </listitem>
  39             </varlistentry>
  40             <varlistentry>
  41                 <term>nmax</term>
  42                 <listitem>
  43                     <para>um inteiro fornecendo o número máximo de índices a serem
  44                         retornados. o valor padrão é -1, que significa "todos". Esta opção
  45                         pode ser usada por eficiência, para evitar uma busca por todos os
  46                         índices.
  47                     </para>
  48                 </listitem>
  49             </varlistentry>
  50             <varlistentry>
  51                 <term>ii, i1, i2, ..</term>
  52                 <listitem>
  53                     <para>vetores de índices inteiros ou matrizes vazias</para>
  54                 </listitem>
  55             </varlistentry>
  56         </variablelist>
  57     </refsection>
  58     <refsection>
  59         <title>Descrição</title>
  60         <para>
  61             Se <literal>x</literal> é uma matriz booleana,
  62         </para>
  63         <para>
  64             <literal>ii=find(x)</literal> retorna o vetor de índices
  65             <literal>i</literal> para os quais <literal>x(i)</literal> é "true"
  66             ("verdadeiro").Se nenhum elemento "true" for encontrado, retorna uma
  67             matriz vazia.
  68         </para>
  69         <para>
  70             <literal>[i1,i2,..]=find(x)</literal> retorna vetores de índices
  71             <literal>i1</literal> (para linhas) e <literal>i2</literal> (para
  72             colunas),... tais que <literal>x(i1(n),i2(n),..)</literal> ié "true"
  73             ("verdadeiro"). Se nenhum elemento "true" for encontrado, retorna matrizes
  74             vazias em <literal>i1</literal>, <literal>i2</literal>, ...
  75         </para>
  76         <para>
  77             Se <literal>x</literal> é uma matriz ou hipermatriz padrão
  78             <literal>find(x)</literal> é interpretado como
  79             <literal>find(x&lt;&gt;0)</literal>
  80         </para>
  81         <para>
  82             <literal>find([])</literal> retorna <literal>[]</literal>
  83         </para>
  84     </refsection>
  85     <refsection>
  86         <title>Exemplos</title>
  87         <programlisting role="example"><![CDATA[
  88 A=rand(1,20);
  89 w=find(A<0.4)
  90 A(w)
  91 w=find(A>100)
  92
  93 B=rand(1,20);
  94 w=find(B<0.4,2) //no máximo dois valores retornados
  95
  96 H=rand(4,3,5); //uma hipermatriz
  97 [i,j,k]=find(H>0.9)
  98
  99 H(i(1),j(1),k(1))
 100  ]]></programlisting>
 101     </refsection>
 102     <refsection role="see also">
 103         <title>Ver Também</title>
 104         <simplelist type="inline">
 105             <member>
 106                 <link linkend="boolean">boolean</link>
 107             </member>
 108             <member>
 109                 <link linkend="extraction">extraction</link>
 110             </member>
 111             <member>
 112                 <link linkend="insertion">insertion</link>
 113             </member>
 114             <member>
 115                 <link linkend="vectorfind">vectorfind</link>
 116             </member>
 117         </simplelist>
 118     </refsection>
 119 </refentry>