← 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/des2ss.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/des2ss.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="des2ss">
14
 
  <refnamediv>
15
 
    <refname>des2ss</refname>
16
 
    <refpurpose> descriptor to state-space</refpurpose>
17
 
  </refnamediv>
18
 
  <refsynopsisdiv>
19
 
    <title>Calling Sequence</title>
20
 
    <synopsis>[Sl]=des2ss(A,B,C,D,E [,tol])
21
 
      [Sl]=des2ss(Des)
22
 
    </synopsis>
23
 
  </refsynopsisdiv>
24
 
  <refsection>
25
 
    <title>Arguments</title>
26
 
    <variablelist>
27
 
      <varlistentry>
28
 
        <term>A,B,C,D,E</term>
29
 
        <listitem>
30
 
          <para>real matrices of appropriate dimensions</para>
31
 
        </listitem>
32
 
      </varlistentry>
33
 
      <varlistentry>
34
 
        <term>Des</term>
35
 
        <listitem>
36
 
          <para>list</para>
37
 
        </listitem>
38
 
      </varlistentry>
39
 
      <varlistentry>
40
 
        <term>Sl</term>
41
 
        <listitem>
42
 
          <para>
43
 
            <literal>syslin</literal> list
44
 
          </para>
45
 
        </listitem>
46
 
      </varlistentry>
47
 
      <varlistentry>
48
 
        <term>tol</term>
49
 
        <listitem>
50
 
          <para>
51
 
            real parameter (threshold) (default value <literal>100*%eps</literal>).
52
 
          </para>
53
 
        </listitem>
54
 
      </varlistentry>
55
 
    </variablelist>
56
 
  </refsection>
57
 
  <refsection>
58
 
    <title>Description</title>
59
 
    <para>
60
 
      Descriptor to state-space transform.
61
 
    </para>
62
 
    <para>
63
 
      <literal>Sl=des2ss(A,B,C,D,E)</literal> returns 
64
 
      a linear system <literal>Sl</literal> equivalent to the descriptor system 
65
 
      <literal>(E,A,B,C,D)</literal>.
66
 
    </para>
67
 
    <para>
68
 
      For index one <literal>(E,A)</literal> pencil, explicit formula is used and
69
 
      for higher index pencils <literal>rowshuff</literal> is used.
70
 
    </para>
71
 
    <para>
72
 
      <literal>Sl=des2ss(Des)</literal> with <literal>Des=list('des',A,B,C,D,E)</literal> returns
73
 
      a linear system <literal>Sl</literal> in state-space form with possibly 
74
 
      a polynomial <literal>D</literal> matrix.
75
 
    </para>
76
 
    <para>
77
 
      A generalized Leverrier algorithm is used.
78
 
    </para>
79
 
  </refsection>
80
 
  <refsection>
81
 
    <title>Examples</title>
82
 
    <programlisting role="example"><![CDATA[ 
83
 
s=poly(0,'s');G=[1/(s-1),s;1,2/s^3];
84
 
S1=tf2des(G);S2=tf2des(G,"withD");
85
 
W1=des2ss(S1);W2=des2ss(S2);
86
 
clean(ss2tf(W1))
87
 
clean(ss2tf(W2))
88
 
 ]]></programlisting>
89
 
  </refsection>
90
 
  <refsection role="see also">
91
 
    <title>See Also</title>
92
 
    <simplelist type="inline">
93
 
      <member>
94
 
        <link linkend="des2tf">des2tf</link>
95
 
      </member>
96
 
      <member>
97
 
        <link linkend="glever">glever</link>
98
 
      </member>
99
 
      <member>
100
 
        <link linkend="rowshuff">rowshuff</link>
101
 
      </member>
102
 
    </simplelist>
103
 
  </refsection>
104
 
</refentry>