The Scilab/HDF5 specifications.
[scilab.git] / scilab / modules / data_structures / help / en_US / typename.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="typename">
3   <info>
4     <pubdate>$LastChangedDate$</pubdate>
5   </info>
6   <refnamediv>
7     <refname>typename</refname>
8     <refpurpose> associates a name to variable type</refpurpose>
9   </refnamediv>
10   <refsynopsisdiv>
11     <title>Calling Sequence</title>
12     <synopsis>[types [ [,names]]=typename()
13 typename(name,type)</synopsis>
14   </refsynopsisdiv>
15   <refsection>
16     <title>Arguments</title>
17     <variablelist>
18       <varlistentry>
19         <term>types</term>
20         <listitem>
21           <para>integer column vector: the types codes of each defined data types.</para>
22         </listitem>
23       </varlistentry>
24       <varlistentry>
25         <term>names</term>
26         <listitem>
27           <para>column vector of strings: the names associated to type codes.</para>
28         </listitem>
29       </varlistentry>
30       <varlistentry>
31         <term>type</term>
32         <listitem>
33           <para>integer: the type code of new data type.</para>
34         </listitem>
35       </varlistentry>
36       <varlistentry>
37         <term>name</term>
38         <listitem>
39           <para>string: the name associated to the type code</para>
40         </listitem>
41       </varlistentry>
42     </variablelist>
43   </refsection>
44   <refsection>
45     <title>Description</title>
46     <para>
47     The function and operator overloading make use of a formal name
48     associated to data types to form the name of the overloading function
49     (see overloading). The <literal>typename</literal> can be used to handle this
50     formal names for hard coded data types (the <literal>tlist</literal> or <literal>mlist</literal>
51     coded data types formal names are defined in an other way, see <literal>overloading</literal>).</para>
52     <para>
53     Called without right hand side argument, <literal>typename</literal> returns
54     information on defined data types.</para>
55     <para>
56     Called with right hand side argument, <literal>typename</literal> associates a name
57     to a data type code.</para>
58     <para><literal>typename('',type)</literal> suppress the data type given by its code
59     <literal>type</literal> out of the table of known data types.</para>
60     
61     <para>Number max. of defined types is 50.</para>
62     
63   </refsection>
64   <refsection role="see also">
65 <title>See Also</title>
66     <simplelist type="inline">
67       <member>
68         <link linkend="type">type</link>
69       </member>
70       <member>
71         <link linkend="typeof">typeof</link>
72       </member>
73       <member>
74         <link linkend="overloading">overloading</link>
75       </member>
76       <member>
77         <link linkend="tlist">tlist</link>
78       </member>
79       <member>
80         <link linkend="mlist">mlist</link>
81       </member>
82     </simplelist>
83   </refsection>
84 </refentry>