Update of the documentation
[scilab.git] / scilab / modules / external_objects_java / help / en_US / jconvMatrixMethod.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!--
3 *
4 * JIMS ( http://forge.scilab.org/index.php/p/JIMS/ ) - This file is a part of JIMS
5 * Copyright (C) 2010 - 2011 - Calixte DENIZET <calixte@contrib.scilab.org>
6 *
7 * This file must be used under the terms of the CeCILL.
8 * This source file is licensed as described in the file COPYING, which
9 * you should have received as part of this distribution.  The terms
10 * are also available at
11 * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
12 *
13 *
14 -->
15 <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="jconvMatrixMethod">
16     <refnamediv>
17         <refname>jconvMatrixMethod</refname>
18         <refpurpose>Set the way to convert matrices</refpurpose>
19     </refnamediv>
20     <refsynopsisdiv>
21         <title>Calling Sequence</title>
22         <synopsis>
23             method = jconvMatrixMethod()
24             jconvMatrixMethod(method)
25         </synopsis>
26     </refsynopsisdiv>
27     <refsection>
28         <title>Parameters</title>
29         <variablelist>
30             <varlistentry>
31                 <term>method</term>
32                 <listitem>
33                     <para>A string giving the type of conversion: 'rc' or 'cr'</para>
34                 </listitem>
35             </varlistentry>
36         </variablelist>
37     </refsection>
38     <refsection>
39         <title>Description</title>
40         <para>
41             In Scilab a matrix such as <literal>[1 2 3;4 5 6]</literal> is stored <literal>[1 4 2 5 3 6]</literal> (column by column). In Java the same matrix is stored as <literal>[-&gt;[1 2 3] -&gt;[4 5 6]]</literal> (array of pointers).
42         </para>
43         <para>
44             When method is 'cr' (column-row), the internal array <literal>[1 4 2 5 3 6]</literal> is passed as it is and Java creates the array <literal>[-&gt;[1 4] -&gt;[2 5] -&gt;[3 6]]</literal>.
45         </para>
46         <para>
47             When method is 'rc' (row-column), the array <literal>[1 4 2 5 3 6]</literal> is passed as <literal>[1 2 3 4 5 6]</literal> and converted into <literal>[-&gt;[1 2 3] -&gt;[4 5 6]]</literal>.
48         </para>
49         <para>
50             By default the method is set to 'cr'.
51         </para>
52     </refsection>
53     <refsection>
54         <title>Examples</title>
55         <programlisting role="example"><![CDATA[
56                jconvMatrixMethod()
57                jconvMatrixMethod("cr")
58       ]]></programlisting>
59     </refsection>
60 </refentry>