Convert xml to support the new nrg schema
Pierre Marechal [Tue, 18 Mar 2008 09:46:00 +0000 (09:46 +0000)]
14 files changed:
scilab/modules/umfpack/help/en_US/cond2sp.xml
scilab/modules/umfpack/help/en_US/condestsp.xml
scilab/modules/umfpack/help/en_US/rafiter.xml
scilab/modules/umfpack/help/en_US/res_with_prec.xml
scilab/modules/umfpack/help/en_US/taucs_chdel.xml
scilab/modules/umfpack/help/en_US/taucs_chget.xml
scilab/modules/umfpack/help/en_US/taucs_chsolve.xml
scilab/modules/umfpack/help/en_US/taucs_license.xml
scilab/modules/umfpack/help/en_US/umf_license.xml
scilab/modules/umfpack/help/en_US/umf_ludel.xml
scilab/modules/umfpack/help/en_US/umf_luget.xml
scilab/modules/umfpack/help/en_US/umf_luinfo.xml
scilab/modules/umfpack/help/en_US/umf_lusolve.xml
scilab/modules/umfpack/help/en_US/umfpack.xml

index 38f46b7..b1063bd 100644 (file)
-<?xml version="1.0" encoding="ISO-8859-1" standalone="no"?> 
-<!DOCTYPE MAN SYSTEM "manrev.dtd">
-<MAN>
-  <LANGUAGE>eng</LANGUAGE>
-  <TITLE>cond2sp  </TITLE>
-  <TYPE>scilab function - scispt toolbox</TYPE>
-  <DATE>  </DATE>
-  <SHORT_DESCRIPTION name="cond2sp"> computes an approximation of the 2-norm condition number of a s.p.d. sparse matrix  </SHORT_DESCRIPTION>
+<?xml version="1.0" encoding="ISO-8859-1"?><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="cond2sp"><info><pubdate>  </pubdate></info><refnamediv><refname>cond2sp</refname><refpurpose> computes an approximation of the 2-norm condition number of a s.p.d. sparse matrix  </refpurpose></refnamediv>
+  
+  
+  
+  
+  
 
-  <CALLING_SEQUENCE>
-  <CALLING_SEQUENCE_ITEM>[K2, lm, vm, lM, vM] = cond2sp(A, C_ptr [, rtol, itermax, verb])  </CALLING_SEQUENCE_ITEM>
-  </CALLING_SEQUENCE>
+  <refsynopsisdiv><title>Calling Sequence</title><synopsis>[K2, lm, vm, lM, vM] = cond2sp(A, C_ptr [, rtol, itermax, verb])</synopsis></refsynopsisdiv>
 
-  <PARAM>
- <PARAM_INDENT>
-  <PARAM_ITEM>
-  <PARAM_NAME>A  </PARAM_NAME>
-  <PARAM_DESCRIPTION>
-    : a real symetric positive definite sparse matrix
-  </PARAM_DESCRIPTION> 
-  </PARAM_ITEM>
-  <PARAM_ITEM>
-  <PARAM_NAME>C_ptr  </PARAM_NAME>
-  <PARAM_DESCRIPTION>
-    : a pointer to a Cholesky factorization (got with taucs_chfact)
-  </PARAM_DESCRIPTION> 
-  </PARAM_ITEM>
-  <PARAM_ITEM>
-  <PARAM_NAME>rtol  </PARAM_NAME>
-  <PARAM_DESCRIPTION>
-    : (optional) relative tolerance (default 1.e-3) (see details in DESCRIPTION)
-  </PARAM_DESCRIPTION> 
-  </PARAM_ITEM>
-  <PARAM_ITEM>
-  <PARAM_NAME>itermax  </PARAM_NAME>
-  <PARAM_DESCRIPTION>
-    : (optional) maximum number of iterations in the underlying algorithms (default 30)
-  </PARAM_DESCRIPTION> 
-  </PARAM_ITEM>
-  <PARAM_ITEM>
-  <PARAM_NAME>verb  </PARAM_NAME>
-  <PARAM_DESCRIPTION>
-    : (optional) boolean, must be %t for displaying the intermediary results, and %f (default) if you don&apos;t want.
-  </PARAM_DESCRIPTION> 
-  </PARAM_ITEM>
-  <PARAM_ITEM>
-  <PARAM_NAME>K2  </PARAM_NAME>
-  <PARAM_DESCRIPTION>
-    : estimated 2-norm condition number <TT>K2 = ||A||_2 ||A^(-1)||_2 = lM/lm</TT>
-  </PARAM_DESCRIPTION> 
-  </PARAM_ITEM>
-  <PARAM_ITEM>
-  <PARAM_NAME>lm  </PARAM_NAME>
-  <PARAM_DESCRIPTION>
-    : (real positive scalar) minimum eigenvalue
-  </PARAM_DESCRIPTION> 
-  </PARAM_ITEM>
-  <PARAM_ITEM>
-  <PARAM_NAME>vm  </PARAM_NAME>
-  <PARAM_DESCRIPTION>
-    : associated eigenvector
-  </PARAM_DESCRIPTION> 
-  </PARAM_ITEM>
-  <PARAM_ITEM>
-  <PARAM_NAME>lM  </PARAM_NAME>
-  <PARAM_DESCRIPTION>
-    : (real positive scalar) maximum eigenvalue
-  </PARAM_DESCRIPTION> 
-  </PARAM_ITEM>
-  <PARAM_ITEM>
-  <PARAM_NAME>vM  </PARAM_NAME>
-  <PARAM_DESCRIPTION>
-    : associated eigenvector
-  </PARAM_DESCRIPTION> 
-  </PARAM_ITEM>
- </PARAM_INDENT>
-  </PARAM>
+  <refsection><title>Parameters</title>
+ <variablelist>
+  <varlistentry>
+  <term>A  </term>
+  <listitem>
+         <para>a real symetric positive definite sparse matrix</para>
+  </listitem> 
+  </varlistentry>
+  <varlistentry>
+  <term>C_ptr  </term>
+  <listitem>
+         <para>a pointer to a Cholesky factorization (got with taucs_chfact)</para>
+  </listitem> 
+  </varlistentry>
+  <varlistentry>
+  <term>rtol  </term>
+  <listitem>
+         <para>(optional) relative tolerance (default 1.e-3) (see details in DESCRIPTION)</para>
+  </listitem> 
+  </varlistentry>
+  <varlistentry>
+  <term>itermax  </term>
+  <listitem>
+         <para>(optional) maximum number of iterations in the underlying algorithms (default 30)</para>
+  </listitem> 
+  </varlistentry>
+  <varlistentry>
+  <term>verb  </term>
+  <listitem>
+         <para>(optional) boolean, must be %t for displaying the intermediary results, and %f (default) if you don't want.</para>
+  </listitem> 
+  </varlistentry>
+  <varlistentry>
+  <term>K2  </term>
+  <listitem>
+         <para>estimated 2-norm condition number <literal>K2 = ||A||_2 ||A^(-1)||_2 = lM/lm</literal></para>
+  </listitem> 
+  </varlistentry>
+  <varlistentry>
+  <term>lm  </term>
+  <listitem>
+         <para>(real positive scalar) minimum eigenvalue</para>
+  </listitem> 
+  </varlistentry>
+  <varlistentry>
+  <term>vm  </term>
+  <listitem>
+         <para>associated eigenvector</para>
+  </listitem> 
+  </varlistentry>
+  <varlistentry>
+  <term>lM  </term>
+  <listitem>
+         <para>(real positive scalar) maximum eigenvalue</para>
+  </listitem> 
+  </varlistentry>
+  <varlistentry>
+  <term>vM  </term>
+  <listitem>
+         <para>associated eigenvector</para>
+  </listitem> 
+  </varlistentry>
+ </variablelist>
+  </refsection>
 
-  <DESCRIPTION>
-  <P>
-    This quick and dirty function computes <TT>(lM,vM)</TT> using the iterative 
-    power method and <TT>(lm,vm)</TT> with the inverse iterative power method, then 
-    <TT>K2 = lM/lm</TT>. For each method the iterations are stopped until the following
+  <refsection><title>Description</title>
+  <para>
+    This quick and dirty function computes <literal>(lM,vM)</literal> using the iterative 
+    power method and <literal>(lm,vm)</literal> with the inverse iterative power method, then 
+    <literal>K2 = lM/lm</literal>. For each method the iterations are stopped until the following
     condition is met :
-  </P>
-  <VERBATIM><![CDATA[
+  </para>
+  <programlisting><![CDATA[
      | (l_new - l_old)/l_new | < rtol
-   ]]></VERBATIM>
-  <P>
+   ]]></programlisting>
+  <para>
     but 4 iterations are nevertheless required and also the iterations are stopped
     if itermax is reached (and a warning message is issued). As the matrix is symetric
     this is the rayleigh quotient which gives the estimated eigenvalue at each step
