← Back to branch summary

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

« back to all changes in this revision

Viewing changes to modules/polynomials/help/en_US/invr.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/polynomials/help/en_US/invr.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="invr">
14
 
  <refnamediv>
15
 
    <refname>invr</refname>
16
 
    <refpurpose> inversion of (rational) matrix</refpurpose>
17
 
  </refnamediv>
18
 
  <refsynopsisdiv>
19
 
    <title>Calling Sequence</title>
20
 
    <synopsis>F = invr(H)</synopsis>
21
 
  </refsynopsisdiv>
22
 
  <refsection>
23
 
    <title>Arguments</title>
24
 
    <variablelist>
25
 
      <varlistentry>
26
 
        <term>H</term>
27
 
        <listitem>
28
 
          <para>polynomial or rational matrix</para>
29
 
        </listitem>
30
 
      </varlistentry>
31
 
      <varlistentry>
32
 
        <term>F</term>
33
 
        <listitem>
34
 
          <para>polynomial or rational matrix</para>
35
 
        </listitem>
36
 
      </varlistentry>
37
 
    </variablelist>
38
 
  </refsection>
39
 
  <refsection>
40
 
    <title>Description</title>
41
 
    <para>
42
 
      If <literal>H</literal> is a polynomial or rational function matrix, <literal>invr</literal>
43
 
      computes <literal>H^(-1)</literal> using Leverrier's algorithm (see function code)
44
 
    </para>
45
 
  </refsection>
46
 
  <refsection>
47
 
    <title>Examples</title>
48
 
    <programlisting role="example"><![CDATA[ 
 
14
    <refnamediv>
 
15
        <refname>invr</refname>
 
16
        <refpurpose> inversion of (rational) matrix</refpurpose>
 
17
    </refnamediv>
 
18
    <refsynopsisdiv>
 
19
        <title>Calling Sequence</title>
 
20
        <synopsis>F = invr(H)</synopsis>
 
21
    </refsynopsisdiv>
 
22
    <refsection>
 
23
        <title>Arguments</title>
 
24
        <variablelist>
 
25
            <varlistentry>
 
26
                <term>H</term>
 
27
                <listitem>
 
28
                    <para>polynomial or rational matrix</para>
 
29
                </listitem>
 
30
            </varlistentry>
 
31
            <varlistentry>
 
32
                <term>F</term>
 
33
                <listitem>
 
34
                    <para>polynomial or rational matrix</para>
 
35
                </listitem>
 
36
            </varlistentry>
 
37
        </variablelist>
 
38
    </refsection>
 
39
    <refsection>
 
40
        <title>Description</title>
 
41
        <para>
 
42
            If <literal>H</literal> is a polynomial or rational function matrix, <literal>invr</literal>
 
43
            computes <literal>H^(-1)</literal> using Leverrier's algorithm (see function code)
 
44
        </para>
 
45
    </refsection>
 
46
    <refsection>
 
47
        <title>Examples</title>
 
48
        <programlisting role="example"><![CDATA[ 
49
49
s=poly(0,'s')
50
50
H=[s,s*s+2;1-s,1+s]; invr(H)
51
51
[Num,den]=coffg(H);Num/den
52
52
H=[1/s,(s+1);1/(s+2),(s+3)/s];invr(H)
53
53
 ]]></programlisting>
54
 
  </refsection>
55
 
  <refsection role="see also">
56
 
    <title>See Also</title>
57
 
    <simplelist type="inline">
58
 
      <member>
59
 
        <link linkend="glever">glever</link>
60
 
      </member>
61
 
      <member>
62
 
        <link linkend="coffg">coffg</link>
63
 
      </member>
64
 
      <member>
65
 
        <link linkend="inv">inv</link>
66
 
      </member>
67
 
    </simplelist>
68
 
  </refsection>
 
54
    </refsection>
 
55
    <refsection role="see also">
 
56
        <title>See Also</title>
 
57
        <simplelist type="inline">
 
58
            <member>
 
59
                <link linkend="glever">glever</link>
 
60
            </member>
 
61
            <member>
 
62
                <link linkend="coffg">coffg</link>
 
63
            </member>
 
64
            <member>
 
65
                <link linkend="inv">inv</link>
 
66
            </member>
 
67
        </simplelist>
 
68
    </refsection>
69
69
</refentry>