e8f36a0dfd945147b27deb3241a0d93a694db6c3
[scilab.git] / scilab / modules / data_structures / help / en_US / lstsize.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) 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"
17           xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml"
18           xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook"
19           xmlns:scilab="http://www.scilab.org" xml:id="lstsize" xml:lang="en">
20     <refnamediv>
21         <refname>lstsize</refname>
22         <refpurpose>list, tlist, mlist numbers of entries <emphasis role="bold">(obsolete)</emphasis>
23         </refpurpose>
24     </refnamediv>
25     <refsynopsisdiv>
26         <title>Syntax</title>
27         <synopsis>n=lstsize(l)</synopsis>
28     </refsynopsisdiv>
29     <refsection>
30         <title>Arguments</title>
31         <variablelist>
32             <varlistentry>
33                 <term>l</term>
34                 <listitem>
35                     <para>a list, tlist or mlist object</para>
36                 </listitem>
37             </varlistentry>
38             <varlistentry>
39                 <term>n</term>
40                 <listitem>
41                     <para>an integer, the number of entries</para>
42                 </listitem>
43             </varlistentry>
44         </variablelist>
45     </refsection>
46     <refsection>
47         <title>Description</title>
48         <para>
49             <literal>lstsize(l)</literal> returns the number of entries for
50             list, list, mlist objects. This function is more efficient than the
51             <literal>size</literal> function and works similarly with all list types
52             while <literal>size</literal> is overloaded for <literal>mlist</literal>
53             objects.
54         </para>
55     </refsection>
56     <refsection>
57         <title>Examples</title>
58         <programlisting role="example"><![CDATA[
59 lstsize(list(1,'aqsdf'))
60 x=ssrand(3,2,4);
61 [ny,nu]=size(x)
62 lstsize(x)
63  ]]></programlisting>
64     </refsection>
65     <refsection role="see also">
66         <title>See also</title>
67         <simplelist type="inline">
68             <member>
69                 <link linkend="length">length</link>
70             </member>
71             <member>
72                 <link linkend="size">size</link>
73             </member>
74             <member>
75                 <link linkend="list">list</link>
76             </member>
77             <member>
78                 <link linkend="tlist">tlist</link>
79             </member>
80             <member>
81                 <link linkend="mlist">mlist</link>
82             </member>
83         </simplelist>
84     </refsection>
85     <refsection role="history">
86         <title>History</title>
87         <revhistory>
88             <revision>
89                 <revnumber>6.0.1</revnumber>
90                 <revdescription>
91                     <literal>lstsize()</literal> is declared obsolete, to be removed from Scilab 6.1.
92                     Please use <literal>size()</literal> instead.
93                 </revdescription>
94             </revision>
95         </revhistory>
96     </refsection>
97 </refentry>