The Scilab/HDF5 specifications.
[scilab.git] / scilab / modules / elementary_functions / help / en_US / typeof.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  * This file must be used under the terms of the CeCILL.
7  * This source file is licensed as described in the file COPYING, which
8  * you should have received as part of this distribution.  The terms
9  * are also available at    
10  * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
11  *
12  -->
13 <refentry version="5.0-subset Scilab" xml:id="typeof" xml:lang="en"
14           xmlns="http://docbook.org/ns/docbook"
15           xmlns:xlink="http://www.w3.org/1999/xlink"
16           xmlns:svg="http://www.w3.org/2000/svg"
17           xmlns:ns5="http://www.w3.org/1999/xhtml"
18           xmlns:mml="http://www.w3.org/1998/Math/MathML"
19           xmlns:db="http://docbook.org/ns/docbook">
20   <info>
21     <pubdate>$LastChangedDate$</pubdate>
22   </info>
23
24   <refnamediv>
25     <refname>typeof</refname>
26
27     <refpurpose>object type</refpurpose>
28   </refnamediv>
29
30   <refsynopsisdiv>
31     <title>Calling Sequence</title>
32
33     <synopsis>[t]=typeof(object)</synopsis>
34   </refsynopsisdiv>
35
36   <refsection>
37     <title>Arguments</title>
38
39     <variablelist>
40       <varlistentry>
41         <term>object</term>
42
43         <listitem>
44           <para>Scilab object</para>
45         </listitem>
46       </varlistentry>
47
48       <varlistentry>
49         <term>t</term>
50
51         <listitem>
52           <para>string</para>
53         </listitem>
54       </varlistentry>
55     </variablelist>
56   </refsection>
57
58   <refsection>
59     <title>Description</title>
60
61     <para><literal>t=typeof(object)</literal> returns one of the following
62     strings:</para>
63
64     <variablelist>
65       <varlistentry>
66         <term>"constant"</term>
67
68         <listitem>
69           <para>if object is a real or complex constant matrix.</para>
70         </listitem>
71       </varlistentry>
72
73       <varlistentry>
74         <term>"polynomial"</term>
75
76         <listitem>
77           <para>if object is a polynomial matrix.</para>
78         </listitem>
79       </varlistentry>
80
81       <varlistentry>
82         <term>"function"</term>
83
84         <listitem>
85           <para>if object is a function (Scilab code).</para>
86         </listitem>
87       </varlistentry>
88
89       <varlistentry>
90         <term>"handle"</term>
91
92         <listitem>
93           <para>if object is a handle.</para>
94         </listitem>
95       </varlistentry>
96
97       <varlistentry>
98         <term>"string"</term>
99
100         <listitem>
101           <para>if object is a matrix made of character strings.</para>
102         </listitem>
103       </varlistentry>
104
105       <varlistentry>
106         <term>"boolean"</term>
107
108         <listitem>
109           <para>if object is a boolean matrix.</para>
110         </listitem>
111       </varlistentry>
112
113       <varlistentry>
114         <term>"list"</term>
115
116         <listitem>
117           <para>if object is a list.</para>
118         </listitem>
119       </varlistentry>
120
121       <varlistentry>
122         <term>"rational"</term>
123
124         <listitem>
125           <para>if object is a rational matrix (transfer matrix).</para>
126         </listitem>
127       </varlistentry>
128
129       <varlistentry>
130         <term>"state-space"</term>
131
132         <listitem>
133           <para>if object is a state-space model (see <link
134           linkend="syslin">syslin</link>).</para>
135         </listitem>
136       </varlistentry>
137
138       <varlistentry>
139         <term>"sparse"</term>
140
141         <listitem>
142           <para>if object is a (real) sparse matrix.</para>
143         </listitem>
144       </varlistentry>
145
146       <varlistentry>
147         <term>"boolean sparse"</term>
148
149         <listitem>
150           <para>if object is a boolean sparse matrix.</para>
151         </listitem>
152       </varlistentry>
153
154       <varlistentry>
155         <term>"hypermat"</term>
156
157         <listitem>
158           <para>if object is a hypermatrix (N-dimension array with N
159           &gt;=3).</para>
160         </listitem>
161       </varlistentry>
162
163       <varlistentry>
164         <term>"st"</term>
165
166         <listitem>
167           <para>if object is a structure array.</para>
168         </listitem>
169       </varlistentry>
170
171       <varlistentry>
172         <term>"ce"</term>
173
174         <listitem>
175           <para>if object is a cell array.</para>
176         </listitem>
177       </varlistentry>
178
179       <varlistentry>
180         <term>the first string in the first list entry</term>
181
182         <listitem>
183           <para>if object is a tlist or mlist.</para>
184         </listitem>
185       </varlistentry>
186
187       <varlistentry>
188         <term>"fptr"</term>
189
190         <listitem>
191           <para>if object is a Scilab intrinsic (C or Fortran code).</para>
192         </listitem>
193       </varlistentry>
194
195       <varlistentry>
196         <term>"pointer"</term>
197
198         <listitem>
199           <para>if object is a pointer (See <link
200           linkend="lufact">lufact</link>).</para>
201         </listitem>
202       </varlistentry>
203
204       <varlistentry>
205         <term>"size implicit"</term>
206
207         <listitem>
208           <para>if object is a size implicit polynom used for indexing.</para>
209         </listitem>
210       </varlistentry>
211       <varlistentry>
212         <term>"library"</term>
213         <listitem>
214           <para>if object is function library.</para>
215         </listitem>
216       </varlistentry>
217       <varlistentry>
218         <term>"int8" or "uint8" or "int16" or "uint16" or "int32" or "uint32"</term>
219         <listitem>
220           <para>if object is a matrix of [unsigned] integers stored on 8, 16 or 32 bits. See <link
221           linkend="int8">int8</link>)</para>
222         </listitem>
223       </varlistentry>
224     </variablelist>
225   </refsection>
226
227   <refsection>
228     <title>Examples</title>
229
230     <programlisting role="example"><![CDATA[ 
231 typeof(1)
232 typeof(poly(0,'x'))
233
234 typeof(1/poly(0,'x'))
235 typeof(%t)
236
237 w=sprand(100,100,0.001);
238 typeof(w)
239 typeof(w==w)
240
241 deff('y=f(x)','y=2*x');
242 typeof(f)
243
244 L=tlist(['V','a','b'],18,'Scilab');
245 typeof(L)
246
247 typeof(corelib)
248  ]]></programlisting>
249   </refsection>
250
251   <refsection role="see also">
252 <title>See Also</title>
253
254     <simplelist type="inline">
255       <member><link linkend="type">type</link></member>
256
257       <member><link linkend="strings">strings</link></member>
258
259       <member><link linkend="syslin">syslin</link></member>
260
261       <member><link linkend="poly">poly</link></member>
262     </simplelist>
263   </refsection>
264 </refentry>