← 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/armac.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/armac.xml
11
11
 *
12
12
 -->
13
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="armac">
14
 
  <refnamediv>
15
 
    <refname>armac</refname>
16
 
    <refpurpose> Scilab description of an armax process</refpurpose>
17
 
  </refnamediv>
18
 
  <refsynopsisdiv>
19
 
    <title>Calling Sequence</title>
20
 
    <synopsis>[ar]=armac(a,b,d,ny,nu,sig)</synopsis>
21
 
  </refsynopsisdiv>
22
 
  <refsection>
23
 
    <title>Arguments</title>
24
 
    <variablelist>
25
 
      <varlistentry>
26
 
        <term>a=[Id,a1,..,a_r]  </term>
27
 
        <listitem>
28
 
          <para>is a matrix of size (ny,r*ny)</para>
29
 
        </listitem>
30
 
      </varlistentry>
31
 
      <varlistentry>
32
 
        <term>b=[b0,.....,b_s]  </term>
33
 
        <listitem>
34
 
          <para>is a matrix of size (ny,(s+1)*nu)</para>
35
 
        </listitem>
36
 
      </varlistentry>
37
 
      <varlistentry>
38
 
        <term>d=[Id,d1,..,d_p]  </term>
39
 
        <listitem>
40
 
          <para>is a matrix of size (ny,p*ny);</para>
41
 
        </listitem>
42
 
      </varlistentry>
43
 
      <varlistentry>
44
 
        <term>ny</term>
45
 
        <listitem>
46
 
          <para>dimension of the output  y</para>
47
 
        </listitem>
48
 
      </varlistentry>
49
 
      <varlistentry>
50
 
        <term>nu</term>
51
 
        <listitem>
52
 
          <para>dimension of the output  u</para>
53
 
        </listitem>
54
 
      </varlistentry>
55
 
      <varlistentry>
56
 
        <term>sig</term>
57
 
        <listitem>
58
 
          <para>a matrix of size (ny,ny)</para>
59
 
        </listitem>
60
 
      </varlistentry>
61
 
    </variablelist>
62
 
  </refsection>
63
 
  <refsection>
64
 
    <title>Description</title>
65
 
    <para>
66
 
      This function creates a description as a tlist of an  ARMAX process
67
 
    </para>
68
 
    <para>
69
 
      <literal>ar</literal> is defined by
70
 
    </para>
71
 
    <programlisting role=""><![CDATA[ 
 
14
    <refnamediv>
 
15
        <refname>armac</refname>
 
16
        <refpurpose> Scilab description of an armax process</refpurpose>
 
17
    </refnamediv>
 
18
    <refsynopsisdiv>
 
19
        <title>Calling Sequence</title>
 
20
        <synopsis>[ar]=armac(a,b,d,ny,nu,sig)</synopsis>
 
21
    </refsynopsisdiv>
 
22
    <refsection>
 
23
        <title>Arguments</title>
 
24
        <variablelist>
 
25
            <varlistentry>
 
26
                <term>a=[Id,a1,..,a_r]  </term>
 
27
                <listitem>
 
28
                    <para>is a matrix of size (ny,r*ny)</para>
 
29
                </listitem>
 
30
            </varlistentry>
 
31
            <varlistentry>
 
32
                <term>b=[b0,.....,b_s]  </term>
 
33
                <listitem>
 
34
                    <para>is a matrix of size (ny,(s+1)*nu)</para>
 
35
                </listitem>
 
36
            </varlistentry>
 
37
            <varlistentry>
 
38
                <term>d=[Id,d1,..,d_p]  </term>
 
39
                <listitem>
 
40
                    <para>is a matrix of size (ny,p*ny);</para>
 
41
                </listitem>
 
42
            </varlistentry>
 
43
            <varlistentry>
 
44
                <term>ny</term>
 
45
                <listitem>
 
46
                    <para>dimension of the output  y</para>
 
47
                </listitem>
 
48
            </varlistentry>
 
49
            <varlistentry>
 
50
                <term>nu</term>
 
51
                <listitem>
 
52
                    <para>dimension of the output  u</para>
 
53
                </listitem>
 
54
            </varlistentry>
 
55
            <varlistentry>
 
56
                <term>sig</term>
 
57
                <listitem>
 
58
                    <para>a matrix of size (ny,ny)</para>
 
59
                </listitem>
 
60
            </varlistentry>
 
61
        </variablelist>
 
62
    </refsection>
 
63
    <refsection>
 
64
        <title>Description</title>
 
65
        <para>
 
66
            This function creates a description as a tlist of an  ARMAX process
 
67
        </para>
 
68
        <para>
 
69
            <literal>ar</literal> is defined by
 
70
        </para>
 
71
        <programlisting role=""><![CDATA[ 
72
72
ar=tlist(['ar','a','b','d','ny','nu','sig'],a,b,d,ny,nu,sig);
73
73
 ]]></programlisting>
74
 
    <para>
75
 
      and thus the coefficients of <literal>ar</literal> can be retrieved by e.g.
76
 
      <literal> ar('a') </literal>.
77
 
    </para>
78
 
  </refsection>
79
 
  <refsection>
80
 
    <title>Examples</title>
81
 
    <programlisting role="example"><![CDATA[ 
 
74
        <para>
 
75
            and thus the coefficients of <literal>ar</literal> can be retrieved by e.g.
 
76
            <literal> ar('a') </literal>.
 
77
        </para>
 
78
    </refsection>
 
79
    <refsection>
 
80
        <title>Examples</title>
 
81
        <programlisting role="example"><![CDATA[ 
82
82
a=[1,-2.851,2.717,-0.865].*.eye(2,2)
83
83
b=[0,1,1,1].*.[1;1];
84
84
d=[1,0.7,0.2].*.eye(2,2);
87
87
// extract polynomial matrices from ar representation 
88
88
[A,B,D]=arma2p(ar);
89
89
 ]]></programlisting>
90
 
  </refsection>
91
 
  <refsection role="see also">
92
 
    <title>See Also</title>
93
 
    <simplelist type="inline">
94
 
      <member>
95
 
        <link linkend="arma">arma</link>
96
 
      </member>
97
 
      <member>
98
 
        <link linkend="armax">armax</link>
99
 
      </member>
100
 
      <member>
101
 
        <link linkend="armax1">armax1</link>
102
 
      </member>
103
 
      <member>
104
 
        <link linkend="arsimul">arsimul</link>
105
 
      </member>
106
 
      <member>
107
 
        <link linkend="arma2p">arma2p</link>
108
 
      </member>
109
 
      <member>
110
 
        <link linkend="tlist">tlist</link>
111
 
      </member>
112
 
    </simplelist>
113
 
  </refsection>
 
90
    </refsection>
 
91
    <refsection role="see also">
 
92
        <title>See Also</title>
 
93
        <simplelist type="inline">
 
94
            <member>
 
95
                <link linkend="arma">arma</link>
 
96
            </member>
 
97
            <member>
 
98
                <link linkend="armax">armax</link>
 
99
            </member>
 
100
            <member>
 
101
                <link linkend="armax1">armax1</link>
 
102
            </member>
 
103
            <member>
 
104
                <link linkend="arsimul">arsimul</link>
 
105
            </member>
 
106
            <member>
 
107
                <link linkend="arma2p">arma2p</link>
 
108
            </member>
 
109
            <member>
 
110
                <link linkend="tlist">tlist</link>
 
111
            </member>
 
112
        </simplelist>
 
113
    </refsection>
114
114
</refentry>