[doc] misc. fix & improvements
[scilab.git] / scilab / modules / external_objects_java / help / en_US / jwrapinfloat.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!--
3 *
4 * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
5 * Copyright (C) 2010 - 2011 - Calixte DENIZET <calixte@contrib.scilab.org>
6 *
7  * Copyright (C) 2012 - 2016 - Scilab Enterprises
8  *
9  * This file is hereby licensed under the terms of the GNU GPL v2.0,
10  * pursuant to article 5.3.4 of the CeCILL v.2.1.
11  * This file was originally licensed under the terms of the CeCILL v2.1,
12  * and continues to be available under such terms.
13  * For more information, see the COPYING file which you should have received
14  * along with this program.
15 *
16 *
17 -->
18 <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="jwrapinfloat">
19     <refnamediv>
20         <refname>jwrapinfloat</refname>
21         <refpurpose>Wrap Scilab double matrix into Java float multiarray.</refpurpose>
22     </refnamediv>
23     <refsynopsisdiv>
24         <title>Syntax</title>
25         <synopsis>
26             [jw_1, jw_2, ...] = jwrapinfloat(sc_1 [, sc_2 [, sc_3 [,... ]]])
27         </synopsis>
28     </refsynopsisdiv>
29     <refsection>
30         <title>Parameters</title>
31         <variablelist>
32             <varlistentry>
33                 <term>sc_i</term>
34                 <listitem>
35                     <para>A Scilab variable</para>
36                 </listitem>
37             </varlistentry>
38             <varlistentry>
39                 <term>jw_i</term>
40                 <listitem>
41                     <para>A Java wrapping in a float of the corresponding Scilab variable</para>
42                 </listitem>
43             </varlistentry>
44         </variablelist>
45     </refsection>
46     <refsection>
47         <title>Description</title>
48         <para>
49             Since the float data type does not exist in Scilab, it is possible with this function to wrap a double in a float.
50         </para>
51     </refsection>
52     <refsection>
53         <title>Examples</title>
54         <programlisting role="example"><![CDATA[
55                f = jwrapinfloat(%pi);
56       ]]></programlisting>
57     </refsection>
58     <refsection role="see also">
59         <title>See also</title>
60         <simplelist type="inline">
61             <member>
62                 <link linkend="jwrap">jwrap</link>
63             </member>
64             <member>
65                 <link linkend="jwrapinchar">jwrapinchar</link>
66             </member>
67             <member>
68                 <link linkend="junwrap">junwrap</link>
69             </member>
70         </simplelist>
71     </refsection>
72     <refsection>
73         <title>History</title>
74         <revhistory>
75             <revision>
76                 <revnumber>5.5.0</revnumber>
77                 <revremark>
78                     Function introduced. Based on the 'JIMS' module. The main difference in the behavior compared to the JIMS module is that <link linkend="jautoUnwrap">jautoUnwrap</link> is enabled by default.
79                 </revremark>
80             </revision>
81         </revhistory>
82     </refsection>
83 </refentry>
84