← 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/format_representation/tf2des.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/format_representation/tf2des.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="tf2des">
 
14
    <refnamediv>
 
15
        <refname>tf2des</refname>
 
16
        <refpurpose> transfer function to descriptor</refpurpose>
 
17
    </refnamediv>
 
18
    <refsynopsisdiv>
 
19
        <title>Calling Sequence</title>
 
20
        <synopsis>S=tf2des(G)
 
21
            S=tf2des(G,flag)
 
22
        </synopsis>
 
23
    </refsynopsisdiv>
 
24
    <refsection>
 
25
        <title>Arguments</title>
 
26
        <variablelist>
 
27
            <varlistentry>
 
28
                <term>G</term>
 
29
                <listitem>
 
30
                    <para>
 
31
                        linear system (<literal>syslin</literal> list) with possibly polynomial <literal>D</literal> matrix
 
32
                    </para>
 
33
                </listitem>
 
34
            </varlistentry>
 
35
            <varlistentry>
 
36
                <term>flag</term>
 
37
                <listitem>
 
38
                    <para>
 
39
                        character string <literal>"withD"</literal>
 
40
                    </para>
 
41
                </listitem>
 
42
            </varlistentry>
 
43
            <varlistentry>
 
44
                <term>S</term>
 
45
                <listitem>
 
46
                    <para>list</para>
 
47
                </listitem>
 
48
            </varlistentry>
 
49
        </variablelist>
 
50
    </refsection>
 
51
    <refsection>
 
52
        <title>Description</title>
 
53
        <para>
 
54
            Transfer function to descriptor form: <literal>S=list('d',A,B,C,D,E)</literal>
 
55
        </para>
 
56
        <programlisting role=""><![CDATA[ 
 
57
E*xdot = A*x+B*u
 
58
y = C*x + D*u
 
59
 ]]></programlisting>
 
60
        <para>
 
61
            Note that <literal>D=0</literal> if the optional parameter flag=<literal>"withD"</literal> is not
 
62
            given. Otherwise a maximal rank <literal>D</literal> matrix is returned in the fifth
 
63
            entry of the list <literal>S</literal>
 
64
        </para>
 
65
    </refsection>
 
66
    <refsection>
 
67
        <title>Examples</title>
 
68
        <programlisting role="example"><![CDATA[ 
 
69
s=poly(0,'s');
 
70
G=[1/(s-1),s;1,2/s^3];
 
71
S1=tf2des(G);des2tf(S1)
 
72
S2=tf2des(G,"withD");des2tf(S2)
 
73
 ]]></programlisting>
 
74
    </refsection>
 
75
    <refsection role="see also">
 
76
        <title>See Also</title>
 
77
        <simplelist type="inline">
 
78
            <member>
 
79
                <link linkend="pol2des">pol2des</link>
 
80
            </member>
 
81
            <member>
 
82
                <link linkend="tf2ss">tf2ss</link>
 
83
            </member>
 
84
            <member>
 
85
                <link linkend="ss2des">ss2des</link>
 
86
            </member>
 
87
            <member>
 
88
                <link linkend="des2tf">des2tf</link>
 
89
            </member>
 
90
        </simplelist>
 
91
    </refsection>
 
92
</refentry>