Coverity #1350601 Fixed
[scilab.git] / scilab / modules / elementary_functions / help / en_US / floating_point / double.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" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="double" xml:lang="en">
17     <refnamediv>
18         <refname>double</refname>
19         <refpurpose>conversion from integer to double precision
20             representation
21         </refpurpose>
22     </refnamediv>
23     <refsynopsisdiv>
24         <title>Syntax</title>
25         <synopsis>y=double(X)
26             y=int16(X)
27             y=int32(X)
28             y=uint8(X)
29             y=uint16(X)
30             y=uint32(X)
31         </synopsis>
32     </refsynopsisdiv>
33     <refsection>
34         <title>Arguments</title>
35         <variablelist>
36             <varlistentry>
37                 <term>X</term>
38                 <listitem>
39                     <para>matrix of floats or integers</para>
40                 </listitem>
41             </varlistentry>
42             <varlistentry>
43                 <term>y</term>
44                 <listitem>
45                     <para>matrix of floats</para>
46                 </listitem>
47             </varlistentry>
48         </variablelist>
49     </refsection>
50     <refsection>
51         <title>Description</title>
52         <para>converts data stored using one, two or four bytes integers into
53             double precision floating point representation. If <literal>X</literal>
54             entries are already double precision floats, nothing is done.
55         </para>
56     </refsection>
57     <refsection>
58         <title>Examples</title>
59         <programlisting role="example"><![CDATA[ 
60 x=int8([0 12 140])
61 double(x)
62  ]]></programlisting>
63     </refsection>
64     <refsection role="see also">
65         <title>See Also</title>
66         <simplelist type="inline">
67             <member>
68                 <link linkend="int8">int8</link>
69             </member>
70             <member>
71                 <link linkend="inttype">inttype</link>
72             </member>
73             <member>
74                 <link linkend="type">type</link>
75             </member>
76         </simplelist>
77     </refsection>
78 </refentry>