← Back to branch summary

~ubuntu-branches/ubuntu/raring/scilab/raring-proposed

« back to all changes in this revision

Viewing changes to modules/cacsd/help/en_US/ss2tf.xml

  • Committer: Package Import Robot
  • Author(s): Sylvestre Ledru
  • Date: 2012-08-30 14:42:38 UTC
  • mfrom: (1.4.7)
  • Revision ID: package-import@ubuntu.com-20120830144238-c1y2og7dbm7m9nig
Tags: 5.4.0-beta-3-1~exp1
* New upstream release
* Update the scirenderer dep
* Get ride of libjhdf5-java dependency

Show diffs side-by-side

added added

removed removed

Lines of Context:
modules/cacsd/help/en_US/ss2tf.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) 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-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="ss2tf">
14
 
  <refnamediv>
15
 
    <refname>ss2tf</refname>
16
 
    <refpurpose> conversion from state-space to transfer function</refpurpose>
17
 
  </refnamediv>
18
 
  <refsynopsisdiv>
19
 
    <title>Calling Sequence</title>
20
 
    <synopsis>[h]=ss2tf(sl)
21
 
      [Ds,NUM,chi]=ss2tf(sl)
22
 
      
23
 
      [h]=ss2tf(sl,"b")
24
 
      [Ds,NUM,chi]=ss2tf(sl,"b")
25
 
      
26
 
      
27
 
      [h]=ss2tf(sl,rmax)
28
 
      [Ds,NUM,chi]=ss2tf(sl,rmax)
29
 
      
30
 
    </synopsis>
31
 
  </refsynopsisdiv>
32
 
  <refsection>
33
 
    <title>Arguments</title>
34
 
    <variablelist>
35
 
      <varlistentry>
36
 
        <term>sl</term>
37
 
        <listitem>
38
 
          <para>
39
 
            linear system (<literal>syslin</literal> list)
40
 
          </para>
41
 
        </listitem>
42
 
      </varlistentry>
43
 
      <varlistentry>
44
 
        <term>h</term>
45
 
        <listitem>
46
 
          <para>transfer matrix</para>
47
 
        </listitem>
48
 
      </varlistentry>
49
 
    </variablelist>
50
 
  </refsection>
51
 
  <refsection>
52
 
    <title>Description</title>
53
 
    <para>
54
 
      Called with three outputs <literal>[Ds,NUM,chi]=ss2tf(sl)</literal> returns 
55
 
      the numerator polynomial matrix <literal>NUM</literal>, the characteristic
56
 
      polynomial <literal>chi</literal> and the polynomial part <literal>Ds</literal> separately i.e.:
57
 
    </para>
58
 
    <programlisting role=""><![CDATA[ 
59
 
h = NUM/chi + Ds
60
 
 ]]></programlisting>
61
 
    <para>
62
 
      Method:
63
 
    </para>
64
 
    <para>
65
 
      One uses the characteristic polynomial and 
66
 
      <literal>det(A+Eij)=det(A)+C(i,j)</literal> where <literal>C</literal> is the adjugate 
67
 
      matrix of <literal>A</literal>.
68
 
    </para>
69
 
    <para>
70
 
      With <literal>rmax</literal> or <literal>"b"</literal> argument uses a block diagonalization of
71
 
      sl.A matrix and applies "Leverrier" algorithm on blocks.
72
 
      If given, <literal>rmax</literal> controls the conditionning (see bdiag).
73
 
    </para>
74
 
  </refsection>
75
 
  <refsection>
76
 
    <title>Examples</title>
77
 
    <programlisting role="example"><![CDATA[ 
78
 
s=poly(0,'s');
79
 
h=[1,1/s;1/(s^2+1),s/(s^2-2)]
80
 
sl=tf2ss(h);
81
 
h=clean(ss2tf(sl))
82
 
[Ds,NUM,chi]=ss2tf(sl)
83
 
 ]]></programlisting>
84
 
  </refsection>
85
 
  <refsection role="see also">
86
 
    <title>See Also</title>
87
 
    <simplelist type="inline">
88
 
      <member>
89
 
        <link linkend="tf2ss">tf2ss</link>
90
 
      </member>
91
 
      <member>
92
 
        <link linkend="syslin">syslin</link>
93
 
      </member>
94
 
      <member>
95
 
        <link linkend="nlev">nlev</link>
96
 
      </member>
97
 
      <member>
98
 
        <link linkend="glever">glever</link>
99
 
      </member>
100
 
    </simplelist>
101
 
  </refsection>
102
 
</refentry>