fix links
[scilab.git] / scilab / modules / umfpack / help / en_US / umf_lusolve.xml
1 <?xml version="1.0" encoding="ISO-8859-1"?>
2 <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="umf_lusolve">
3   <info>
4     <pubdate/>
5   </info>
6   <refnamediv>
7     <refname>umf_lusolve</refname>
8     <refpurpose> solve a linear sparse system given the LU factors  </refpurpose>
9   </refnamediv>
10   <refsynopsisdiv>
11     <title>Calling Sequence</title>
12     <synopsis>[x] = umf_lusolve(LU_ptr, b [, st, A])</synopsis>
13   </refsynopsisdiv>
14   <refsection>
15     <title>Parameters</title>
16     <variablelist>
17       <varlistentry>
18         <term>LU_ptr  </term>
19         <listitem>
20           <para>a pointer to umf lu factors (L,U,p,q,R) </para>
21         </listitem>
22       </varlistentry>
23       <varlistentry>
24         <term>b  </term>
25         <listitem>
26           <para>a real or complex column vector or a matrix (multiple rhs)</para>
27         </listitem>
28       </varlistentry>
29       <varlistentry>
30         <term>st  </term>
31         <listitem>
32           <para>(optional) a string "Ax=b" (default) or "Ax'=b" 
33       (to be written "Ax''=b"  in scilab langage: a quote in a string
34           must be doubled !)</para>
35         </listitem>
36       </varlistentry>
37       <varlistentry>
38         <term>A  </term>
39         <listitem>
40           <para>(optional) the sparse square matrix corresponding to the LU factors (LU_ptr must be got with LU_ptr = umf_lufact(A))</para>
41         </listitem>
42       </varlistentry>
43       <varlistentry>
44         <term>x  </term>
45         <listitem>
46           <para>a column vector or a matrix in case of multiple rhs ( x(:,i) is solution of A x(:,i) = b(:,i) or A'x(:,i) = b(:,i) )</para>
47         </listitem>
48       </varlistentry>
49     </variablelist>
50   </refsection>
51   <refsection>
52     <title>Description</title>
53     <para>
54     This function must be used in conjonction with <link linkend='umf_lufact'>umf_lufact</link> which
55     computes the LU factors of a sparse matrix. The optional
56     <literal>st</literal> argument lets us choose between the solving of Ax=b (general case)
57     or of A'x=b (sometimes useful). If you give the 4th argument then
58     iterative refinement will be also proceceed (as in umfpack) to
59     give a better numerical solution. 
60   </para>
61   </refsection>
62   <refsection>
63     <title>Examples</title>
64     <para>
65     see the example section of <link linkend='umf_lufact'>umf_lufact</link>
66   </para>
67   </refsection>
68   <refsection>
69     <title>See Also</title>
70     <simplelist type="inline">
71       <member>
72         <link linkend="umfpack">umfpack</link>
73       </member>
74       <member>
75         <link linkend="umf_lufact">umf_lufact</link>
76       </member>
77       <member>
78         <link linkend="umf_luget">umf_luget</link>
79       </member>
80       <member>
81         <link linkend="umf_ludel">umf_ludel</link>
82       </member>
83       <member>
84         <link linkend="umf_luinfo">umf_luinfo</link>
85       </member>
86     </simplelist>
87   </refsection>
88   <refsection>
89     <title>Authors</title>
90     <simplelist type="vert">
91       <member>umfpack by Timothy A. Davis (see umf_license)</member>
92       <member>scilab interface by Bruno Pincon with contributions from Antonio Frasson</member>
93     </simplelist>
94   </refsection>
95 </refentry>