Update cell help page.
[scilab.git] / scilab / modules / data_structures / help / en_US / cell.xml
index 120dc17..5f19583 100644 (file)
             <code>cell()</code> is equivalent to <code>cell(0)</code>.
         </para>
         <para>
-            If <literal>A</literal> is a cell array, you can access the contents of an element of <literal>A</literal> by using <code>A(m1, m2, ..., mn).entries</code>. The expression <code>A(1,1) = zeros(2,2)</code> is not valid, the right syntax is
-            <code>A(1,1).entries = zeros(2,2)</code>.
-        </para>
-        <para>
-            If <literal>A</literal> is a cell array, you can get its dimensions by using <code>A.dims</code> which returns an <literal>int32</literal> value that cannot be used as a subscript for the cell array. In this case, the best way to get the cell array dimensions is <code>size(A)</code>.
+            If <literal>A</literal> is a cell array, you can access the contents of an element of <literal>A</literal> by using <code>A{m1, m2, ..., mn}</code>. The expression <code>A(1,1) = zeros(2,2)</code> is not valid, the right syntax is
+            <code>A{1,1} = zeros(2,2)</code>.
         </para>
     </refsection>
     <refsection>
         <title>Examples</title>
         <programlisting role="example"><![CDATA[ 
-a=cell(3)
-b=cell(3,1)
-c=cell([2,3,4])
+a = cell(3)
+b = cell(3,1)
+c = cell([2,3,4])
  
 // Assigning cell entries
-b=cell(3,1);
+b = cell(3,1);
  
-// Assigning the first element of b using the 'entries' field
-b(1).entries=1:3
+// Assigning the first element of b using {}
+b{1} = 1:3
  
-// Assigning the second element of b using the 'entries' field
-b(2).entries='Scilab'
+// Assigning the second element of b using {}
+b{2} = 'Scilab'
  
 // Assigning the third element of b using the 'entries' field
-b(3).entries=poly(1:3,'s')
+b{3} = poly(1:3,'s')
  
 // Assigning sub-cells
-X=cell(3,2);
-X(:,1)=b
+X = cell(3,2);
+X{:,1} = b
  
 // Extracting a sub-cell: result is a cell
-b(1)
-b(1:2)
+b{1}
+b{1:2}
  
 // Extracting a sub-cell value: result is an array
-b(1).entries
+b{1}
  
-// Dimensions of b as an int32 value (cannot be used as an index)
-b.dims
 // Dimensions of b as a double value
 size(b)
  ]]></programlisting>
     </refsection>
     <refsection role="see also">
@@ -159,6 +153,22 @@ size(b)
             <member>
                 <link linkend="zeros">zeros</link>
             </member>
+            <member>
+                <link linkend="iscell">iscell</link>
+            </member>
         </simplelist>
     </refsection>
+    <refsection>
+        <title>History</title>
+        <revhistory>
+            <revision>
+                <revnumber>6.0.0</revnumber>
+                <revremark>
+                    <para>
+                        Fields "entries" and "dims" do not exist anymore. To assign or extract an element, use {}.
+                    </para>
+                </revremark>
+            </revision>
+        </revhistory>
+    </refsection>
 </refentry>