← Back to branch summary

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

« back to all changes in this revision

Viewing changes to modules/linear_algebra/help/en_US/inv.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/linear_algebra/help/en_US/inv.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) 2008 - 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="inv">
14
 
  <refnamediv>
15
 
    <refname>inv</refname>
16
 
    <refpurpose> matrix inverse</refpurpose>
17
 
  </refnamediv>
18
 
  <refsynopsisdiv>
19
 
    <title>Calling Sequence</title>
20
 
    <synopsis>inv(X)</synopsis>
21
 
  </refsynopsisdiv>
22
 
  <refsection>
23
 
    <title>Arguments</title>
24
 
    <variablelist>
25
 
      <varlistentry>
26
 
        <term>X</term>
27
 
        <listitem>
28
 
          <para>real or complex square matrix, polynomial matrix, rational matrix in transfer or state-space representation.</para>
29
 
        </listitem>
30
 
      </varlistentry>
31
 
    </variablelist>
32
 
  </refsection>
33
 
  <refsection>
34
 
    <title>Description</title>
35
 
    <para>
36
 
      <literal>inv(X)</literal> is the inverse of the square matrix <literal>X</literal>. A warning
37
 
      message is printed if <literal>X</literal> is badly scaled or nearly singular.
38
 
    </para>
39
 
    <para>
40
 
      For polynomial matrices or rational matrices in transfer representation,
41
 
      <literal>inv(X)</literal> is equivalent to <literal>invr(X)</literal>.
42
 
    </para>
43
 
    <para>
44
 
      For linear systems in state-space representation (<literal>syslin</literal> list),
45
 
      <literal>invr(X)</literal> is equivalent to <literal>invsyslin(X)</literal>.
46
 
    </para>
47
 
  </refsection>
48
 
  <refsection>
49
 
    <title>References</title>
50
 
    <para>
51
 
      <literal>inv</literal> function for matrices of numbers is  based on the Lapack routines
52
 
      DGETRF, DGETRI for  real matrices and  ZGETRF, ZGETRI for the complex case.
53
 
      For polynomial matrix and rational function matrix <literal>inv</literal> is based on the <literal>invr</literal>
54
 
      Scilab function.
55
 
    </para>
56
 
  </refsection>
57
 
  <refsection>
58
 
    <title>Examples</title>
59
 
    <programlisting role="example"><![CDATA[ 
60
 
A=rand(3,3);inv(A)*A
61
 
 
62
 
x=poly(0,'x');
63
 
A=[x,1,x;x^2,2,1+x;1,2,3];inv(A)*A
64
 
 
65
 
A=[1/x,2;2+x,2/(1+x)]
66
 
inv(A)*A
67
 
 
68
 
A=ssrand(2,2,3);
69
 
W=inv(A)*A
70
 
clean(ss2tf(W))
71
 
 ]]></programlisting>
72
 
  </refsection>
73
 
  <refsection role="see also">
74
 
    <title>See Also</title>
75
 
    <simplelist type="inline">
76
 
      <member>
77
 
        <link linkend="slash">slash</link>
78
 
      </member>
79
 
      <member>
80
 
        <link linkend="backslash">backslash</link>
81
 
      </member>
82
 
      <member>
83
 
        <link linkend="pinv">pinv</link>
84
 
      </member>
85
 
      <member>
86
 
        <link linkend="qr">qr</link>
87
 
      </member>
88
 
      <member>
89
 
        <link linkend="lufact">lufact</link>
90
 
      </member>
91
 
      <member>
92
 
        <link linkend="lusolve">lusolve</link>
93
 
      </member>
94
 
      <member>
95
 
        <link linkend="invr">invr</link>
96
 
      </member>
97
 
      <member>
98
 
        <link linkend="coff">coff</link>
99
 
      </member>
100
 
      <member>
101
 
        <link linkend="coffg">coffg</link>
102
 
      </member>
103
 
    </simplelist>
104
 
  </refsection>
105
 
</refentry>