summaryrefslogtreecommitdiff
path: root/modules/integer/help/en_US/iconvert.xml
blob: 4823a4bea04aa820d8c6885b860a5041be2999cb (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
<?xml version="1.0" encoding="UTF-8"?>
<!--
 * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
 * Copyright (C) INRIA - 
 * 
 * This file must be used under the terms of the CeCILL.
 * This source file is licensed as described in the file COPYING, which
 * you should have received as part of this distribution.  The terms
 * are also available at    
 * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt
 *
 -->
<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="iconvert">
    <refnamediv>
        <refname>iconvert</refname>
        <refpurpose> conversion to 1 or 4 byte integer representation</refpurpose>
    </refnamediv>
    <refsynopsisdiv>
        <title>Calling Sequence</title>
        <synopsis>y = iconvert(X, itype)</synopsis>
    </refsynopsisdiv>
    <refsection>
        <title>Arguments</title>
        <variablelist>
            <varlistentry>
                <term>X</term>
                <listitem>
                    <para>a matrix of floats or integers.</para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>itype</term>
                <listitem>
                    <para>an integer, a type of conversion.</para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>y</term>
                <listitem>
                    <para>a matrix of integers coded on one, two or four bytes.</para>
                </listitem>
            </varlistentry>
        </variablelist>
    </refsection>
    <refsection>
        <title>Description</title>
        <para>
            The <function>iconvert</function> function converts and stores data to one, two or four bytes integers.
        </para>
        <variablelist>
            <varlistentry>
                <term>itype = 0</term>
                <listitem>
                    <para>return floating point numbers</para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>itype = 1</term>
                <listitem>
                    <para>
                        return <literal>int8</literal> numbers in the range <literal>[-128, 127]</literal>
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>itype = 11</term>
                <listitem>
                    <para>
                        return <literal>uint8</literal> numbers in the range <literal>[0, 255]</literal>
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>itype = 2</term>
                <listitem>
                    <para>
                        return <literal>int16</literal> numbers in the range <literal>[-32768, 32767]</literal>
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>itype = 12</term>
                <listitem>
                    <para>
                        return <literal>uint16</literal> numbers in the range <literal>[0, 65535]</literal>
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>itype = 4</term>
                <listitem>
                    <para>
                        return <literal>int32</literal> numbers in the range <literal>[-2147483648, 2147483647]</literal>
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>itype = 14</term>
                <listitem>
                    <para>
                        return <literal>uint32</literal> numbers in the range <literal>[0, 4294967295]</literal>
                    </para>
                </listitem>
            </varlistentry>
        </variablelist>
    </refsection>
    <refsection>
        <title>Examples</title>
        <programlisting role="example"><![CDATA[ 
b=int32([1 -120 127 312])
y=iconvert(b,1)

typeof(b)
typeof(y)
 ]]></programlisting>
    </refsection>
    <refsection role="see also">
        <title>See Also</title>
        <simplelist type="inline">
            <member>
                <link linkend="double">double</link>
            </member>
            <member>
                <link linkend="int8">int8</link>
            </member>
            <member>
                <link linkend="inttype">inttype</link>
            </member>
        </simplelist>
    </refsection>
</refentry>