CeCILL license headers
[scilab.git] / scilab / modules / compatibility_functions / help / en_US / mtlb_eig.xml
1 <?xml version="1.0" encoding="ISO-8859-1" standalone="no"?>
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 <!DOCTYPE MAN SYSTEM "../../../../modules/helptools/help.dtd">
14 <MAN>
15   <LANGUAGE>eng</LANGUAGE>
16   <TITLE>mtlb_eig</TITLE>
17   <TYPE>M2SCI function</TYPE>
18   <DATE>$LastChangedDate$</DATE>
19
20   <SHORT_DESCRIPTION name="mtlb_eig">Matlab eig emulation function</SHORT_DESCRIPTION>
21
22   <DESCRIPTION>
23     
24     <P>Matlab <VERB>eig</VERB> and Scilab <VERB>spec</VERB> behave differently in some particular cases:</P>
25
26     <DESCRIPTION_INDENT>
27     <DESCRIPTION_ITEM>
28     <ITEMIZE>
29       <ITEM>
30         <SP>
31         With one input (A) and two outputs (V,D), Matlab and Scilab returned eigen values have opposite signs.
32          </SP>
33       </ITEM>
34     </ITEMIZE>
35     </DESCRIPTION_ITEM>
36     </DESCRIPTION_INDENT>
37
38     <P>
39     The function <VERB>[V,D] = mtlb_eig(A)</VERB> is used by
40     <VERB>mfile2sci</VERB> to replace <VERB>>[V,D] = eig(A)</VERB>.
41     This function will determine the correct semantic at run time. There is no replacement possibility for it.
42     </P>
43
44     <P>Caution: <VERB>mtlb_eig</VERB> has not to be used for hand coded functions.</P>
45
46   </DESCRIPTION>
47
48   <AUTHORS>
49     <AUTHORS_ITEM>V.C.</AUTHORS_ITEM>
50   </AUTHORS>
51 </MAN>