summaryrefslogtreecommitdiffstats
path: root/scilab/modules/compatibility_functions/help/en_US/makecell.xml
blob: e8391b49c00b1b03afed3ef68f293d275c531cd8 (plain)
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
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
<?xml version="1.0" encoding="UTF-8"?>
<!--
    * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
    * Copyright (C) 2004-2007 - INRIA - Vincent COUVERT 
    * 
    * 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 version="5.0-subset Scilab" xml:id="makecell" xml:lang="fr"
          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">
  <info>
    <pubdate>$LastChangedDate: 18-04-2008 $</pubdate>
  </info>

  <refnamediv>
    <refname>makecell</refname>

    <refpurpose>Creates a cell array.</refpurpose>
  </refnamediv>

  <refsynopsisdiv>
    <title>Calling Sequence</title>

    <synopsis>s = makecell(dims,a1,a2,...an)</synopsis>
  </refsynopsisdiv>

  <refsection>
    <title>Parameters</title>

    <variablelist>
      <varlistentry>
        <term>dims</term>

        <listitem>
          <para>a vector with positive integer elements, the cell array
          dimension</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>a1,a2,...,an</term>

        <listitem>
          <para>Sequence of Scilab variables, <literal>n</literal> must be
          equal to <literal>prod(dims)</literal></para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>s</term>

        <listitem>
          <para>resulting cell array</para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsection>

  <refsection>
    <title>Description</title>

    <para><literal>s = makecell(dims,a1,a2,...an)</literal> creates a cell
    array of dimensions given by <literal>dims</literal> with the given input
    arguments. The <literal>ai</literal> are stored along the last dimension
    first.</para>
  </refsection>

  <refsection>
    <title>Examples</title>

    <programlisting role="example"> 
makecell([2,3],1,2,3,'x','y','z')
 </programlisting>
  </refsection>

  <refsection>
    <title>See Also</title>

    <simplelist type="inline">
      <member><link linkend="cell">cell</link></member>
    </simplelist>
  </refsection>

  <refsection>
    <title>Authors</title>

    <simplelist type="vert">
      <member>Farid Belhacen, INRIA</member>
    </simplelist>
  </refsection>
</refentry>