-    (<TT>lambda = v&apos;*A*v</TT>). You may called this function with named parameter, for 
+    (<literal>lambda = v'*A*v</literal>). You may called this function with named parameter, for 
     instance if you want to see the intermediary result without setting yourself the 
     rtol and itermax parameters you may called this function with the syntax :
-  </P>
-  <VERBATIM><![CDATA[
+  </para>
+  <programlisting><![CDATA[
     [K2, lm, vm, lM, vM] = cond2sp(A , C_ptr, verb=%t )
-   ]]></VERBATIM>
-  </DESCRIPTION>
-  <SECTION label='Caution'>
-  <P>
+   ]]></programlisting>
+  </refsection>
+  <refsection><title>Caution</title>
+  <para>
     Currently there is no verification for the input parameters !
-  </P>
-  </SECTION>
-  <SECTION label='Remark'>
-  <P>
+  </para>
+  </refsection>
+  <refsection><title>Remark</title>
+  <para>
     This function is intended to get an approximation of the 2-norm condition number (K2) and 
     with the methods used, the precision on the obtained eigenvectors (vM and vm) are generally 
-    not very good. If you look for a smaller residual <TT>||Av - l*v||</TT>, you may apply some inverse 
+    not very good. If you look for a smaller residual <literal>||Av - l*v||</literal>, you may apply some inverse 
     power iterations  from v0 with the matrix :
-  </P>
-  <VERBATIM><![CDATA[
+  </para>
+  <programlisting><![CDATA[
    B = A - l0*speye(A)
-   ]]></VERBATIM>
-  <P>
-    For instance, applied 5 such iterations for <TT>(lm,vm)</TT> is done with :
-  </P>
-  <VERBATIM><![CDATA[
+   ]]></programlisting>
+  <para>
+    For instance, applied 5 such iterations for <literal>(lm,vm)</literal> is done with :
+  </para>
+  <programlisting><![CDATA[
 l0 = lm ; v0 = vm;  // or l0 = lM ; v0 = vM;  // to polish (lM,vM)
 B = A - l0*speye(A);
 LUp = umf_lufact(B);
@@ -131,20 +127,20 @@ mprintf(" first estimated eigenvalue : l0 = %e \n\t", l0)
 mprintf(" |l-l0| <= ||Av0-l0v0|| = %e , |l-l0|/l0 <= %e \n\r", norm_r0, norm_r0/l0)
 mprintf(" raffined estimated eigenvalue : lr = %e \n\t", lr) 
 mprintf(" |l-lr| <= ||Avr-lrvr|| = %e , |l-lr|/lr <= %e \n\r", norm_rr, norm_rr/lr)
-   ]]></VERBATIM>
-  </SECTION>
+   ]]></programlisting>
+  </refsection>
 
-  <EXAMPLE><![CDATA[
+  <refsection><title>Examples</title><programlisting role="example"><![CDATA[
 [A] = ReadHBSparse(DIR_SCISPT_DEM+"bcsstk24.rsa");
 C_ptr = taucs_chfact(A);
 [K2, lm, vm, lM, vM] = cond2sp(A , C_ptr, 1.e-5, 50, %t );
 taucs_chdel(C_ptr)
- ]]></EXAMPLE>
+ ]]></programlisting></refsection>
 
-  <SEE_ALSO>
-    <SEE_ALSO_ITEM> <LINK>condestsp</LINK> </SEE_ALSO_ITEM>     
-    <SEE_ALSO_ITEM> <LINK>taucs_chfact</LINK> </SEE_ALSO_ITEM>     
-    <SEE_ALSO_ITEM> <LINK>rcond</LINK> </SEE_ALSO_ITEM>
-  </SEE_ALSO>
-  <AUTHOR>Bruno Pincon  &lt;Bruno.Pincon@iecn.u-nancy.fr&gt;  </AUTHOR>
-</MAN>
+  <refsection><title>See Also</title><simplelist type="inline">
+    <member> <link linkend="condestsp">condestsp</link> </member>     
+    <member> <link linkend="taucs_chfact">taucs_chfact</link> </member>     
+    <member> <link linkend="rcond">rcond</link> </member>
+  </simplelist></refsection>
+  <refsection><title>Authors</title><para>Bruno Pincon  &lt;Bruno.Pincon@iecn.u-nancy.fr&gt;  </para></refsection>
+</refentry>
\ No newline at end of file
index cabbdab..657a5fa 100644 (file)
@@ -1,73 +1,68 @@
-<?xml version="1.0" encoding="ISO-8859-1" standalone="no"?> 
-<!DOCTYPE MAN SYSTEM "manrev.dtd">
+<?xml version="1.0" encoding="ISO-8859-1"?><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="condestsp"><info><pubdate>  </pubdate></info><refnamediv><refname>condestsp</refname><refpurpose> estimate the condition number of a sparse matrix  </refpurpose></refnamediv>
 
-<MAN>
+  
+  
+  
+  
 
-  <LANGUAGE>eng</LANGUAGE>
-  <TITLE>condestsp  </TITLE>
-  <TYPE>scilab function - scispt toolbox</TYPE>
-  <DATE>  </DATE>
+  
 
-  <SHORT_DESCRIPTION name="condestsp"> estimate the condition number of a sparse matrix  </SHORT_DESCRIPTION>
+  <refsynopsisdiv><title>Calling Sequence</title><synopsis>[K1] = condestsp(A, LUp, t)
+[K1] = condestsp(A, LUp)
+[K1] = condestsp(A, t)
+[K1] = condestsp(A)</synopsis></refsynopsisdiv>
 
-  <CALLING_SEQUENCE>
-     <CALLING_SEQUENCE_ITEM>[K1] = condestsp(A, LUp, t)</CALLING_SEQUENCE_ITEM>
-     <CALLING_SEQUENCE_ITEM>[K1] = condestsp(A, LUp)</CALLING_SEQUENCE_ITEM>
-     <CALLING_SEQUENCE_ITEM>[K1] = condestsp(A, t)</CALLING_SEQUENCE_ITEM>
-     <CALLING_SEQUENCE_ITEM>[K1] = condestsp(A)</CALLING_SEQUENCE_ITEM>
-  </CALLING_SEQUENCE>
-
-  <PARAM>
-     <PARAM_INDENT>
-     <PARAM_ITEM>
-        <PARAM_NAME>A  </PARAM_NAME>
-        <PARAM_DESCRIPTION>
-          : a real or complex square sparse matrix
-        </PARAM_DESCRIPTION> 
-     </PARAM_ITEM>
-     <PARAM_ITEM>
-        <PARAM_NAME>LUp  </PARAM_NAME>
-        <PARAM_DESCRIPTION>
-           : (optional) a pointer to (umf) LU factors of A obtained by a call to umf_lufact ; 
+  <refsection><title>Parameters</title>
+     <variablelist>
+     <varlistentry>
+        <term>A  </term>
+        <listitem>
+                       <para>a real or complex square sparse matrix</para>
+        </listitem> 
+     </varlistentry>
+     <varlistentry>
+        <term>LUp  </term>
+        <listitem>
+                       <para>(optional) a pointer to (umf) LU factors of A obtained by a call to umf_lufact ; 
              if you have already computed the LU (= PAQ) factors it is recommanded to give 
-             this optional parameter (as the factorization may be time consuming)
-        </PARAM_DESCRIPTION> 
-     </PARAM_ITEM>
-     <PARAM_ITEM>
-        <PARAM_NAME>t  </PARAM_NAME>
-        <PARAM_DESCRIPTION>
-           : (optional) a positive integer (default value 2) by increasing this one 
-             you may hope to get a better (even exact) estimate
-        </PARAM_DESCRIPTION> 
-     </PARAM_ITEM>
-     <PARAM_ITEM>
-        <PARAM_NAME>K1  </PARAM_NAME>
-        <PARAM_DESCRIPTION>
-           : estimated 1-norm condition number of A 
-        </PARAM_DESCRIPTION> 
-     </PARAM_ITEM>
-     </PARAM_INDENT>
-  </PARAM>
+                        this optional parameter (as the factorization may be time consuming)</para>
+        </listitem> 
+     </varlistentry>
+     <varlistentry>
+        <term>t  </term>
+        <listitem>
+                       <para>(optional) a positive integer (default value 2) by increasing this one 
+                               you may hope to get a better (even exact) estimate</para>
+        </listitem> 
+     </varlistentry>
+     <varlistentry>
+        <term>K1  </term>
+        <listitem>
+                       <para>estimated 1-norm condition number of A </para>
+        </listitem> 
+     </varlistentry>
+     </variablelist>
+  </refsection>
 
-  <DESCRIPTION>
-  <P>
+  <refsection><title>Description</title>
+  <para>
     Give an estimate of the 1-norm condition number of 
     the sparse matrix A by Algorithm 2.4 appearing in :
-  </P>
-  <VERBATIM><![CDATA[
+  </para>
+  <programlisting><![CDATA[
   "A block algorithm for matrix 1-norm estimation
    with an application to 1-norm pseudospectra"
    Nicholas J. Higham and Francoise Tisseur
    Siam J. Matrix Anal. Appl., vol 21, No 4, pp 1185-1201
-   ]]></VERBATIM>
-  <P> Noting the exact condition number <TT>K1e = ||A||_1 ||A^(-1)||_1</TT>, 
-    we have allways <TT>K1 &lt;= K1e</TT> and this estimate gives in most case 
-    something superior to <TT>1/2 K1e</TT>
-  </P>
+   ]]></programlisting>
+  <para> Noting the exact condition number <literal>K1e = ||A||_1 ||A^(-1)||_1</literal>, 
+    we have allways <literal>K1 &lt;= K1e</literal> and this estimate gives in most case 
+    something superior to <literal>1/2 K1e</literal>
+  </para>
 
-  </DESCRIPTION>
+  </refsection>
 
-  <EXAMPLE><![CDATA[
+  <refsection><title>Examples</title><programlisting role="example"><![CDATA[
 A = sparse( [ 2  3  0  0  0;
               3  0  4  0  6; 
               0 -1 -3  2  0; 
@@ -88,13 +83,13 @@ K1e = norm(A,1)*norm(inv(full(A)),1)
 Lup = umf_lufact(A);   
 K1 = condestsp(A,Lup)
 umf_ludel(Lup)         // clear memory
-   ]]></EXAMPLE>
+   ]]></programlisting></refsection>
 
-  <SEE_ALSO>
-    <SEE_ALSO_ITEM> <LINK>umf_lufact</LINK> </SEE_ALSO_ITEM>     
-    <SEE_ALSO_ITEM> <LINK>rcond</LINK> </SEE_ALSO_ITEM>
-  </SEE_ALSO>
+  <refsection><title>See Also</title><simplelist type="inline">
+    <member> <link linkend="umf_lufact">umf_lufact</link> </member>     
+    <member> <link linkend="rcond">rcond</link> </member>
+  </simplelist></refsection>
 
-  <AUTHOR>Bruno Pincon &lt;Bruno.Pincon@iecn.u-nancy.fr&gt; </AUTHOR>
+  <refsection><title>Authors</title><para>Bruno Pincon &lt;Bruno.Pincon@iecn.u-nancy.fr&gt; </para></refsection>
 
-</MAN>
+</refentry>
\ No newline at end of file
index b2f1a2f..2a51428 100644 (file)
@@ -1,89 +1,85 @@
-<?xml version="1.0" encoding="ISO-8859-1" standalone="no"?> 
-<!DOCTYPE MAN SYSTEM "manrev.dtd">
-<MAN>
+<?xml version="1.0" encoding="ISO-8859-1"?><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="rafiter"><info><pubdate>  </pubdate></info><refnamediv><refname>rafiter</refname><refpurpose> (obsolete) iterative refinement for a s.p.d. linear system  </refpurpose></refnamediv>
 
-  <LANGUAGE>eng</LANGUAGE>
-  <TITLE>rafiter  </TITLE>
-  <TYPE>scilab function - scispt toolbox</TYPE>
-  <DATE>  </DATE>
+  
+  
+  
+  
 
-  <SHORT_DESCRIPTION name="rafiter"> (obsolete) iterative refinement for a s.p.d. linear system  </SHORT_DESCRIPTION>
+  
 
-  <CALLING_SEQUENCE>
-  <CALLING_SEQUENCE_ITEM>[xn, rn] = rafiter(A, C_ptr, b, x0, [, nb_iter, verb])  </CALLING_SEQUENCE_ITEM>
-  </CALLING_SEQUENCE>
+  <refsynopsisdiv><title>Calling Sequence</title><synopsis>[xn, rn] = rafiter(A, C_ptr, b, x0, [, nb_iter, verb])</synopsis></refsynopsisdiv>
 
-  <PARAM>
- <PARAM_INDENT>
-  <PARAM_ITEM>
-  <PARAM_NAME>A  </PARAM_NAME>
-  <PARAM_DESCRIPTION>
-    : a real symetric positive definite sparse matrix
-  </PARAM_DESCRIPTION> 
-  </PARAM_ITEM>
-  <PARAM_ITEM>
-  <PARAM_NAME>C_ptr  </PARAM_NAME>
-  <PARAM_DESCRIPTION>
-    : a pointer to a Cholesky factorization (got with taucs_chfact)
-  </PARAM_DESCRIPTION> 
-  </PARAM_ITEM>
-  <PARAM_ITEM>
-  <PARAM_NAME>b  </PARAM_NAME>
-  <PARAM_DESCRIPTION>
-    : column vector (r.h.s of the linear system) but &quot;matrix&quot; (multiple r.h.s.) are allowed.
-  </PARAM_DESCRIPTION> 
-  </PARAM_ITEM>
-  <PARAM_ITEM>
-  <PARAM_NAME>x0  </PARAM_NAME>
-  <PARAM_DESCRIPTION>
-    : first solution obtained with taucs_chsolve(C_ptr, b)
-  </PARAM_DESCRIPTION> 
-  </PARAM_ITEM>
-  <PARAM_ITEM>
-  <PARAM_NAME>nb_iter  </PARAM_NAME>
-  <PARAM_DESCRIPTION>
-    : (optional) number of raffinement iterations (default 2)
-  </PARAM_DESCRIPTION> 
-  </PARAM_ITEM>
-  <PARAM_ITEM>
-  <PARAM_NAME>verb  </PARAM_NAME>
-  <PARAM_DESCRIPTION>
-    : (optional) boolean, must be %t for displaying the intermediary results, 
-      and %f (default) if you don&apos;t want.
-  </PARAM_DESCRIPTION> 
-  </PARAM_ITEM>
-  <PARAM_ITEM>
-  <PARAM_NAME>xn  </PARAM_NAME>
-  <PARAM_DESCRIPTION>
-    : new refined solution
-  </PARAM_DESCRIPTION> 
-  </PARAM_ITEM>
-  <PARAM_ITEM>
-  <PARAM_NAME>rn  </PARAM_NAME>
-  <PARAM_DESCRIPTION>
-    : residual (<TT>A*xn - b</TT>)
-  </PARAM_DESCRIPTION> 
-  </PARAM_ITEM>
- </PARAM_INDENT>
-  </PARAM>
+  <refsection><title>Parameters</title>
+ <variablelist>
+  <varlistentry>
+  <term>A  </term>
+  <listitem>
+         <para>a real symetric positive definite sparse matrix</para>
+  </listitem> 
+  </varlistentry>
+  <varlistentry>
+  <term>C_ptr  </term>
+  <listitem>
+         <para>a pointer to a Cholesky factorization (got with taucs_chfact)</para>
+  </listitem> 
+  </varlistentry>
+  <varlistentry>
+  <term>b  </term>
+  <listitem>
+         <para>column vector (r.h.s of the linear system) but "matrix" (multiple r.h.s.) are allowed.</para>
+  </listitem> 
+  </varlistentry>
+  <varlistentry>
+  <term>x0  </term>
+  <listitem>
+         <para>first solution obtained with taucs_chsolve(C_ptr, b)</para>
+  </listitem> 
+  </varlistentry>
+  <varlistentry>
+  <term>nb_iter  </term>
+  <listitem>
+         <para>(optional) number of raffinement iterations (default 2)</para>
+  </listitem> 
+  </varlistentry>
+  <varlistentry>
+  <term>verb  </term>
+  <listitem>
+         <para>(optional) boolean, must be %t for displaying the intermediary results, 
+      and %f (default) if you don't want.</para>
+  </listitem> 
+  </varlistentry>
+  <varlistentry>
+  <term>xn  </term>
+  <listitem>
+         <para>new refined solution</para>
+  </listitem> 
+  </varlistentry>
+  <varlistentry>
+  <term>rn  </term>
+  <listitem>
+         <para>residual (<literal>A*xn - b</literal>)</para>
+  </listitem> 
+  </varlistentry>
+ </variablelist>
+  </refsection>
 
-  <DESCRIPTION>
-  <P>
-    This function is somewhat obsolete, use <TT>x = taucs_chsolve(C_ptr,b,A)</TT>
-    (see <LINK>taucs_chsolve</LINK>) which do one iterative refinement step.
-  </P>
-  <P>
+  <refsection><title>Description</title>
+  <para>
+    This function is somewhat obsolete, use <literal>x = taucs_chsolve(C_ptr,b,A)</literal>
+    (see <link linkend="taucs_chsolve">taucs_chsolve</link>) which do one iterative refinement step.
+  </para>
+  <para>
     To use if you want to improve a little the solution got with taucs_chsolve.
     Note that with verb=%t the displayed internal steps are essentially meaningful 
     in the case where b is a column vector.
-  </P>
-  </DESCRIPTION>
-  <SECTION label='Caution'>
-  <P>
+  </para>
+  </refsection>
+  <refsection><title>Caution</title>
+  <para>
     Currently there is no verification for the input parameters !
-  </P>
-  </SECTION>
-  <EXAMPLE><![CDATA[
+  </para>
+  </refsection>
+  <refsection><title>Examples</title><programlisting role="example"><![CDATA[
 [A] = ReadHBSparse(DIR_SCISPT_DEM+"bcsstk24.rsa");
 C_ptr = taucs_chfact(A);
 b = rand(size(A,1),1);
@@ -92,13 +88,13 @@ norm(A*x0 - b)
 [xn, rn] = rafiter(A, C_ptr, b, x0, verb=%t);
 norm(A*xn - b)
 taucs_chdel(C_ptr)
- ]]></EXAMPLE>
+ ]]></programlisting></refsection>
 
-  <SEE_ALSO>
-    <SEE_ALSO_ITEM> <LINK>taucs_chsolve</LINK> </SEE_ALSO_ITEM>     
-    <SEE_ALSO_ITEM> <LINK>taucs_chfact</LINK> </SEE_ALSO_ITEM>
-  </SEE_ALSO>
+  <refsection><title>See Also</title><simplelist type="inline">
+    <member> <link linkend="taucs_chsolve">taucs_chsolve</link> </member>     
+    <member> <link linkend="taucs_chfact">taucs_chfact</link> </member>
+  </simplelist></refsection>
 
-  <AUTHOR>Bruno Pincon &lt;Bruno.Pincon@iecn.u-nancy.fr&gt; </AUTHOR>
+  <refsection><title>Authors</title><para>Bruno Pincon &lt;Bruno.Pincon@iecn.u-nancy.fr&gt; </para></refsection>
 
-</MAN>
+</refentry>
\ No newline at end of file
index 12c50e8..2388717 100644 (file)
@@ -1,81 +1,77 @@
-<?xml version="1.0" encoding="ISO-8859-1" standalone="no"?> 
-<!DOCTYPE MAN SYSTEM "manrev.dtd">
-<MAN>
+<?xml version="1.0" encoding="ISO-8859-1"?><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="res_with_prec"><info><pubdate>  </pubdate></info><refnamediv><refname>res_with_prec</refname><refpurpose> computes the residual r = Ax-b with precision  </refpurpose></refnamediv>
 
-  <LANGUAGE>eng</LANGUAGE>
-  <TITLE>res_with_prec  </TITLE>
-  <TYPE>scilab function - scispt toolbox</TYPE>
-  <DATE>  </DATE>
+  
+  
+  
+  
 
-  <SHORT_DESCRIPTION name="res_with_prec"> computes the residual r = Ax-b with precision  </SHORT_DESCRIPTION>
-  <CALLING_SEQUENCE>
-  <CALLING_SEQUENCE_ITEM>[r,norm2_r] = res_with_prec(A, x, b)  </CALLING_SEQUENCE_ITEM>
-  </CALLING_SEQUENCE>
+  
+  <refsynopsisdiv><title>Calling Sequence</title><synopsis>[r,norm2_r] = res_with_prec(A, x, b)</synopsis></refsynopsisdiv>
 
-  <PARAM>
- <PARAM_INDENT>
-  <PARAM_ITEM>
-  <PARAM_NAME>A  </PARAM_NAME>
-  <PARAM_DESCRIPTION>
-    : real or complex sparse matrix (m x n)
-  </PARAM_DESCRIPTION> 
-  </PARAM_ITEM>
-  <PARAM_ITEM>
-  <PARAM_NAME>x  </PARAM_NAME>
-  <PARAM_DESCRIPTION>
-    : column vector (n x 1) or matrix (n x p) 
-  </PARAM_DESCRIPTION> 
-  </PARAM_ITEM>
-  <PARAM_ITEM>
-  <PARAM_NAME>b  </PARAM_NAME>
-  <PARAM_DESCRIPTION>
-    : column vector (m x 1) or matrix (m x p)
-  </PARAM_DESCRIPTION> 
-  </PARAM_ITEM>
-  <PARAM_ITEM>
-  <PARAM_NAME>r  </PARAM_NAME>
-  <PARAM_DESCRIPTION>
-    : column vector (m x 1) or matrix (m x p)
-  </PARAM_DESCRIPTION> 
-  </PARAM_ITEM>
-  <PARAM_ITEM>
-  <PARAM_NAME>norm2_r  </PARAM_NAME>
-  <PARAM_DESCRIPTION>
-    : scalar or vector (1 x p) when b is a m x p matrix
-  </PARAM_DESCRIPTION> 
-  </PARAM_ITEM>
- </PARAM_INDENT>
-  </PARAM>
+  <refsection><title>Parameters</title>
+ <variablelist>
+  <varlistentry>
+  <term>A  </term>
+  <listitem>
+         <para>real or complex sparse matrix (m x n)</para>
+  </listitem> 
+  </varlistentry>
+  <varlistentry>
+  <term>x  </term>
+  <listitem>
+         <para>column vector (n x 1) or matrix (n x p) </para>
+  </listitem> 
+  </varlistentry>
+  <varlistentry>
+  <term>b  </term>
+  <listitem>
+         <para>column vector (m x 1) or matrix (m x p)</para>
+  </listitem> 
+  </varlistentry>
+  <varlistentry>
+  <term>r  </term>
+  <listitem>
+         <para>column vector (m x 1) or matrix (m x p)</para>
+  </listitem> 
+  </varlistentry>
+  <varlistentry>
+  <term>norm2_r  </term>
+  <listitem>
+         <para>scalar or vector (1 x p) when b is a m x p matrix</para>
+  </listitem> 
+  </varlistentry>
+ </variablelist>
+  </refsection>
 
-  <DESCRIPTION>
-  <P>
-    This function computes the residual of a linear system <TT>r = Ax - b</TT> (together
-    with its 2-norm) with the additionnal precision provided on &quot;Intel like&quot; 
-    FPU (80 bits in place of 64) if the compiler translate &quot;long double&quot; to 
-    use it. Else one must get the same than using <TT>A*x - b</TT> at the scilab level. 
-    In both cases using <VERB>[r, nr] = res_with_prec(A,x,b)</VERB> is 
-    faster than  <VERB>r = A*x - b</VERB> (and faster than <TT>r = A*x - b; nr = norm(r)</TT>).
-  </P>
-  <P>
-    When <TT>p &gt; 1</TT>, <TT>norm2_r(i)</TT> is the 2-norm of the vector <TT>r(:,i)</TT>.
-  </P>
+  <refsection><title>Description</title>
+  <para>
+    This function computes the residual of a linear system <literal>r = Ax - b</literal> (together
+    with its 2-norm) with the additionnal precision provided on "Intel like" 
+    FPU (80 bits in place of 64) if the compiler translate "long double" to 
+    use it. Else one must get the same than using <literal>A*x - b</literal> at the scilab level. 
+    In both cases using <literal>[r, nr] = res_with_prec(A,x,b)</literal> is 
+    faster than  <literal>r = A*x - b</literal> (and faster than <literal>r = A*x - b; nr = norm(r)</literal>).
+  </para>
+  <para>
+    When <literal>p &gt; 1</literal>, <literal>norm2_r(i)</literal> is the 2-norm of the vector <literal>r(:,i)</literal>.
+  </para>
 
-  </DESCRIPTION>
+  </refsection>
 
-  <EXAMPLE><![CDATA[
+  <refsection><title>Examples</title><programlisting role="example"><![CDATA[
 [A] = ReadHBSparse(DIR_SCISPT_DEM+"bcsstk24.rsa");
 C_ptr = taucs_chfact(A);
 b = rand(size(A,1),1);
 x0 = taucs_chsolve(C_ptr, b);
 norm(A*x0 - b)
 norm(res_with_prec(A, x0, b))
- ]]></EXAMPLE>
+ ]]></programlisting></refsection>
 
-  <SEE_ALSO>
-    <SEE_ALSO_ITEM> <LINK>rafiter</LINK> </SEE_ALSO_ITEM>
+  <refsection><title>See Also</title><simplelist type="inline">
+    <member> <link linkend="rafiter">rafiter</link> </member>
 
-  </SEE_ALSO>
+  </simplelist></refsection>
 
-  <AUTHOR>Bruno Pincon &lt;Bruno.Pincon@iecn.u-nancy.fr&gt; </AUTHOR>
+  <refsection><title>Authors</title><para>Bruno Pincon &lt;Bruno.Pincon@iecn.u-nancy.fr&gt; </para></refsection>
 
-</MAN>
+</refentry>
\ No newline at end of file
index 101bd32..34e0959 100644 (file)
@@ -1,53 +1,49 @@
-<?xml version="1.0" encoding="ISO-8859-1" standalone="no"?> 
-<!DOCTYPE MAN SYSTEM "manrev.dtd">
-<MAN>
+<?xml version="1.0" encoding="ISO-8859-1"?><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="taucs_chdel"><info><pubdate>  </pubdate></info><refnamediv><refname>taucs_chdel</refname><refpurpose> utility function used with taucs_chfact  </refpurpose></refnamediv>
  
- <LANGUAGE>eng</LANGUAGE>
-  <TITLE>taucs_chdel  </TITLE>
-  <TYPE>scilab function - scispt toolbox</TYPE>
-  <DATE>  </DATE>
-  <SHORT_DESCRIPTION name="taucs_chdel"> utility function used with taucs_chfact  </SHORT_DESCRIPTION>
+  
+  
+  
+  
 
-  <CALLING_SEQUENCE>
-  <CALLING_SEQUENCE_ITEM>taucs_chdel(C_ptr) or taucs_chdel()  </CALLING_SEQUENCE_ITEM>
-  </CALLING_SEQUENCE>
+  <refsynopsisdiv><title>Calling Sequence</title><synopsis>taucs_chdel(C_ptr) or taucs_chdel()</synopsis></refsynopsisdiv>
 
-  <PARAM>
- <PARAM_INDENT>
-  <PARAM_ITEM>
-  <PARAM_NAME>C_ptr  </PARAM_NAME>
-  <PARAM_DESCRIPTION>
-    : a pointer to a Cholesky factorization
-  </PARAM_DESCRIPTION> 
-  </PARAM_ITEM>
- </PARAM_INDENT>
-  </PARAM>
+  <refsection><title>Parameters</title>
+ <variablelist>
+  <varlistentry>
+  <term>C_ptr  </term>
+  <listitem>
+    <para>a pointer to a Cholesky factorization</para>
+  </listitem> 
+  </varlistentry>
+ </variablelist>
+  </refsection>
 
-  <DESCRIPTION>
-  <P>
-    This function is used in conjunction with <LINK>taucs_chfact</LINK> and
-    <LINK>taucs_chsolve</LINK>. It clears the internal memory space used to store 
+  <refsection><title>Description</title>
+  <para>
+    This function is used in conjunction with <link linkend="taucs_chfact">taucs_chfact</link> and
+    <link linkend="taucs_chsolve">taucs_chsolve</link>. It clears the internal memory space used to store 
     the Cholesky factorization (got with taucs_chfact). Use without argument 
     it frees the memory for all the current scilab (taucs) Cholesky factorizations. 
-  </P>
-  </DESCRIPTION>
+  </para>
+  </refsection>
 
-  <SECTION label='Examples'>
-  <P>
-    see the example section of <LINK>taucs_chfact</LINK>
-  </P>
-  </SECTION>
+  <refsection><title>Examples</title>
+  <para>
+    see the example section of <link linkend="taucs_chfact">taucs_chfact</link>
+  </para>
+  </refsection>
 
-  <SEE_ALSO>
-    <SEE_ALSO_ITEM> <LINK>taucs_chfact</LINK> </SEE_ALSO_ITEM>     
-    <SEE_ALSO_ITEM> <LINK>taucs_chsolve</LINK> </SEE_ALSO_ITEM>     
-    <SEE_ALSO_ITEM> <LINK>taucs_chinfo</LINK> </SEE_ALSO_ITEM>     
-    <SEE_ALSO_ITEM> <LINK>taucs_chget</LINK> </SEE_ALSO_ITEM>
-  </SEE_ALSO>
+  <refsection><title>See Also</title><simplelist type="inline">
+    <member> <link linkend="taucs_chfact">taucs_chfact</link> </member>     
+    <member> <link linkend="taucs_chsolve">taucs_chsolve</link> </member>     
+    <member> <link linkend="taucs_chinfo">taucs_chinfo</link> </member>     
+    <member> <link linkend="taucs_chget">taucs_chget</link> </member>
+  </simplelist></refsection>
 
-  <AUTHORS>
-      <AUTHORS_ITEM><EM>taucs</EM> by Sivan Toledo (see <LINK>taucs_license</LINK>)</AUTHORS_ITEM>
-      <AUTHORS_ITEM><EM>scilab interface</EM> by Bruno Pincon</AUTHORS_ITEM>
-  </AUTHORS>
+  <refsection><title>Authors</title><simplelist type="vert">
+      <member>taucs by Sivan Toledo (see taucs_license)</member>
+      <member>scilab interface by Bruno Pincon</member>
+  </simplelist></refsection>
 
-</MAN>
+</refentry>
\ No newline at end of file
index fbd1393..27a0f1f 100644 (file)
@@ -1,61 +1,56 @@
-<?xml version="1.0" encoding="ISO-8859-1" standalone="no"?> 
-<!DOCTYPE MAN SYSTEM "manrev.dtd">
+<?xml version="1.0" encoding="ISO-8859-1"?><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="taucs_chget"><info><pubdate>  </pubdate></info><refnamediv><refname>taucs_chget</refname><refpurpose> retrieve the Cholesky factorization at the scilab level  </refpurpose></refnamediv>
+  
+  
+  
+  
 
-<MAN>
-  <LANGUAGE>eng</LANGUAGE>
-  <TITLE>taucs_chget  </TITLE>
-  <TYPE>scilab function - scispt toolbox</TYPE>
-  <DATE>  </DATE>
+  
 
-  <SHORT_DESCRIPTION name="taucs_chget"> retrieve the Cholesky factorization at the scilab level  </SHORT_DESCRIPTION>
+  <refsynopsisdiv><title>Calling Sequence</title><synopsis>[Ct,p] = taucs_chget(C_ptr)</synopsis></refsynopsisdiv>
 
-  <CALLING_SEQUENCE>
-  <CALLING_SEQUENCE_ITEM>[Ct,p] = taucs_chget(C_ptr)  </CALLING_SEQUENCE_ITEM>
-  </CALLING_SEQUENCE>
+  <refsection><title>Parameters</title>
+ <variablelist>
+  <varlistentry>
+  <term>C_ptr  </term>
+  <listitem>
+  <para>a pointer to the Cholesky factorization (C,p : A(p,p)=CC')</para>
+  </listitem> 
+  </varlistentry>
+  <varlistentry>
+  <term>Ct  </term>
+  <listitem>
+  <para>a scilab sparse matrix (you get the upper triangle i.e. Ct is equal to C') </para>
+  </listitem> 
+  </varlistentry>
+  <varlistentry>
+  <term>p  </term>
+  <listitem>
+         <para>column vector storing the permutation</para>
+  </listitem> 
+  </varlistentry>
+ </variablelist>
+  </refsection>
 
-  <PARAM>
- <PARAM_INDENT>
-  <PARAM_ITEM>
-  <PARAM_NAME>C_ptr  </PARAM_NAME>
-  <PARAM_DESCRIPTION>
-    : a pointer to the Cholesky factorization (C,p : A(p,p)=CC&apos;)
-  </PARAM_DESCRIPTION> 
-  </PARAM_ITEM>
-  <PARAM_ITEM>
-  <PARAM_NAME>Ct  </PARAM_NAME>
-  <PARAM_DESCRIPTION>
-    : a scilab sparse matrix (you get the upper triangle i.e. Ct is equal to C&apos;) 
-  </PARAM_DESCRIPTION> 
-  </PARAM_ITEM>
-  <PARAM_ITEM>
-  <PARAM_NAME>p  </PARAM_NAME>
-  <PARAM_DESCRIPTION>
-    : column vector storing the permutation
-  </PARAM_DESCRIPTION> 
-  </PARAM_ITEM>
- </PARAM_INDENT>
-  </PARAM>
-
-  <DESCRIPTION>
-  <P>
+  <refsection><title>Description</title>
+  <para>
     This function  may be used if you want  to plot  the sparse
     pattern  of the Cholesky factorization (or if you  code something which
     use the factors). Traditionnaly, the factorization is written :
-  </P>
-  <VERBATIM><![CDATA[
+  </para>
+  <programlisting><![CDATA[
     P A P' = C C'
-   ]]></VERBATIM>
-  <P>
-    with P&apos; the permutation matrix associated to the permutation p.
-    As we get the upper triangle Ct (= C&apos;), in scilab syntax we
+   ]]></programlisting>
+  <para>
+    with P' the permutation matrix associated to the permutation p.
+    As we get the upper triangle Ct (= C'), in scilab syntax we
     can write :
-  </P>
-  <VERBATIM><![CDATA[
+  </para>
+  <programlisting><![CDATA[
     A(p,p) = Ct' * Ct
-   ]]></VERBATIM>
-  </DESCRIPTION>
+   ]]></programlisting>
+  </refsection>
 
-  <EXAMPLE><![CDATA[
+  <refsection><title>Examples</title><programlisting role="example"><![CDATA[
 // Example #1 : a small linear test system 
 A = sparse( [ 2 -1  0  0  0;
              -1  2 -1  0  0; 
@@ -91,20 +86,20 @@ PlotSparse(Ct) ; xtitle("The pattern of Ct (A(p,p) = C*Ct)")
 cnz_exact = nnz(Ct)
 // don't forget to clear memory
 taucs_chdel(Cptr)
- ]]></EXAMPLE>
+ ]]></programlisting></refsection>
 
-  <SEE_ALSO>
-    <SEE_ALSO_ITEM> <LINK>taucs_chfact</LINK> </SEE_ALSO_ITEM>     
-    <SEE_ALSO_ITEM> <LINK>taucs_chsolve</LINK> </SEE_ALSO_ITEM>     
-    <SEE_ALSO_ITEM> <LINK>taucs_chdel</LINK> </SEE_ALSO_ITEM>     
-    <SEE_ALSO_ITEM> <LINK>taucs_chinfo</LINK> </SEE_ALSO_ITEM>     
-    <SEE_ALSO_ITEM> <LINK>taucs_chget</LINK> </SEE_ALSO_ITEM>     
-    <SEE_ALSO_ITEM> <LINK>cond2sp</LINK> </SEE_ALSO_ITEM>
-  </SEE_ALSO>
+  <refsection><title>See Also</title><simplelist type="inline">
+    <member> <link linkend="taucs_chfact">taucs_chfact</link> </member>     
+    <member> <link linkend="taucs_chsolve">taucs_chsolve</link> </member>     
+    <member> <link linkend="taucs_chdel">taucs_chdel</link> </member>     
+    <member> <link linkend="taucs_chinfo">taucs_chinfo</link> </member>     
+    <member> <link linkend="taucs_chget">taucs_chget</link> </member>     
+    <member> <link linkend="cond2sp">cond2sp</link> </member>
+  </simplelist></refsection>
 
-  <AUTHORS>
-      <AUTHORS_ITEM><EM>taucs</EM> by Sivan Toledo (see <LINK>taucs_license</LINK>)</AUTHORS_ITEM>
-      <AUTHORS_ITEM><EM>scilab interface</EM> by Bruno Pincon</AUTHORS_ITEM>
-  </AUTHORS>
+  <refsection><title>Authors</title><simplelist type="vert">
+      <member>taucs by Sivan Toledo (see taucs_license)</member>
+      <member>scilab interface by Bruno Pincon</member>
+  </simplelist></refsection>
 
-</MAN>
+</refentry>
\ No newline at end of file
index aa5ee4c..ee61d53 100644 (file)
@@ -1,76 +1,71 @@
-<?xml version="1.0" encoding="ISO-8859-1" standalone="no"?> 
-<!DOCTYPE MAN SYSTEM "manrev.dtd">
+<?xml version="1.0" encoding="ISO-8859-1"?><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="taucs_chsolve"><info><pubdate>  </pubdate></info><refnamediv><refname>taucs_chsolve</refname><refpurpose> solve a linear sparse (s.p.d.) system given the Cholesky factors  </refpurpose></refnamediv>
+  
+  
+  
+  
+  
 
-<MAN>
-  <LANGUAGE>eng</LANGUAGE>
-  <TITLE>taucs_chsolve  </TITLE>
-  <TYPE>scilab function - scispt toolbox</TYPE>
-  <DATE>  </DATE>
-  <SHORT_DESCRIPTION name="taucs_chsolve"> solve a linear sparse (s.p.d.) system given the Cholesky factors  </SHORT_DESCRIPTION>
+  <refsynopsisdiv><title>Calling Sequence</title><synopsis>[x] = taucs_chsolve(C_ptr, b [, A])</synopsis></refsynopsisdiv>
 
-  <CALLING_SEQUENCE>
-  <CALLING_SEQUENCE_ITEM>[x] = taucs_chsolve(C_ptr, b [, A])  </CALLING_SEQUENCE_ITEM>
-  </CALLING_SEQUENCE>
+  <refsection><title>Parameters</title>
+ <variablelist>
+  <varlistentry>
+  <term>C_ptr  </term>
+  <listitem>
+   <para>a pointer to a handle of the Cholesky factors (C,p with A(p,p)=CC')</para>
+  </listitem> 
+  </varlistentry>
+  <varlistentry>
+  <term>b  </term>
+  <listitem>
+         <para>a real column vector or a matrix (multiple rhs)</para>
+  </listitem> 
+  </varlistentry>
+  <varlistentry>
+  <term>x  </term>
+  <listitem>
+         <para>a real column vector or a matrix in case of multiple rhs ( x(:,i) is solution of A x(:,i) = b(:,i))</para>
+  </listitem> 
+  </varlistentry>
+  <varlistentry>
+  <term>A  </term>
+  <listitem>
+         <para>(optional) the real s.p.d. matrix A (to use for iterative refinement step)</para>
+  </listitem> 
+  </varlistentry>
+ </variablelist>
+  </refsection>
 
-  <PARAM>
- <PARAM_INDENT>
-  <PARAM_ITEM>
-  <PARAM_NAME>C_ptr  </PARAM_NAME>
-  <PARAM_DESCRIPTION>
-    : a pointer to a handle of the Cholesky factors (C,p with A(p,p)=CC&apos;)
-  </PARAM_DESCRIPTION> 
-  </PARAM_ITEM>
-  <PARAM_ITEM>
-  <PARAM_NAME>b  </PARAM_NAME>
-  <PARAM_DESCRIPTION>
-    : a real column vector or a matrix (multiple rhs)
-  </PARAM_DESCRIPTION> 
-  </PARAM_ITEM>
-  <PARAM_ITEM>
-  <PARAM_NAME>x  </PARAM_NAME>
-  <PARAM_DESCRIPTION>
-    : a real column vector or a matrix in case of multiple rhs ( x(:,i) is solution of A x(:,i) = b(:,i))
-  </PARAM_DESCRIPTION> 
-  </PARAM_ITEM>
-  <PARAM_ITEM>
-  <PARAM_NAME>A  </PARAM_NAME>
-  <PARAM_DESCRIPTION>
-    : (optional) the real s.p.d. matrix A (to use for iterative refinement step)
-  </PARAM_DESCRIPTION> 
-  </PARAM_ITEM>
- </PARAM_INDENT>
-  </PARAM>
-
-  <DESCRIPTION>
-  <P>
-    This function must be used in conjonction with <LINK>taucs_chfact</LINK> which
+  <refsection><title>Description</title>
+  <para>
+    This function must be used in conjonction with <link linkend="taucs_chfact">taucs_chfact</link> which
     computes the Cholesky factorization of a sparse real s.p.d. matrix.
-    When the matrix <VERB>A</VERB> is provided, one iterative refinement
+    When the matrix <literal>A</literal> is provided, one iterative refinement
     step is done (the refined solution is accepted if it improves the
-    2-norm of the residual <VERB>Ax-b</VERB>).
-  </P>
-  <P>
-    Like in <LINK>taucs_chfact</LINK> the matrix A may be provided either
+    2-norm of the residual <literal>Ax-b</literal>).
+  </para>
+  <para>
+    Like in <link linkend="taucs_chfact">taucs_chfact</link> the matrix A may be provided either
     in its complete form (that is with the lower triangle also) or
     only with its upper triangle.
-   </P>
-   </DESCRIPTION>
-  <SECTION label='Examples'>
-  <P>
-    see the example section of <LINK>taucs_chfact</LINK>
-  </P>
-  </SECTION>
-  <SEE_ALSO>
-    <SEE_ALSO_ITEM> <LINK>taucs_chfact</LINK> </SEE_ALSO_ITEM>     
-    <SEE_ALSO_ITEM> <LINK>taucs_chdel</LINK> </SEE_ALSO_ITEM>     
-    <SEE_ALSO_ITEM> <LINK>taucs_chinfo</LINK> </SEE_ALSO_ITEM>     
-    <SEE_ALSO_ITEM> <LINK>taucs_chget</LINK> </SEE_ALSO_ITEM>     
-    <SEE_ALSO_ITEM> <LINK>cond2sp</LINK> </SEE_ALSO_ITEM>
-  </SEE_ALSO>
+   </para>
+   </refsection>
+  <refsection><title>Examples</title>
+  <para>
+    see the example section of <link linkend="taucs_chfact">taucs_chfact</link>
+  </para>
+  </refsection>
+  <refsection><title>See Also</title><simplelist type="inline">
+    <member> <link linkend="taucs_chfact">taucs_chfact</link> </member>     
+    <member> <link linkend="taucs_chdel">taucs_chdel</link> </member>     
+    <member> <link linkend="taucs_chinfo">taucs_chinfo</link> </member>     
+    <member> <link linkend="taucs_chget">taucs_chget</link> </member>     
+    <member> <link linkend="cond2sp">cond2sp</link> </member>
+  </simplelist></refsection>
 
-  <AUTHORS>
-      <AUTHORS_ITEM><EM>taucs</EM> by Sivan Toledo (see <LINK>taucs_license</LINK>)</AUTHORS_ITEM>
-      <AUTHORS_ITEM><EM>scilab interface</EM> by Bruno Pincon</AUTHORS_ITEM>
-  </AUTHORS>
+  <refsection><title>Authors</title><simplelist type="vert">
+      <member>taucs by Sivan Toledo (see taucs_license)</member>
+      <member>scilab interface by Bruno Pincon</member>
+  </simplelist></refsection>
 
-</MAN>
+</refentry>
\ No newline at end of file
index e8ff424..c504143 100644 (file)
@@ -1,35 +1,33 @@
-<?xml version="1.0" encoding="ISO-8859-1" standalone="no"?> 
-<!DOCTYPE MAN SYSTEM "manrev.dtd">
-<MAN>
-  <LANGUAGE>eng</LANGUAGE>
-  <TITLE>taucs_license  </TITLE>
-  <TYPE>  </TYPE>
-  <DATE>scispt toolbox  </DATE>
-  <SHORT_DESCRIPTION name="taucs_license"> display the taucs license   </SHORT_DESCRIPTION>
-  <SECTION label='Copyright'>
-  <P>
+<?xml version="1.0" encoding="ISO-8859-1"?><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="taucs_license"><info><pubdate>scispt toolbox  </pubdate></info><refnamediv><refname>taucs_license</refname><refpurpose> display the taucs license   </refpurpose></refnamediv>
+  
+  
+  
+  
+  
+  <refsection><title>Copyright</title>
+  <para>
     TAUCS Version 1.0, November 29, 2001. Copyright (c) 2001 by Sivan Toledo, Tel-Aviv Univesity,
     stoledo@tau.ac.il. All Rights Reserved. 
-  </P>
-  </SECTION>
-  <SECTION label='TAUCS License'>
-  <P>
+  </para>
+  </refsection>
+  <refsection><title>TAUCS License</title>
+  <para>
     Your use or distribution of TAUCS or any derivative code implies that you agree to this 
     License.   THIS MATERIAL IS PROVIDED AS IS, WITH ABSOLUTELY NO WARRANTY EXPRESSED OR IMPLIED. 
     ANY USE IS AT YOUR OWN RISK.   Permission is hereby granted to use or copy this program, 
     provided that the Copyright, this License, and the Availability of the original version is 
     retained on all copies. User documentation of any code that uses this code or any derivative
-    code must cite the Copyright, this License, the Availability note, and &quot;Used by permission.&quot; 
+    code must cite the Copyright, this License, the Availability note, and "Used by permission." 
     If this code or any derivative code is accessible from within MATLAB, then typing 
-    &quot;help taucs&quot; must cite the Copyright, and &quot;type taucs&quot; must also cite this 
+    "help taucs" must cite the Copyright, and "type taucs" must also cite this 
     License and the Availability note. Permission to modify the code and to distribute modified code 
     is granted, provided the Copyright, this License, and the Availability note are retained, and a 
     notice that the code was modified is included. This software is provided to you free of charge. 
-  </P>
-  </SECTION>
-  <SECTION label='Availability'>
-  <P>
-    <A href="http://www.tau.ac.il/~stoledo/taucs/">http://www.tau.ac.il/~stoledo/taucs/</A>
-  </P>
-  </SECTION>
-</MAN>
+  </para>
+  </refsection>
+  <refsection><title>Availability</title>
+  <para>
+    <link xlink:href="http://www.tau.ac.il/~stoledo/taucs/">http://www.tau.ac.il/~stoledo/taucs/</link>
+  </para>
+  </refsection>
+</refentry>
\ No newline at end of file
index bed2943..695577a 100644 (file)
@@ -1,21 +1,19 @@
-<?xml version="1.0" encoding="ISO-8859-1" standalone="no"?> 
-<!DOCTYPE MAN SYSTEM "manrev.dtd">
-<MAN>
-  <LANGUAGE>eng</LANGUAGE>
-  <TITLE>umf_license  </TITLE>
-  <TYPE>  </TYPE>
-  <DATE>scispt toolbox  </DATE>
-  <SHORT_DESCRIPTION name="umf_license"> display the umfpack license   </SHORT_DESCRIPTION>
+<?xml version="1.0" encoding="ISO-8859-1"?><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_license"><info><pubdate>scispt toolbox  </pubdate></info><refnamediv><refname>umf_license</refname><refpurpose> display the umfpack license   </refpurpose></refnamediv>
+  
+  
+  
+  
+  
 
-  <SECTION label='Copyright'>
-  <P>
+  <refsection><title>Copyright</title>
+  <para>
 UMFPACK, Copyright (c) 1995-2006 by Timothy A.  Davis.  All Rights Reserved.
 UMFPACK is available under alternate licences; contact T. Davis for details.
-  </P>
-  </SECTION>
+  </para>
+  </refsection>
 
-  <SECTION label='UMFPACK License'>
-  <P>
+  <refsection><title>UMFPACK License</title>
+  <para>
     Your use or distribution of UMFPACK or any modified version of
     UMFPACK implies that you agree to this License.
 
@@ -43,11 +41,11 @@ UMFPACK is available under alternate licences; contact T. Davis for details.
     the code and to distribute modified code is granted, provided the
     Copyright, this License, and the Availability note are retained,
     and a notice that the code was modified is included.
-  </P>
-  </SECTION>
-  <SECTION label='Availability'>
-  <P>
-    <A href="http://www.cise.ufl.edu/research/sparse">http://www.cise.ufl.edu/research/sparse</A>
-  </P>
-  </SECTION>
-</MAN>
+  </para>
+  </refsection>
+  <refsection><title>Availability</title>
+  <para>
+    <link xlink:href="http://www.cise.ufl.edu/research/sparse">http://www.cise.ufl.edu/research/sparse</link>
+  </para>
+  </refsection>
+</refentry>
\ No newline at end of file
index 44db271..42b50c6 100644 (file)
@@ -1,54 +1,50 @@
-<?xml version="1.0" encoding="ISO-8859-1" standalone="no"?> 
-<!DOCTYPE MAN SYSTEM "manrev.dtd">
-<MAN>
-
-  <LANGUAGE>eng</LANGUAGE>
-  <TITLE>umf_ludel  </TITLE>
-  <TYPE>scilab function - scispt toolbox</TYPE>
-  <DATE>scispt toolbox  </DATE>
-  <SHORT_DESCRIPTION name="umf_ludel"> utility function used with umf_lufact  </SHORT_DESCRIPTION>
-
-  <CALLING_SEQUENCE>
-     <CALLING_SEQUENCE_ITEM>umf_ludel(LU_ptr) or umf_ludel()  </CALLING_SEQUENCE_ITEM>
-  </CALLING_SEQUENCE>
-
-  <PARAM>
-     <PARAM_INDENT>
-     <PARAM_ITEM>
-         <PARAM_NAME>LU_ptr  </PARAM_NAME>
-         <PARAM_DESCRIPTION>
-            : a pointer to an handle of umf lu factors (L,U,p,q,R)
-         </PARAM_DESCRIPTION> 
-     </PARAM_ITEM>
-     </PARAM_INDENT>
-  </PARAM>
-
-  <DESCRIPTION>
-  <P>
-    This function must be used in conjunction with <LINK>umf_lufact</LINK> and
-    <LINK>umf_lusolve</LINK>. It clears the internal memory space used to store 
+<?xml version="1.0" encoding="ISO-8859-1"?><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_ludel"><info><pubdate>scispt toolbox  </pubdate></info><refnamediv><refname>umf_ludel</refname><refpurpose> utility function used with umf_lufact  </refpurpose></refnamediv>
+
+  
+  
+  
+  
+  
+
+  <refsynopsisdiv><title>Calling Sequence</title><synopsis>umf_ludel(LU_ptr) or umf_ludel()</synopsis></refsynopsisdiv>
+
+  <refsection><title>Parameters</title>
+     <variablelist>
+     <varlistentry>
+         <term>LU_ptr  </term>
+         <listitem>
+                        <para>a pointer to an handle of umf lu factors (L,U,p,q,R)</para>
+         </listitem> 
+     </varlistentry>
+     </variablelist>
+  </refsection>
+
+  <refsection><title>Description</title>
+  <para>
+    This function must be used in conjunction with <link linkend="umf_lufact">umf_lufact</link> and
+    <link linkend="umf_lusolve">umf_lusolve</link>. It clears the internal memory space used to store 
     the LU factors (got with umf_lufact). Use without argument 
     it frees the memory for all the current scilab umfpack LU factors. 
-  </P>
-  </DESCRIPTION>
-
-  <SECTION label='Examples'>
-  <P>
-    see the example section of <LINK>umf_lufact</LINK> 
-  </P>
-  </SECTION>
-
-  <SEE_ALSO>
-    <SEE_ALSO_ITEM> <LINK>umfpack</LINK> </SEE_ALSO_ITEM>     
-    <SEE_ALSO_ITEM> <LINK>umf_lufact</LINK> </SEE_ALSO_ITEM>     
-    <SEE_ALSO_ITEM> <LINK>umf_lusolve</LINK> </SEE_ALSO_ITEM>     
-    <SEE_ALSO_ITEM> <LINK>umf_luget</LINK> </SEE_ALSO_ITEM>     
-    <SEE_ALSO_ITEM> <LINK>umf_luinfo</LINK> </SEE_ALSO_ITEM>
-  </SEE_ALSO>
-
-  <AUTHORS>
-      <AUTHORS_ITEM><EM>umfpack</EM> by Timothy A. Davis (see <LINK>umf_license</LINK>)</AUTHORS_ITEM>
-      <AUTHORS_ITEM><EM>scilab interface</EM> by Bruno Pincon</AUTHORS_ITEM>
-  </AUTHORS>
-
-</MAN>
+  </para>
+  </refsection>
+
+  <refsection><title>Examples</title>
+  <para>
+    see the example section of <link linkend="umf_lufact">umf_lufact</link> 
+  </para>
+  </refsection>
+
+  <refsection><title>See Also</title><simplelist type="inline">
+    <member> <link linkend="umfpack">umfpack</link> </member>     
+    <member> <link linkend="umf_lufact">umf_lufact</link> </member>     
+    <member> <link linkend="umf_lusolve">umf_lusolve</link> </member>     
+    <member> <link linkend="umf_luget">umf_luget</link> </member>     
+    <member> <link linkend="umf_luinfo">umf_luinfo</link> </member>
+  </simplelist></refsection>
+
+  <refsection><title>Authors</title><simplelist type="vert">
+      <member>umfpack by Timothy A. Davis (see umf_license)</member>
+      <member>scilab interface by Bruno Pincon</member>
+  </simplelist></refsection>
+
+</refentry>
\ No newline at end of file
index 9fb1eaa..9aaef37 100644 (file)
@@ -1,68 +1,63 @@
-<?xml version="1.0" encoding="ISO-8859-1" standalone="no"?> 
-<!DOCTYPE MAN SYSTEM "manrev.dtd">
+<?xml version="1.0" encoding="ISO-8859-1"?><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_luget"><info><pubdate/></info><refnamediv><refname>umf_luget</refname><refpurpose> retrieve lu factors at the scilab level  </refpurpose></refnamediv>
 
-<MAN>
-
-  <LANGUAGE>eng</LANGUAGE>
-  <TITLE>umf_luget  </TITLE>
-  <TYPE>scilab function - scispt toolbox</TYPE>
-  <DATE></DATE>
-  <SHORT_DESCRIPTION name="umf_luget"> retrieve lu factors at the scilab level  </SHORT_DESCRIPTION>
+  
+  
+  
+  
+  
 
-  <CALLING_SEQUENCE>
-      <CALLING_SEQUENCE_ITEM>[L,U,p,q,Rd] = umf_luget(LU_ptr)  </CALLING_SEQUENCE_ITEM>
-  </CALLING_SEQUENCE>
+  <refsynopsisdiv><title>Calling Sequence</title><synopsis>[L,U,p,q,Rd] = umf_luget(LU_ptr)</synopsis></refsynopsisdiv>
   
-  <PARAM>
-     <PARAM_INDENT>
-     <PARAM_ITEM>
-        <PARAM_NAME>LU_ptr  </PARAM_NAME>
-        <PARAM_DESCRIPTION>
-           : a pointer to umf lu factors (L,U,p,q,R)
-       </PARAM_DESCRIPTION> 
-     </PARAM_ITEM>
-     <PARAM_ITEM>
-        <PARAM_NAME>L,U  </PARAM_NAME>
-        <PARAM_DESCRIPTION>
-           : scilab sparse matrix
-        </PARAM_DESCRIPTION> 
-     </PARAM_ITEM>
-     <PARAM_ITEM>
-        <PARAM_NAME>p,q  </PARAM_NAME>
-        <PARAM_DESCRIPTION>
-           : column vectors storing the permutations
-        </PARAM_DESCRIPTION> 
-     </PARAM_ITEM>
-     <PARAM_ITEM>
-        <PARAM_NAME>Rd </PARAM_NAME>
-        <PARAM_DESCRIPTION>
-           : vector storing the (row) scaling factors
-        </PARAM_DESCRIPTION> 
-     </PARAM_ITEM>
-     </PARAM_INDENT>
-  </PARAM>
+  <refsection><title>Parameters</title>
+     <variablelist>
+     <varlistentry>
+        <term>LU_ptr  </term>
+        <listitem>
+                       <para>a pointer to umf lu factors (L,U,p,q,R)</para>
+       </listitem> 
+     </varlistentry>
+     <varlistentry>
+        <term>L,U  </term>
+        <listitem>
+                       <para>scilab sparse matrix</para>
+        </listitem> 
+     </varlistentry>
+     <varlistentry>
+        <term>p,q  </term>
+        <listitem>
+                       <para>column vectors storing the permutations</para>
+        </listitem> 
+     </varlistentry>
+     <varlistentry>
+        <term>Rd </term>
+        <listitem>
+                       <para>vector storing the (row) scaling factors</para>
+        </listitem> 
+     </varlistentry>
+     </variablelist>
+  </refsection>
 
-  <DESCRIPTION>
-  <P>
+  <refsection><title>Description</title>
+  <para>
     This function  may be used if you want  to plot  the sparse
     pattern  of the lu factors (or if you  code something which
     use the lu factors). The factorization provided by umfpack is
     of the form:
-  </P> 
-  <P>
+  </para> 
+  <para>
        P R^(-1) A Q = LU
-  </P> 
-  <P>
+  </para> 
+  <para>
     where P and Q are permutation matrices, R is a diagonal matrix (row scaling), L
     a lower triangular matrix with a diagonal of 1, and U an upper triangular matrix.
     The function provides the matrices L and U as Sparse scilab matrices but
     P and Q are given as permutation vectors p and q (in fact p is the permutation 
-    associated to P&apos;) and Rd is the vector corresponding to the diagonal
+    associated to P') and Rd is the vector corresponding to the diagonal
     of R.
-  </P>
-  </DESCRIPTION>
+  </para>
+  </refsection>
 
-  <EXAMPLE><![CDATA[
+  <refsection><title>Examples</title><programlisting role="example"><![CDATA[
 // this is the test matrix from UMFPACK
 A = sparse( [ 2  3  0  0  0;
               3  0  4  0  6; 
@@ -91,19 +86,19 @@ B(p,q) - L*U  // must be a (quasi) nul matrix
 
 umf_ludel(Lup) // clear memory
 
- ]]></EXAMPLE>
+ ]]></programlisting></refsection>
 
-  <SEE_ALSO>
-    <SEE_ALSO_ITEM> <LINK>umfpack</LINK> </SEE_ALSO_ITEM>     
-    <SEE_ALSO_ITEM> <LINK>umf_lufact</LINK> </SEE_ALSO_ITEM>     
-    <SEE_ALSO_ITEM> <LINK>umf_lusolve</LINK> </SEE_ALSO_ITEM>     
-    <SEE_ALSO_ITEM> <LINK>umf_ludel</LINK> </SEE_ALSO_ITEM>     
-    <SEE_ALSO_ITEM> <LINK>umf_luinfo</LINK> </SEE_ALSO_ITEM>
-  </SEE_ALSO>
+  <refsection><title>See Also</title><simplelist type="inline">
+    <member> <link linkend="umfpack">umfpack</link> </member>     
+    <member> <link linkend="umf_lufact">umf_lufact</link> </member>     
+    <member> <link linkend="umf_lusolve">umf_lusolve</link> </member>     
+    <member> <link linkend="umf_ludel">umf_ludel</link> </member>     
+    <member> <link linkend="umf_luinfo">umf_luinfo</link> </member>
+  </simplelist></refsection>
 
-  <AUTHORS>
-      <AUTHORS_ITEM><EM>umfpack</EM> by Timothy A. Davis (see <LINK>umf_license</LINK>)</AUTHORS_ITEM>
-      <AUTHORS_ITEM><EM>scilab interface</EM> by Bruno Pincon</AUTHORS_ITEM>
-  </AUTHORS>
+  <refsection><title>Authors</title><simplelist type="vert">
+      <member>umfpack by Timothy A. Davis (see umf_license)</member>
+      <member>scilab interface by Bruno Pincon</member>
+  </simplelist></refsection>
 
-</MAN>
+</refentry>
\ No newline at end of file
index 941ca41..542acbe 100644 (file)
@@ -1,81 +1,76 @@
-<?xml version="1.0" encoding="ISO-8859-1" standalone="no"?> 
-<!DOCTYPE MAN SYSTEM "manrev.dtd">
+<?xml version="1.0" encoding="ISO-8859-1"?><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_luinfo"><info><pubdate>  </pubdate></info><refnamediv><refname>  umf_luinfo </refname><refpurpose>  get information on LU factors  </refpurpose></refnamediv>
 
-<MAN>
+  
+  
+  
+  
+  
 
-  <LANGUAGE>eng</LANGUAGE>
-  <TITLE>umf_luinfo  </TITLE>
-  <TYPE>scilab function - scispt toolbox</TYPE>
-  <DATE>  </DATE>
-  <SHORT_DESCRIPTION name="  umf_luinfo ">  get information on LU factors  </SHORT_DESCRIPTION>
+  <refsynopsisdiv><title>Calling Sequence</title><synopsis>[OK, nrow, ncol, lnz, unz, udiag_nz, it] = umf_luinfo(LU_ptr)</synopsis></refsynopsisdiv>
 
-  <CALLING_SEQUENCE>
-     <CALLING_SEQUENCE_ITEM>[OK, nrow, ncol, lnz, unz, udiag_nz, it] = umf_luinfo(LU_ptr)  </CALLING_SEQUENCE_ITEM>
-  </CALLING_SEQUENCE>
+  <refsection><title>Parameters</title>
+     <variablelist>
+     <varlistentry>
+        <term>LU_ptr  </term>
+        <listitem>
+                       <para>a pointer to umf lu factors (L,U,p,q, R)</para>
+        </listitem> 
+     </varlistentry>
+     <varlistentry>
+        <term>OK  </term>
+        <listitem>
+                       <para>a scalar boolean</para>
+        </listitem> 
+     </varlistentry>
+     <varlistentry>
+        <term>nrow, ncol, lnz, unz, udiag_nz, it</term>
+        <listitem>
+                       <para>scalars (integers)</para>
+        </listitem> 
+     </varlistentry>
+     </variablelist>
+  </refsection>
 
-  <PARAM>
-     <PARAM_INDENT>
-     <PARAM_ITEM>
-        <PARAM_NAME>LU_ptr  </PARAM_NAME>
-        <PARAM_DESCRIPTION>
-           : a pointer to umf lu factors (L,U,p,q, R)
-        </PARAM_DESCRIPTION> 
-     </PARAM_ITEM>
-     <PARAM_ITEM>
-        <PARAM_NAME>OK  </PARAM_NAME>
-        <PARAM_DESCRIPTION>
-           : a scalar boolean
-        </PARAM_DESCRIPTION> 
-     </PARAM_ITEM>
-     <PARAM_ITEM>
-        <PARAM_NAME>nrow, ncol, lnz, unz, udiag_nz, it</PARAM_NAME>
-        <PARAM_DESCRIPTION>
-           : scalars (integers)
-        </PARAM_DESCRIPTION> 
-     </PARAM_ITEM>
-     </PARAM_INDENT>
-  </PARAM>
-
-  <DESCRIPTION>
-  <P>
+  <refsection><title>Description</title>
+  <para>
     This function may be used to know basic information about 
     LU factors created with umf_lufact :
-  </P>
-  <P>
-    first <VERB>OK</VERB> is %t if <VERB>LU_ptr</VERB> is a valid pointer to an umfpack 
+  </para>
+  <para>
+    first <literal>OK</literal> is %t if <literal>LU_ptr</literal> is a valid pointer to an umfpack 
     LU numeric handle (and %f else)
-  </P>
-  <P>
-    if <VERB>OK</VERB> is %t then: 
-  </P>
-    <ITEMIZE>
-      <ITEM label="nrow, ncol">
-        <SP>: are the matrix size (L is <TT>nrow x n</TT> and U is  <TT>n x ncol</TT>
-              where <TT>n = min(nrow,ncol)</TT>
-        </SP>
-      </ITEM>
-      <ITEM label="lnz, unz">
-        <SP>: are the number of non zeros elements in L and in U;
-        </SP>
-      </ITEM>
-      <ITEM label="udiag_nz">
-        <SP>: are the number of non zeros elements on the diagonal of U; if the matrix
-              is square (<TT>nrow = ncol = n)</TT> then it is not inversible if 
+  </para>
+  <para>
+    if <literal>OK</literal> is %t then: 
+  </para>
+    <variablelist>
+      <varlistentry><term>nrow, ncol</term><listitem>
+        <para>are the matrix size (L is <literal>nrow x n</literal> and U is  <literal>n x ncol</literal>
+              where <literal>n = min(nrow,ncol)</literal>
+        </para>
+      </listitem></varlistentry>
+      <varlistentry><term>lnz, unz</term><listitem>
+        <para>are the number of non zeros elements in L and in U;
+        </para>
+      </listitem></varlistentry>
+      <varlistentry><term>udiag_nz</term><listitem>
+        <para>are the number of non zeros elements on the diagonal of U; if the matrix
+              is square (<literal>nrow = ncol = n)</literal> then it is not inversible if 
               udiag_nz &lt; n (more precisely it appears to be numericaly not
               inversible through the LU factorization).
-        </SP>
-      </ITEM>
-      <ITEM label="it">
-        <SP>: 0 if the factors are real and 1 if they are complex.
-        </SP>
-      </ITEM>
-    </ITEMIZE>
-    <P>
+        </para>
+      </listitem></varlistentry>
+      <varlistentry><term>it</term><listitem>
+        <para>0 if the factors are real and 1 if they are complex.
+        </para>
+      </listitem></varlistentry>
+    </variablelist>
+    <para>
     if OK is %f then all the others outputs are set to the empty matrix [].
-    </P>
-  </DESCRIPTION>
+    </para>
+  </refsection>
 
-  <EXAMPLE><![CDATA[
+  <refsection><title>Examples</title><programlisting role="example"><![CDATA[
 // this is the test matrix from UMFPACK
 A = sparse( [ 2  3  0  0  0;
               3  0  4  0  6; 
@@ -88,19 +83,19 @@ Lup = umf_lufact(A);
 nnz(L)  // must be equal to lnz
 nnz(U)  // must be equal to unz
 umf_ludel(Lup) // clear memory
-   ]]></EXAMPLE>
+   ]]></programlisting></refsection>
 
-  <SEE_ALSO>
-    <SEE_ALSO_ITEM> <LINK>umfpack</LINK> </SEE_ALSO_ITEM>     
-    <SEE_ALSO_ITEM> <LINK>umf_lufact</LINK> </SEE_ALSO_ITEM>     
-    <SEE_ALSO_ITEM> <LINK>umf_lusolve</LINK> </SEE_ALSO_ITEM>     
-    <SEE_ALSO_ITEM> <LINK>umf_ludel</LINK> </SEE_ALSO_ITEM>     
-    <SEE_ALSO_ITEM> <LINK>umf_luget</LINK> </SEE_ALSO_ITEM>
-  </SEE_ALSO>
+  <refsection><title>See Also</title><simplelist type="inline">
+    <member> <link linkend="umfpack">umfpack</link> </member>     
+    <member> <link linkend="umf_lufact">umf_lufact</link> </member>     
+    <member> <link linkend="umf_lusolve">umf_lusolve</link> </member>     
+    <member> <link linkend="umf_ludel">umf_ludel</link> </member>     
+    <member> <link linkend="umf_luget">umf_luget</link> </member>
+  </simplelist></refsection>
 
-  <AUTHORS>
-      <AUTHORS_ITEM><EM>umfpack</EM> by Timothy A. Davis (see <LINK>umf_license</LINK>)</AUTHORS_ITEM>
-      <AUTHORS_ITEM><EM>scilab interface</EM> by Bruno Pincon</AUTHORS_ITEM>
-  </AUTHORS>
+  <refsection><title>Authors</title><simplelist type="vert">
+      <member>umfpack by Timothy A. Davis (see umf_license)</member>
+      <member>scilab interface by Bruno Pincon</member>
+  </simplelist></refsection>
 
-</MAN>
+</refentry>
\ No newline at end of file
index c9cfc82..bf29aeb 100644 (file)
@@ -1,77 +1,73 @@
-<?xml version="1.0" encoding="ISO-8859-1" standalone="no"?> 
-<!DOCTYPE MAN SYSTEM "manrev.dtd">
-<MAN>
-  <LANGUAGE>eng</LANGUAGE>
-  <TITLE>umf_lusolve  </TITLE>
-  <TYPE>Scilab function - scispt toolbox</TYPE>
-  <DATE></DATE>
-  <SHORT_DESCRIPTION name="umf_lusolve"> solve a linear sparse system given the LU factors  </SHORT_DESCRIPTION>
-  <CALLING_SEQUENCE>
-  <CALLING_SEQUENCE_ITEM>[x] = umf_lusolve(LU_ptr, b [, st, A])  </CALLING_SEQUENCE_ITEM>
-  </CALLING_SEQUENCE>
-  <PARAM>
- <PARAM_INDENT>
-  <PARAM_ITEM>
-  <PARAM_NAME>LU_ptr  </PARAM_NAME>
-  <PARAM_DESCRIPTION>
-    : a pointer to umf lu factors (L,U,p,q,R) 
-  </PARAM_DESCRIPTION> 
-  </PARAM_ITEM>
-  <PARAM_ITEM>
-  <PARAM_NAME>b  </PARAM_NAME>
-  <PARAM_DESCRIPTION>
-    : a real or complex column vector or a matrix (multiple rhs)
-  </PARAM_DESCRIPTION> 
-  </PARAM_ITEM>
-  <PARAM_ITEM>
-  <PARAM_NAME>st  </PARAM_NAME>
-  <PARAM_DESCRIPTION>
-    : (optional) a string &quot;Ax=b&quot; (default) or &quot;Ax&apos;=b&quot; 
-      (to be written &quot;Ax&apos;&apos;=b&quot;  in scilab langage: a quote in a string
-       must be doubled !)
-  </PARAM_DESCRIPTION> 
-  </PARAM_ITEM>
-  <PARAM_ITEM>
-  <PARAM_NAME>A  </PARAM_NAME>
-  <PARAM_DESCRIPTION>
-    : (optional) the sparse square matrix corresponding to the LU factors (LU_ptr must be got with LU_ptr = umf_lufact(A))
-  </PARAM_DESCRIPTION> 
-  </PARAM_ITEM>
-  <PARAM_ITEM>
-  <PARAM_NAME>x  </PARAM_NAME>
-  <PARAM_DESCRIPTION>
-    : a column vector or a matrix in case of multiple rhs ( x(:,i) is solution of A x(:,i) = b(:,i) or A&apos;x(:,i) = b(:,i) )
-  </PARAM_DESCRIPTION> 
-  </PARAM_ITEM>
- </PARAM_INDENT>
-  </PARAM>
-  <DESCRIPTION>
-  <P>
-    This function must be used in conjonction with <LINK>umf_lufact</LINK> which
+<?xml version="1.0" encoding="ISO-8859-1"?><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"><info><pubdate/></info><refnamediv><refname>umf_lusolve</refname><refpurpose> solve a linear sparse system given the LU factors  </refpurpose></refnamediv>
+  
+  
+  
+  
+  
+  <refsynopsisdiv><title>Calling Sequence</title><synopsis>[x] = umf_lusolve(LU_ptr, b [, st, A])</synopsis></refsynopsisdiv>
+  <refsection><title>Parameters</title>
+ <variablelist>
+  <varlistentry>
+  <term>LU_ptr  </term>
+  <listitem>
+         <para>a pointer to umf lu factors (L,U,p,q,R) </para>
+  </listitem> 
+  </varlistentry>
+  <varlistentry>
+  <term>b  </term>
+  <listitem>
+         <para>a real or complex column vector or a matrix (multiple rhs)</para>
+  </listitem> 
+  </varlistentry>
+  <varlistentry>
+  <term>st  </term>
+  <listitem>
+         <para>(optional) a string "Ax=b" (default) or "Ax'=b" 
+      (to be written "Ax''=b"  in scilab langage: a quote in a string
+         must be doubled !)</para>
+  </listitem> 
+  </varlistentry>
+  <varlistentry>
+  <term>A  </term>
+  <listitem>
+         <para>(optional) the sparse square matrix corresponding to the LU factors (LU_ptr must be got with LU_ptr = umf_lufact(A))</para>
+  </listitem> 
+  </varlistentry>
+  <varlistentry>
+  <term>x  </term>
+  <listitem>
+         <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>
+  </listitem> 
+  </varlistentry>
+ </variablelist>
+  </refsection>
+  <refsection><title>Description</title>
+  <para>
+    This function must be used in conjonction with <link linkend="umf_lufact">umf_lufact</link> which
     computes the LU factors of a sparse matrix. The optional
-    <VERB>st</VERB> argument lets us choose between the solving of Ax=b (general case)
-    or of A&apos;x=b (sometimes useful). If you give the 4th argument then
+    <literal>st</literal> argument lets us choose between the solving of Ax=b (general case)
+    or of A'x=b (sometimes useful). If you give the 4th argument then
     iterative refinement will be also proceceed (as in umfpack) to
     give a better numerical solution. 
-  </P>
-  </DESCRIPTION>
-  <SECTION label='Examples'>
-  <P>
-    see the example section of <LINK>umf_lufact</LINK>
-  </P>
-  </SECTION>
+  </para>
+  </refsection>
+  <refsection><title>Examples</title>
+  <para>
+    see the example section of <link linkend="umf_lufact">umf_lufact</link>
+  </para>
+  </refsection>
 
-  <SEE_ALSO>
-    <SEE_ALSO_ITEM> <LINK>umfpack</LINK> </SEE_ALSO_ITEM>     
-    <SEE_ALSO_ITEM> <LINK>umf_lufact</LINK> </SEE_ALSO_ITEM>     
-    <SEE_ALSO_ITEM> <LINK>umf_luget</LINK> </SEE_ALSO_ITEM>     
-    <SEE_ALSO_ITEM> <LINK>umf_ludel</LINK> </SEE_ALSO_ITEM>     
-    <SEE_ALSO_ITEM> <LINK>umf_luinfo</LINK> </SEE_ALSO_ITEM>
-  </SEE_ALSO>
+  <refsection><title>See Also</title><simplelist type="inline">
+    <member> <link linkend="umfpack">umfpack</link> </member>     
+    <member> <link linkend="umf_lufact">umf_lufact</link> </member>     
+    <member> <link linkend="umf_luget">umf_luget</link> </member>     
+    <member> <link linkend="umf_ludel">umf_ludel</link> </member>     
+    <member> <link linkend="umf_luinfo">umf_luinfo</link> </member>
+  </simplelist></refsection>
 
-  <AUTHORS>
-      <AUTHORS_ITEM><EM>umfpack</EM> by Timothy A. Davis (see <LINK>umf_license</LINK>)</AUTHORS_ITEM>
-      <AUTHORS_ITEM><EM>scilab interface</EM> by Bruno Pincon with contributions from Antonio Frasson</AUTHORS_ITEM>
-  </AUTHORS>
+  <refsection><title>Authors</title><simplelist type="vert">
+      <member>umfpack by Timothy A. Davis (see umf_license)</member>
+      <member>scilab interface by Bruno Pincon with contributions from Antonio Frasson</member>
+  </simplelist></refsection>
 
-</MAN>
+</refentry>
\ No newline at end of file
index 4f671d0..714265e 100644 (file)
@@ -1,64 +1,60 @@
-<?xml version="1.0" encoding="ISO-8859-1" standalone="no"?> 
-<!DOCTYPE MAN SYSTEM "manrev.dtd">
-<MAN>
-  <LANGUAGE>eng</LANGUAGE>
-  <TITLE>umfpack  </TITLE>
-  <TYPE>scilab function - scispt toolbox</TYPE>
-  <DATE></DATE>
-  <SHORT_DESCRIPTION name="umfpack"> solve sparse linear system  </SHORT_DESCRIPTION>
-  <CALLING_SEQUENCE>
-  <CALLING_SEQUENCE_ITEM>x = umfpack(A,&quot;\&quot;,b)  </CALLING_SEQUENCE_ITEM>
-  <CALLING_SEQUENCE_ITEM>x = umfpack(b,&quot;/&quot;,A)  </CALLING_SEQUENCE_ITEM>
-  </CALLING_SEQUENCE>
-  <PARAM>
- <PARAM_INDENT>
-  <PARAM_ITEM>
-  <PARAM_NAME>A  </PARAM_NAME>
-  <PARAM_DESCRIPTION>
-    : a sparse (real or complex) square matrix n x n
-  </PARAM_DESCRIPTION> 
-  </PARAM_ITEM>
-  <PARAM_ITEM>
-  <PARAM_NAME>b  </PARAM_NAME>
-  <PARAM_DESCRIPTION>
-    : in the first case, a column vector (n x 1) or a n x m matrix ;    
-      in the second case, a row vector (1 x n) or a m x n matrix
-  </PARAM_DESCRIPTION> 
-  </PARAM_ITEM>
-  <PARAM_ITEM>
-  <PARAM_NAME>x  </PARAM_NAME>
-  <PARAM_DESCRIPTION>
-    : in the first case , a column vector (n x 1) or a n x m matrix ;    
-      in the second case, a row vector (1 x n) or a m x n matrix
-  </PARAM_DESCRIPTION> 
-  </PARAM_ITEM>
-  <PARAM_ITEM>
-  <PARAM_NAME>2d arg  </PARAM_NAME>
-  <PARAM_DESCRIPTION>
-    : string specifier &quot;\&quot; or &quot;/&quot;
-  </PARAM_DESCRIPTION> 
-  </PARAM_ITEM>
- </PARAM_INDENT>
-  </PARAM>
-  <DESCRIPTION>
-  <P>
+<?xml version="1.0" encoding="ISO-8859-1"?><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="umfpack"><info><pubdate/></info><refnamediv><refname>umfpack</refname><refpurpose> solve sparse linear system  </refpurpose></refnamediv>
+  
+  
+  
+  
+  
+  <refsynopsisdiv><title>Calling Sequence</title><synopsis>x = umfpack(A,"\",b)
+x = umfpack(b,"/",A)</synopsis></refsynopsisdiv>
+  <refsection><title>Parameters</title>
+ <variablelist>
+  <varlistentry>
+  <term>A  </term>
+  <listitem>
+    <para>a sparse (real or complex) square matrix n x n</para>
+  </listitem> 
+  </varlistentry>
+  <varlistentry>
+  <term>b  </term>
+  <listitem>
+         <para>in the first case, a column vector (n x 1) or a n x m matrix ;    
+                 in the second case, a row vector (1 x n) or a m x n matrix</para>
+  </listitem> 
+  </varlistentry>
+  <varlistentry>
+  <term>x  </term>
+  <listitem>
+         <para>in the first case , a column vector (n x 1) or a n x m matrix ;    
+                 in the second case, a row vector (1 x n) or a m x n matrix</para>
+  </listitem> 
+  </varlistentry>
+  <varlistentry>
+  <term>2d arg  </term>
+  <listitem>
+         <para>string specifier "\" or "/"</para>
+  </listitem> 
+  </varlistentry>
+ </variablelist>
+  </refsection>
+  <refsection><title>Description</title>
+  <para>
     This function is intended to work like the classic operators \ and / 
     x = A\b  and x = b/A) i.e. it solves a linear system Ax = b or xA = b 
     with a sparse square (says n x n) real or complex matrix and with a compatible
     rhs b : n x m in the first case and m x n in the second. 
-  </P>
-  </DESCRIPTION>
-  <SECTION label='Details'>
-  <P>
-    First an LU factorisation of the matrix is computed (<TT> P R^(-1) A Q = LU </TT>
+  </para>
+  </refsection>
+  <refsection><title>Details</title>
+  <para>
+    First an LU factorisation of the matrix is computed (<literal> P R^(-1) A Q = LU </literal>
     where P and Q are permutation matrices, R is a diagonal matrix (row scaling), L
     a lower triangular matrix with a diagonal of 1, and U an upper triangular matrix) 
     then a first solution is computed with forward/backward subtitutions ; 
     finaly the solution is improved  by iterative refinement.
-  </P>
-  </SECTION>
+  </para>
+  </refsection>
 
-  <EXAMPLE><![CDATA[
+  <refsection><title>Examples</title><programlisting role="example"><![CDATA[
 // this is the small linear test system from UMFPACK
 // whom solution must be [1;2;3;4;5]
 A = sparse( [ 2  3  0  0  0;
@@ -91,18 +87,18 @@ A = sparse( [ 2+%i  3+2*%i  0      0    0;
               0     4       2-%i   0    1] );
 b = [ 3+13*%i ; 58+32*%i ; -19+13*%i ; 18-12*%i ; 22+16*%i ];
 x = umfpack(A,"\",b)  // x must be [1+i; 2+2i; 3+3i; 4 + 4i; 5+5i]
-   ]]></EXAMPLE>
+   ]]></programlisting></refsection>
 
-  <SEE_ALSO>
-    <SEE_ALSO_ITEM> <LINK>umf_lufact</LINK> </SEE_ALSO_ITEM>     
-    <SEE_ALSO_ITEM> <LINK>umf_lusolve</LINK> </SEE_ALSO_ITEM>     
-    <SEE_ALSO_ITEM> <LINK>umf_ludel</LINK> </SEE_ALSO_ITEM>     
-    <SEE_ALSO_ITEM> <LINK>umf_luinfo</LINK> </SEE_ALSO_ITEM>     
-    <SEE_ALSO_ITEM> <LINK>umf_luget</LINK> </SEE_ALSO_ITEM>
-  </SEE_ALSO>
+  <refsection><title>See Also</title><simplelist type="inline">
+    <member> <link linkend="umf_lufact">umf_lufact</link> </member>     
+    <member> <link linkend="umf_lusolve">umf_lusolve</link> </member>     
+    <member> <link linkend="umf_ludel">umf_ludel</link> </member>     
+    <member> <link linkend="umf_luinfo">umf_luinfo</link> </member>     
+    <member> <link linkend="umf_luget">umf_luget</link> </member>
+  </simplelist></refsection>
 
-  <AUTHORS>
-      <AUTHORS_ITEM><EM>umfpack</EM> by Timothy A. Davis (see <LINK>umf_license</LINK>)</AUTHORS_ITEM>
-      <AUTHORS_ITEM><EM>scilab interface</EM> by Bruno Pincon with contributions from Antonio Frasson</AUTHORS_ITEM>
-  </AUTHORS>
-</MAN>
+  <refsection><title>Authors</title><simplelist type="vert">
+      <member>umfpack by Timothy A. Davis (see umf_license)</member>
+      <member>scilab interface by Bruno Pincon with contributions from Antonio Frasson</member>
+  </simplelist></refsection>
+</refentry>
\ No newline at end of file