a22da3ffdd2eeded9d22d730b95186c6944efda1
[scilab.git] / scilab_doc / Matlab_Scilab_dictionary / 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) 2009 - DIGITEO - 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:id="eig">
14   <refnamediv>
15     <refname>eig</refname>
16     <refpurpose>(Matlab function) Find eigenvalues and eigenvectors</refpurpose>
17   </refnamediv>
18   <refsection>
19     <title>Matlab/Scilab equivalent</title>
20     <para>
21       <informaltable border="1" pgwide="1">
22         <tr>
23           <td align="center">
24             <emphasis role="bold">Matlab</emphasis>
25           </td>
26           <td align="center">
27             <emphasis role="bold">Scilab</emphasis>
28           </td>
29         </tr>
30         <tr>
31           <td>
32             <programlisting role="example"><![CDATA[
33 eig
34 ]]></programlisting>
35           </td>
36           <td>
37             <programlisting role="example"><![CDATA[
38 spec
39 bdiag
40 ]]></programlisting>
41           </td>
42         </tr>
43       </informaltable>
44     </para>
45   </refsection>
46   <refsection>
47     <title>Particular cases</title>
48     <variablelist>
49       <varlistentry>
50         <term>eig(A)</term>
51         <listitem>
52           <para>
53 Scilab equivalent for <emphasis role="bold">eig(A)</emphasis> is <emphasis role="bold">spec(A)</emphasis>. Scilab eigen vector matrix can differ from Matlab one...
54 </para>
55         </listitem>
56       </varlistentry>
57       <varlistentry>
58         <term>eig(A,'nobalance')</term>
59         <listitem>
60           <para>
61 There is no Scilab equivalent for <emphasis role="bold">'nobalance'</emphasis> option. See examples...
62 </para>
63         </listitem>
64       </varlistentry>
65       <varlistentry>
66         <term>eig(A,B,flag)</term>
67         <listitem>
68           <para>
69 There is no Scilab equivalent for <emphasis role="bold">flag</emphasis>.
70 </para>
71         </listitem>
72       </varlistentry>
73     </variablelist>
74   </refsection>
75   <refsection>
76     <title>Examples</title>
77     <informaltable border="1" pgwide="1">
78       <tr>
79         <td align="center">
80           <emphasis role="bold">Matlab</emphasis>
81         </td>
82         <td align="center">
83           <emphasis role="bold">Scilab</emphasis>
84         </td>
85       </tr>
86       <tr>
87         <td>
88           <programlisting role="example"><![CDATA[
89 d = eig(A,'balance')
90 [V,D] = eig(A,'balance')
91 d = eig(A,B)
92 [V,D] = eig(A,B)
93 ]]></programlisting>
94         </td>
95         <td>
96           <programlisting role="example"><![CDATA[
97 d = spec(A)
98 [V,D] = bdiag(A+%i,1/%eps)
99 [al,be] = spec(A); d = al./be;
100 [al,be,V] = spec(A); D = spec(al./be);
101 ]]></programlisting>
102         </td>
103       </tr>
104     </informaltable>
105   </refsection>
106 </refentry>