1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79
|
<?xml version="1.0" encoding="UTF-8"?>
<!--
* Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
* Copyright (C) 2007-2008 - INRIA
*
* 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
* http://www.cecill.info/licences/Licence_CeCILL_V2-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:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" version="5.0-subset Scilab" xml:lang="en" xml:id="hypermat">
<info>
<pubdate>$LastChangedDate$</pubdate>
</info>
<refnamediv>
<refname>hypermat</refname>
<refpurpose> initialize an N dimensional matrices</refpurpose>
</refnamediv>
<refsynopsisdiv>
<title>Calling Sequence</title>
<synopsis>M=hypermat(dims [,v])</synopsis>
</refsynopsisdiv>
<refsection>
<title>Parameters</title>
<variablelist>
<varlistentry>
<term>dims</term>
<listitem>
<para>vector of hypermatrix dimensions</para>
</listitem>
</varlistentry>
<varlistentry>
<term>v</term>
<listitem>
<para>vector of hypermatrix entries (default value <literal>zeros(prod(dims),1)</literal>)</para>
</listitem>
</varlistentry>
</variablelist>
</refsection>
<refsection>
<title>Description</title>
<para>
Initialize an hypermatrix whose dimensions are given in the vector dims
and entries are given in optional argument <literal>v</literal></para>
<para>
M data structure contains the vector of matrix dimensions
<literal>M('dims')</literal> and the vector of entries <literal>M('entries')</literal> such as
the leftmost subcripts vary first
<literal>[M(1,1,..);..;M(n1,1,..);...;M(1,n2,..);..;M(n1,n2,..);...]</literal></para>
</refsection>
<refsection>
<title>Examples</title>
<programlisting role="example"><![CDATA[
M=hypermat([2 3 2 2],1:24)
]]></programlisting>
</refsection>
<refsection>
<title>See Also</title>
<simplelist type="inline">
<member>
<link linkend="hypermatrices">hypermatrices</link>
</member>
<member>
<link linkend="zeros">zeros</link>
</member>
<member>
<link linkend="ones">ones</link>
</member>
<member>
<link linkend="grand">grand</link>
</member>
<member>
<link linkend="matrix">matrix</link>
</member>
</simplelist>
</refsection>
</refentry>
|