2944ddac16e740c8f054f7af95020c2fcbfc1897
[scilab.git] / scilab / modules / linear_algebra / help / en_US / state_space / coff.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) 2008 - INRIA
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.1-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" xmlns:scilab="http://www.scilab.org" xml:lang="en" xml:id="coff">
14     <refnamediv>
15         <refname>coff</refname>
16         <refpurpose>resolvent (cofactor method)  </refpurpose>
17     </refnamediv>
18     <refsynopsisdiv>
19         <title>Calling Sequence</title>
20         <synopsis>[N,d]=coff(M [,var])</synopsis>
21     </refsynopsisdiv>
22     <refsection>
23         <title>Arguments</title>
24         <variablelist>
25             <varlistentry>
26                 <term>M</term>
27                 <listitem>
28                     <para>square real matrix</para>
29                 </listitem>
30             </varlistentry>
31             <varlistentry>
32                 <term>var</term>
33                 <listitem>
34                     <para>character string</para>
35                 </listitem>
36             </varlistentry>
37             <varlistentry>
38                 <term>N</term>
39                 <listitem>
40                     <para>
41                         polynomial matrix (same size as <literal>M</literal>)
42                     </para>
43                 </listitem>
44             </varlistentry>
45             <varlistentry>
46                 <term>d</term>
47                 <listitem>
48                     <para>
49                         polynomial (characteristic polynomial <literal>poly(A,'s')</literal>)
50                     </para>
51                 </listitem>
52             </varlistentry>
53         </variablelist>
54     </refsection>
55     <refsection>
56         <title>Description</title>
57         <para>
58             <literal>coff</literal> computes R=<literal>(s*eye()-M)^-1</literal> for <literal>M</literal> a real matrix. 
59             R is given by <literal>N/d</literal>.
60         </para>
61         <para>
62             <literal>N</literal> = numerator polynomial matrix.
63         </para>
64         <para>
65             <literal>d</literal> = common denominator.
66         </para>
67         <para>
68             <literal>var</literal> character string ('<literal>s</literal>' if omitted)
69         </para>
70     </refsection>
71     <refsection>
72         <title>Examples</title>
73         <programlisting role="example"><![CDATA[ 
74 M=[1,2;0,3];
75 [N,d]=coff(M)
76 N/d
77 inv(%s*eye()-M)
78  ]]></programlisting>
79     </refsection>
80     <refsection role="see also">
81         <title>See Also</title>
82         <simplelist type="inline">
83             <member>
84                 <link linkend="coffg">coffg</link>
85             </member>
86             <member>
87                 <link linkend="ss2tf">ss2tf</link>
88             </member>
89             <member>
90                 <link linkend="nlev">nlev</link>
91             </member>
92             <member>
93                 <link linkend="poly">poly</link>
94             </member>
95         </simplelist>
96     </refsection>
97 </refentry>