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

« back to all changes in this revision

Viewing changes to modules/sparse/help/en_US/decomposition/lusolve.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:
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="lusolve">
14
 
  <refnamediv>
15
 
    <refname>lusolve</refname>
16
 
    <refpurpose> sparse linear system solver</refpurpose>
17
 
  </refnamediv>
18
 
  <refsynopsisdiv>
19
 
    <title>Calling Sequence</title>
20
 
    <synopsis>lusolve(hand,b)
21
 
      lusolve(A,b)
22
 
    </synopsis>
23
 
  </refsynopsisdiv>
24
 
  <refsection>
25
 
    <title>Arguments</title>
26
 
    <variablelist>
27
 
      <varlistentry>
28
 
        <term>b</term>
29
 
        <listitem>
30
 
          <para>full real matrix</para>
31
 
        </listitem>
32
 
      </varlistentry>
33
 
      <varlistentry>
34
 
        <term>A</term>
35
 
        <listitem>
36
 
          <para>real square sparse invertible matrix</para>
37
 
        </listitem>
38
 
      </varlistentry>
39
 
      <varlistentry>
40
 
        <term>hand</term>
41
 
        <listitem>
42
 
          <para>handle to a previously computed sparse lu factors (output of lufact)</para>
43
 
        </listitem>
44
 
      </varlistentry>
45
 
    </variablelist>
46
 
  </refsection>
47
 
  <refsection>
48
 
    <title>Description</title>
49
 
    <para>
50
 
      <literal>x=lusolve(hand,b)</literal> solves the sparse linear system
51
 
      <literal>A*x = b</literal>.
52
 
    </para>
53
 
    <para>
54
 
      <literal>[hand,rk]=lufact(A)</literal> is the output of lufact.
55
 
    </para>
56
 
    <para>
57
 
      <literal>x=lusolve(A,b)</literal> solves the sparse linear system  
58
 
      <literal>A*x = b</literal>
59
 
    </para>
60
 
  </refsection>
61
 
  <refsection>
62
 
    <title>Examples</title>
63
 
    <programlisting role="example"><![CDATA[ 
 
14
    <refnamediv>
 
15
        <refname>lusolve</refname>
 
16
        <refpurpose> sparse linear system solver</refpurpose>
 
17
    </refnamediv>
 
18
    <refsynopsisdiv>
 
19
        <title>Calling Sequence</title>
 
20
        <synopsis>lusolve(hand,b)
 
21
            lusolve(A,b)
 
22
        </synopsis>
 
23
    </refsynopsisdiv>
 
24
    <refsection>
 
25
        <title>Arguments</title>
 
26
        <variablelist>
 
27
            <varlistentry>
 
28
                <term>b</term>
 
29
                <listitem>
 
30
                    <para>full real matrix</para>
 
31
                </listitem>
 
32
            </varlistentry>
 
33
            <varlistentry>
 
34
                <term>A</term>
 
35
                <listitem>
 
36
                    <para>real square sparse invertible matrix</para>
 
37
                </listitem>
 
38
            </varlistentry>
 
39
            <varlistentry>
 
40
                <term>hand</term>
 
41
                <listitem>
 
42
                    <para>handle to a previously computed sparse lu factors (output of lufact)</para>
 
43
                </listitem>
 
44
            </varlistentry>
 
45
        </variablelist>
 
46
    </refsection>
 
47
    <refsection>
 
48
        <title>Description</title>
 
49
        <para>
 
50
            <literal>x=lusolve(hand,b)</literal> solves the sparse linear system
 
51
            <literal>A*x = b</literal>.
 
52
        </para>
 
53
        <para>
 
54
            <literal>[hand,rk]=lufact(A)</literal> is the output of lufact.
 
55
        </para>
 
56
        <para>
 
57
            <literal>x=lusolve(A,b)</literal> solves the sparse linear system  
 
58
            <literal>A*x = b</literal>
 
59
        </para>
 
60
    </refsection>
 
61
    <refsection>
 
62
        <title>Examples</title>
 
63
        <programlisting role="example"><![CDATA[ 
64
64
non_zeros=[1,2,3,4];rows_cols=[1,1;2,2;3,3;4,4];
65
65
sp=sparse(rows_cols,non_zeros);
66
66
[h,rk]=lufact(sp);x=lusolve(h,[1;1;1;1]);ludel(h)
71
71
x=lusolve(sp,-ones(4,1));
72
72
sp*x
73
73
 ]]></programlisting>
74
 
  </refsection>
75
 
  <refsection role="see also">
76
 
    <title>See Also</title>
77
 
    <simplelist type="inline">
78
 
      <member>
79
 
        <link linkend="sparse">sparse</link>
80
 
      </member>
81
 
      <member>
82
 
        <link linkend="lufact">lufact</link>
83
 
      </member>
84
 
      <member>
85
 
        <link linkend="slash">slash</link>
86
 
      </member>
87
 
      <member>
88
 
        <link linkend="backslash">backslash</link>
89
 
      </member>
90
 
    </simplelist>
91
 
  </refsection>
 
74
    </refsection>
 
75
    <refsection role="see also">
 
76
        <title>See Also</title>
 
77
        <simplelist type="inline">
 
78
            <member>
 
79
                <link linkend="sparse">sparse</link>
 
80
            </member>
 
81
            <member>
 
82
                <link linkend="lufact">lufact</link>
 
83
            </member>
 
84
            <member>
 
85
                <link linkend="slash">slash</link>
 
86
            </member>
 
87
            <member>
 
88
                <link linkend="backslash">backslash</link>
 
89
            </member>
 
90
        </simplelist>
 
91
    </refsection>
92
92
</refentry>