[doc] mv data_structures/types => core/types
[scilab.git] / scilab / modules / core / help / pt_BR / types / hypermat.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) 2007-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" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns4="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="hypermat" xml:lang="pt">
17     <refnamediv>
18         <refname>hypermat</refname>
19         <refpurpose>inicializa matrizes n-dimensionais</refpurpose>
20     </refnamediv>
21     <refsynopsisdiv>
22         <title>Seqüência de Chamamento</title>
23         <synopsis>M=hypermat(dims [,v])</synopsis>
24     </refsynopsisdiv>
25     <refsection>
26         <title>Parâmetros</title>
27         <variablelist>
28             <varlistentry>
29                 <term>dims</term>
30                 <listitem>
31                     <para>vetor de dimensões da hipermatriz </para>
32                 </listitem>
33             </varlistentry>
34             <varlistentry>
35                 <term>v</term>
36                 <listitem>
37                     <para>vetor de entradas da hipermatriz (valor padrão
38                         <literal>zeros(prod(dims),1)</literal>)
39                     </para>
40                 </listitem>
41             </varlistentry>
42         </variablelist>
43     </refsection>
44     <refsection>
45         <title>Descrição</title>
46         <para>Incializa uma hipermatriz cujas dimensões são dadas pelo vetor dims
47             e as entradas são dadas pelo argumento opcional
48             <literal>v</literal>
49         </para>
50         <para>A estrutura de dados de M contém o vetor de dimensões da matriz
51             <literal>M('dims')</literal> e o vetor de entradas
52             <literal>M('entries')</literal> tais que os índices subescritos mais à
53             esquerda variam primeiro:
54             <literal>[M(1,1,..);..;M(n1,1,..);...;M(1,n2,..);..;M(n1,n2,..);...]</literal>
55         </para>
56         <para>
57             Warning: If you build your own <literal>hypermat</literal>, you must be careful. The M('dims') entry must be a row vector whereas the M('entries') must be a column vector.
58         </para>
59     </refsection>
60     <refsection>
61         <title>Exemplos</title>
62         <programlisting role="example"><![CDATA[
63 M = hypermat([2 3 2 2],1:24)
64 disp(size(M('dims')))
65 disp(size(M('entries')))
66
67 M_own            = mlist(['hm','dims','entries']);
68 M_own('dims')    = [2 3 2 2];
69 M_own('entries') = [1:24]';
70 disp(size(M_own('dims')))
71 disp(size(M_own('entries')))
72  ]]></programlisting>
73     </refsection>
74     <refsection role="see also">
75         <title>See also</title>
76         <simplelist type="inline">
77             <member>
78                 <link linkend="hypermatrices">hypermatrices</link>
79             </member>
80             <member>
81                 <link linkend="zeros">zeros</link>
82             </member>
83             <member>
84                 <link linkend="ones">ones</link>
85             </member>
86             <member>
87                 <link linkend="grand">grand</link>
88             </member>
89             <member>
90                 <link linkend="matrix">matrix</link>
91             </member>
92         </simplelist>
93     </refsection>
94 </refentry>