ISO-8859-1 to UTF-8
[scilab.git] / scilab / modules / compatibility_functions / help / en_US / mtlb_e.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) 2004-2007 - INRIA - Vincent COUVERT 
5     * 
6     * This file must be used under the terms of the CeCILL.
7     * This source file is licensed as described in the file COPYING, which
8     * you should have received as part of this distribution.  The terms
9     * are also available at    
10     * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
11     *
12     -->
13 <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="mtlb_e">
14   <info>
15     <pubdate>$LastChangedDate$</pubdate>
16   </info>
17   <refnamediv>
18     <refname>mtlb_e</refname>
19     <refpurpose>Matlab extraction emulation function</refpurpose>
20   </refnamediv>
21   <refsection>
22     <title>Description</title>
23     <para>Matlab and Scilab extraction behave differently in some particular cases:</para>
24     <itemizedlist>
25       <listitem>
26         <para>
27         When extracting data from a matrix with a vector as index: Matlab returns
28         a row vector and Scilab returns a column vector.
29         </para>
30       </listitem>
31       <listitem>
32         <para>
33         When extracting data from a character string matrix: due to the fact that character string matrices
34         in Matlab can be adressed as any other matrix (each character can be adressed), extraction in such a type of
35         matrix does not differ from other. But in Scilab it can't be done so and <literal>part</literal>
36         function has to be used. 
37         </para>
38       </listitem>
39     </itemizedlist>
40     <para>
41     The function <literal>mtlb_e(B,k)</literal> is used by
42     <literal>mfile2sci</literal> to replace <literal>A=B(k)</literal> when it was not
43     possible to know what were the operands while porting Matlab code to Scilab. This function will
44     determine the correct semantic at run time. If you want to have a
45     more efficient code it is possible to replace <literal>mtlb_e</literal> calls:
46     </para>
47     <itemizedlist>
48       <listitem>
49         <para>    
50         If <literal>B</literal> is a vector
51         <literal>A=mtlb_e(B,k)</literal> may be replaced by <literal>A=B(k)</literal>
52         </para>
53       </listitem>
54       <listitem>
55         <para>    
56         If <literal>B</literal> is a matrix
57         <literal>A=mtlb_e(B,k)</literal> may be replaced by <literal>A=B(k).'</literal>
58         </para>
59       </listitem>
60       <listitem>
61         <para>    
62         If <literal>B</literal> is a character string matrix and
63         k is a scalar or a vector
64         <literal>A=mtlb_e(B,k)</literal> may be replaced by <literal>A=part(B,k)</literal>
65         </para>
66       </listitem>
67     </itemizedlist>
68     <para>Caution: <literal>mtlb_e</literal> has not to be used for hand coded functions.</para>
69   </refsection>
70   <refsection>
71     <title>See Also</title>
72     <simplelist type="inline">
73       <member>
74         <link linkend="MatlabScilab_character_strings">Matlab-Scilab_character_strings</link>
75       </member>
76       <member>
77         <link linkend="part">part</link>
78       </member>
79     </simplelist>
80   </refsection>
81   <refsection>
82     <title>Authors</title>
83     <simplelist type="vert">
84       <member>V.C.</member>
85     </simplelist>
86   </refsection>
87 </refentry>