Online help : converted XML files that valid the new scilab.rnc schema.
[scilab.git] / scilab / modules / compatibility_functions / help / en_US / mtlb_eig.xml
1 <?xml version="1.0" encoding="ISO-8859-1"?>
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_eig"><info><pubdate>$LastChangedDate$</pubdate></info><refnamediv><refname>mtlb_eig</refname><refpurpose>Matlab eig emulation function</refpurpose></refnamediv>
14   
15   
16   
17   
18
19   
20
21   <refsection><title>Description</title>
22     
23     <para>Matlab <literal>eig</literal> and Scilab <literal>spec</literal> behave differently in some particular cases:</para>
24
25     <itemizedlist>
26     <listitem>
27     <itemizedlist>
28       <listitem>
29         <para>
30         With one input (A) and two outputs (V,D), Matlab and Scilab returned eigen values have opposite signs.
31          </para>
32       </listitem>
33     </itemizedlist>
34     </listitem>
35     </itemizedlist>
36
37     <para>
38     The function <literal>[V,D] = mtlb_eig(A)</literal> is used by
39     <literal>mfile2sci</literal> to replace <literal>&gt;[V,D] = eig(A)</literal>.
40     This function will determine the correct semantic at run time. There is no replacement possibility for it.
41     </para>
42
43     <para>Caution: <literal>mtlb_eig</literal> has not to be used for hand coded functions.</para>
44
45   </refsection>
46
47   <refsection><title>Authors</title><simplelist type="vert">
48     <member>V.C.</member>
49   </simplelist></refsection>
50 </refentry>