File: cell.xml

package info (click to toggle)
scilab 5.2.2-9
  • links: PTS, VCS
  • area: main
  • in suites: squeeze
  • size: 334,832 kB
  • ctags: 52,586
  • sloc: xml: 526,945; ansic: 223,590; fortran: 163,080; java: 56,934; cpp: 33,840; tcl: 27,936; sh: 20,397; makefile: 9,908; ml: 9,451; perl: 1,323; cs: 614; lisp: 30
file content (184 lines) | stat: -rw-r--r-- 4,637 bytes parent folder | download
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
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
<?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 version="5.0-subset Scilab" xml:id="cell" xml:lang="en"
          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: 2008-03-26 09:50:39 +0100 (mer, 26 mar 2008)
    $</pubdate>
  </info>

  <refnamediv>
    <refname>cell</refname>

    <refpurpose>Create a cell array of empty matrices.</refpurpose>
  </refnamediv>

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

    <synopsis>
c=cell()
c=cell(m1)
c=cell(m1, m2)
c=cell(m1, m2, ..., mn)
c=cell(x)
</synopsis>
  </refsynopsisdiv>

  <refsection>
    <title>Parameters</title>

    <variablelist>
      <varlistentry>
        <term>x</term>

        <listitem>
          <para>Vector containing the dimensions of the cell to create.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>m1, m2,..</term>

        <listitem>
          <para>Dimensions of the cell to create.</para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsection>

  <refsection>
    <title>Description</title>

    <para>Returns the create cell of empty matrices.</para>

    <variablelist>
      <varlistentry>
        <term>cell()</term>

        <listitem>
          <para>returns a <literal>(0,0)</literal> cell array of empty
          matrices.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>cell(m1)</term>

        <listitem>
          <para>returns a <literal>(m1,m1)</literal> cell array of empty
          matrices.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>cell(m1,m2)</term>

        <listitem>
          <para>returns a <literal>(m1,m2) </literal>cell array of empty
          matrices.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>cell(m1,m2,..,mn)</term>

        <listitem>
          <para>creates a <literal>(m1,m2,..,mn)</literal> cell array of empty
          matrices.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>cell(x)</term>

        <listitem>
          <para>returns a cell array of empty matrices with: the first
          dimension of the cell array is <literal>x(1)</literal>, the second
          dimension is <literal>x(2), ...</literal></para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsection>

  <refsection>
    <title>Remarks</title>

    <para><literal>cell(x) </literal>is not the same size that
    <literal>x</literal>.</para>

    <para><literal>cell()</literal> is equivalent to
    <literal>cell(0)</literal>.</para>

    <para>If A is a cell array, you can access the contents of an element of A
    by using <literal>A(m1, m2, ..., mn).entries</literal>, the expression
    <literal>A(1,1) = zeros(2,2)</literal> is not valid, the right syntax is
    <literal>A(1,1).entries = zeros(2,2)</literal>.</para>

    <para>If A is a cell array, you can get its dimensions by using
    <literal>A.dims</literal>.</para>
  </refsection>

  <refsection>
    <title>Examples</title>

    <programlisting role="example"><![CDATA[ 
a=cell(3)
b=cell(3,1)
c=cell([2,3,4])

// Assigning cell entries
b=cell(3,1);

// Assigning the first element of b using the 'entries' field
b(1).entries=1:3

// Assigning the second element of b using the 'entries' field
b(2).entries='Scilab'

// Assigning the third element of b using the 'entries' field
b(3).entries=poly(1:3,'s')

// Assigning sub-cells
X=cell(3,2);
X(:,1)=b

// Extracting a sub-cell: result is a cell
b(1)
b(1:2)

// Extracting a sub-cell value: result is an array
b(1).entries

// Dimensions of b
b.dims
 ]]></programlisting>
  </refsection>

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

    <simplelist type="inline">
      <member><link linkend="eye">eye</link></member>

      <member><link linkend="ones">ones</link></member>

      <member><link linkend="zeros">zeros</link></member>
    </simplelist>
  </refsection>
</refentry>