The Scilab/HDF5 specifications.
[scilab.git] / scilab / modules / data_structures / help / en_US / type.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <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="type">
3   <info>
4     <pubdate>$LastChangedDate$</pubdate>
5   </info>
6   <refnamediv>
7     <refname>type</refname>
8     <refpurpose>Returns the type of a variable</refpurpose>
9   </refnamediv>
10   <refsynopsisdiv>
11     <title>Calling Sequence</title>
12     <synopsis>[i]=type(x)</synopsis>
13   </refsynopsisdiv>
14   <refsection>
15     <title>Arguments</title>
16     <variablelist>
17       <varlistentry>
18         <term>x</term>
19         <listitem>
20           <para>Scilab object</para>
21         </listitem>
22       </varlistentry>
23       <varlistentry>
24         <term>i</term>
25         <listitem>
26           <para>integer</para>
27         </listitem>
28       </varlistentry>
29     </variablelist>
30   </refsection>
31   <refsection>
32     <title>Description</title>
33     <para><literal>type(x)</literal>  returns an integer which is the type of <literal>x</literal> as following :</para>
34     <para>
35      1 
36     :  real or complex constant matrix.</para>
37     <para>
38      2 
39     :  polynomial matrix.</para>
40     <para>
41      4 
42     :  boolean matrix.</para>
43     <para>
44      5
45     :  sparse matrix.</para>
46     <para>
47      6
48     :  sparse boolean matrix.</para>
49     <para>
50      7
51     :  Matlab sparse matrix.</para>
52     <para>
53      8
54     :  matrix of integers stored on 1 2 or 4 bytes.</para>
55     <para>
56      9
57     :  matrix of graphic handles.</para>
58     <para>
59      10 
60     :  matrix of character strings.</para>
61     <para>
62      11 
63     :  un-compiled function (Scilab code).</para>
64     <para>
65      13 
66     :  compiled function (Scilab code).</para>
67     <para>
68      14 
69     :  function library.</para>
70     <para>
71      15 
72     :  list.</para>
73     <para>
74      16 
75     :  typed list (tlist).</para>
76     <para>
77      17
78     :  matrix oriented typed list (mlist).</para>
79     <para>
80      128
81     : pointer (See <link linkend="lufact">lufact</link>).</para>
82     <para>
83      129
84     : size implicit polynomial used for indexing.</para>
85     <para>
86      130
87     : Scilab intrinsic (C or Fortran code).</para>
88   </refsection>
89   <refsection role="see also">
90 <title>See Also</title>
91     <simplelist type="inline">
92       <member>
93         <link linkend="typeof">typeof</link>
94       </member>
95       <member>
96         <link linkend="inttype">inttype</link>
97       </member>
98     </simplelist>
99   </refsection>
100 </refentry>