scilab/modules/elementary_functions/help/pt_BR/sub2ind.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 - Serge STEER
   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="sub2ind" xml:lang="pt">
  17     <refnamediv>
  18         <refname>sub2ind</refname>
  19         <refpurpose>converte matriz de valores subescrtos para índice
  20             linear
  21         </refpurpose>
  22     </refnamediv>
  23     <refsynopsisdiv>
  24         <title>Seqüência de Chamamento</title>
  25         <synopsis>I = sub2ind(dims,i1,i2,...)
  26             J = sub2ind(dims,Mi)
  27         </synopsis>
  28     </refsynopsisdiv>
  29     <refsection>
  30         <title>Parâmetros</title>
  31         <variablelist>
  32             <varlistentry>
  33                 <term>dims</term>
  34                 <listitem>
  35                     <para>vetor, as dimensões da matriz </para>
  36                 </listitem>
  37             </varlistentry>
  38             <varlistentry>
  39                 <term>i1,i2,...</term>
  40                 <listitem>
  41                     <para>os arrays de valores subescritos (de mesma forma que a matriz
  42                         <literal>I</literal>)
  43                     </para>
  44                 </listitem>
  45             </varlistentry>
  46             <varlistentry>
  47                 <term>Mi</term>
  48                 <listitem>
  49                     <para>matriz cujas colunas contém os valores subescritos. </para>
  50                 </listitem>
  51             </varlistentry>
  52             <varlistentry>
  53                 <term>I</term>
  54                 <listitem>
  55                     <para>o array de índice linear</para>
  56                 </listitem>
  57             </varlistentry>
  58         </variablelist>
  59     </refsection>
  60     <refsection>
  61         <title>Descrição</title>
  62         <para>
  63             <literal>sub2ind</literal> é usado para determinar o índice único
  64             equivalente que corresponde ao dado conjunto de valores subescritos.
  65             <literal>I = sub2ind(dims,i1,i2,..)</literal> retorna o índice linear
  66             equivalente aos subescritos das linha, coluna, ... nos arrays
  67             <literal>i1</literal>, <literal>i2</literal>,.. para uma matriz de tamanho
  68             <literal>dims</literal>. Neste caso, <literal>i1</literal>,
  69             <literal>i2</literal>,.. devem ter o mesmo formato e o resultado
  70             <literal>I</literal> tem a mesma forma da matriz. <literal>I =
  71                 sub2ind(dims,Mi)
  72             </literal>
  73             retorna o índice linear equivalente aos
  74             subescritos nas colunas da matriz <literal>Mi</literal> para uma matriz
  75             com tamanho <literal>dims</literal>. Neste caso <literal>I</literal> é um
  76             vetor coluna.
  77         </para>
  78     </refsection>
  79     <refsection>
  80         <title>Exemplos</title>
  81         <programlisting role="example"><![CDATA[
  82 i=[1 2 1 1 2 1 1];
  83 j=[1 2 3 1 2 3 3];
  84 k=[1 2 1 2 1 2 1];
  85 sub2ind([2,3,2],i,j,k)
  86
  87 sub2ind([2,3,2],[i',j',k'])
  88  ]]></programlisting>
  89     </refsection>
  90     <refsection role="see also">
  91         <title>Ver Também</title>
  92         <simplelist type="inline">
  93             <member>
  94                 <link linkend="ind2sub">ind2sub</link>
  95             </member>
  96             <member>
  97                 <link linkend="extraction">extraction</link>
  98             </member>
  99             <member>
 100                 <link linkend="insertion">insertion</link>
 101             </member>
 102         </simplelist>
 103     </refsection>
 104 </refentry>