fix links
Allan Cornet [Tue, 12 Aug 2008 10:07:23 +0000 (10:07 +0000)]
scilab/modules/fftw/help/en_US/fftw.xml
scilab/modules/fftw/help/en_US/fftw_flags.xml
scilab/modules/fftw/help/fr_FR/fftw.xml
scilab/modules/umfpack/help/en_US/ReadHBSparse.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_lufact.xml
scilab/modules/umfpack/help/en_US/umf_lusolve.xml

index 3df1cb0..748a79b 100644 (file)
@@ -1,4 +1,4 @@
-<?xml version="1.0" encoding="ISO-8859-1"?>
+<?xml version="1.0" encoding="UTF-8"?>
 <!--
  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
  * Copyright (C) 2007 - INRIA
  * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
  *
  -->
-<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="fftw">
+<refentry version="5.0-subset Scilab" xml:id="fftw" xml:lang="en"
+          xmlns="http://docbook.org/ns/docbook"
+          xmlns:xlink="http://www.w3.org/1999/xlink"
+          xmlns:svg="http://www.w3.org/2000/svg"
+          xmlns:ns3="http://www.w3.org/1999/xhtml"
+          xmlns:mml="http://www.w3.org/1998/Math/MathML"
+          xmlns:db="http://docbook.org/ns/docbook">
   <info>
     <pubdate>October 2006</pubdate>
   </info>
+
   <refnamediv>
     <refname>fftw</refname>
+
     <refpurpose>fast fourier transform that use fftw library</refpurpose>
   </refnamediv>
+
   <refsynopsisdiv>
     <title>Calling Sequence</title>
+
     <synopsis>[y]=fftw(x)
 [y]=fftw(x,sign)
 [y]=fftw(x,sign,dim,incr)
 [y]=fftw(x,sign,[dim1 dim2 ...dimN],[incr1 incr2 ...incrN])</synopsis>
   </refsynopsisdiv>
+
   <refsection>
     <title>Parameters</title>
+
     <variablelist>
       <varlistentry>
         <term>y,x</term>
+
         <listitem>
-          <para>matrix/vector of real/complex data. Input/output data to be transformed.</para>
+          <para>matrix/vector of real/complex data. Input/output data to be
+          transformed.</para>
         </listitem>
       </varlistentry>
+
       <varlistentry>
         <term>sign</term>
+
         <listitem>
           <para>Integer. 1 or -1. Set direct or inverse transform.</para>
         </listitem>
       </varlistentry>
+
       <varlistentry>
         <term>dim</term>
+
         <listitem>
-          <para>integer. Set the dimension (the length) of the transform.</para>
+          <para>integer. Set the dimension (the length) of the
+          transform.</para>
         </listitem>
       </varlistentry>
+
       <varlistentry>
         <term>incr</term>
+
         <listitem>
           <para>integer. Set the stride (the span) of the transform.</para>
         </listitem>
       </varlistentry>
     </variablelist>
   </refsection>
+
   <refsection>
     <title>Description</title>
-    <para>
-    This function realizes direct/inverse Discrete Fourier Transform (DFT) with the help of the FFTW library.
-    </para>
-    <para>
-    One can compute vector, 2D, M-D transform with this function.
-    </para>
-    <para>
-    For more details of fftw syntax see <link xlink:href="fft.htm"><literal>fft</literal></link> scilab function.
-    </para>
-    <para>
-    For more details about FFTW library see FFTW Web site :<link xlink:href="http://www.fftw.org"><literal> http://www.fftw.org </literal>.</link>
-    </para>
-    <para>
-    Remark : fftw function automaticaly stores his last parameters in memory to re-use it in a second time.
-    </para>
-    <para>
-    This results on a time computation improvement when consecutives calls (with same parameters) are used.
+
+    <para>This function realizes direct/inverse Discrete Fourier Transform
+    (DFT) with the help of the FFTW library.</para>
+
+    <para>One can compute vector, 2D, M-D transform with this function.</para>
+
+    <para>For more details of fftw syntax see <link linkend='fft'>fft</link> scilab function.</para> 
+
+    <para>For more details about FFTW library see FFTW Web site : <link linkend='http://www.fftw.org'>http://www.fftw.org</link>
     </para>
+
+    <para>Remark : fftw function automaticaly stores his last parameters in
+    memory to re-use it in a second time.</para>
+
+    <para>This results on a time computation improvement when consecutives
+    calls (with same parameters) are used.</para>
   </refsection>
+
   <refsection>
     <title>Examples</title>
-    <programlisting role="example"><![CDATA[
+
+    <programlisting role="example">
   
   //simple vector direct transform
   a = rand(50,1)+%i*rand(50,1);
   y = fftw(a,-1,[5 6 4],[1 5 30]);
   b = fftw(y,1,[5 6 4],[1 5 30]);
   
-  ]]></programlisting>
+  </programlisting>
   </refsection>
+
   <refsection>
     <title>See Also</title>
+
     <simplelist type="inline">
-      <member>
-        <link linkend="fftw_flags">fftw_flags</link>
-      </member>
-      <member>
-        <link linkend="get_fftw_wisdom">get_fftw_wisdom</link>
-      </member>
-      <member>
-        <link linkend="set_fftw_wisdom">set_fftw_wisdom</link>
-      </member>
-      <member>
-        <link linkend="fftw_forget_wisdom">fftw_forget_wisdom</link>
-      </member>
+      <member><link linkend="fftw_flags">fftw_flags</link></member>
+
+      <member><link linkend="get_fftw_wisdom">get_fftw_wisdom</link></member>
+
+      <member><link linkend="set_fftw_wisdom">set_fftw_wisdom</link></member>
+
+      <member><link
+      linkend="fftw_forget_wisdom">fftw_forget_wisdom</link></member>
     </simplelist>
   </refsection>
+
   <refsection>
     <title>Bibliography</title>
-    <para>
-    Matteo Frigo and Steven G. Johnson, "FFTW Manual fo version 3.1.2" June 2006. Available : http://www.fftw.org
-    </para>
+
+    <para>Matteo Frigo and Steven G. Johnson, "FFTW Manual fo version 3.1.2"
+    June 2006. Available : http://www.fftw.org</para>
   </refsection>
-</refentry>
+</refentry>
\ No newline at end of file
index e225ae4..3d57fd7 100644 (file)
@@ -1,4 +1,4 @@
-<?xml version="1.0" encoding="ISO-8859-1"?>
+<?xml version="1.0" encoding="UTF-8"?>
 <!--
  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
  * Copyright (C) 2007 - INRIA
  * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
  *
  -->
-<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="fftw_flags">
+<refentry version="5.0-subset Scilab" xml:id="fftw_flags" xml:lang="en"
+          xmlns="http://docbook.org/ns/docbook"
+          xmlns:xlink="http://www.w3.org/1999/xlink"
+          xmlns:svg="http://www.w3.org/2000/svg"
+          xmlns:ns4="http://www.w3.org/1999/xhtml"
+          xmlns:mml="http://www.w3.org/1998/Math/MathML"
+          xmlns:db="http://docbook.org/ns/docbook">
   <info>
     <pubdate>October 2006</pubdate>
   </info>
+
   <refnamediv>
     <refname>fftw_flags</refname>
-    <refpurpose> set computation method of fast fourier transform of the fftw function</refpurpose>
+
+    <refpurpose>set computation method of fast fourier transform of the fftw
+    function</refpurpose>
   </refnamediv>
+
   <refsynopsisdiv>
     <title>Calling Sequence</title>
+
     <synopsis>[a,[S]]=fftw_flags([x1;x2;...])</synopsis>
   </refsynopsisdiv>
+
   <refsection>
     <title>Parameters</title>
+
     <variablelist>
       <varlistentry>
         <term>[x1;x2;...]</term>
+
         <listitem>
-          <para>Matrix of string or integers. Entry to switch the method of fft computation for fftw.</para>
+          <para>Matrix of string or integers. Entry to switch the method of
+          fft computation for fftw.</para>
         </listitem>
       </varlistentry>
+
       <varlistentry>
         <term>a</term>
+
         <listitem>
-          <para>Integer. Give the current value of the flag of the fftw function.</para>
+          <para>Integer. Give the current value of the flag of the fftw
+          function.</para>
         </listitem>
       </varlistentry>
+
       <varlistentry>
         <term>S</term>
+
         <listitem>
           <para>String matrix. Give the string value of the fftw flag.</para>
         </listitem>
       </varlistentry>
     </variablelist>
   </refsection>
+
   <refsection>
     <title>Description</title>
-    <para>
-    This function enables the change of the <literal>unsigned flags</literal> parameter of the
-    <literal>fftw_plan_guru_split_dft</literal> function that is used in <link xlink:href="fftw.htm"><literal>fftw</literal></link> function. Default value is FFTW_ESTIMATE</para>
+
+    <para>This function enables the change of the <literal>unsigned
+    flags</literal> parameter of the
+    <literal>fftw_plan_guru_split_dft</literal> function that is used in <link
+    linkend="fftw">fftw</link> function. </para>
+
+    <para>Default value is FFTW_ESTIMATE</para>
+
     <para>Accepted entries are :</para>
+
     <itemizedlist>
       <listitem>
         <para>FFTW_MEASURE or 0</para>
       </listitem>
+
       <listitem>
         <para>FFTW_DESTROY_INPUT or 1</para>
       </listitem>
+
       <listitem>
         <para>FFTW_UNALIGNED or 2</para>
       </listitem>
+
       <listitem>
         <para>FFTW_CONSERVE_MEMORY or 4</para>
       </listitem>
+
       <listitem>
         <para>FFTW_EXHAUSTIVE or 8</para>
       </listitem>
+
       <listitem>
         <para>FFTW_PRESERVE_INPUT or 16</para>
       </listitem>
+
       <listitem>
         <para>FFTW_PATIENT or 32</para>
       </listitem>
+
       <listitem>
         <para>FFTW_ESTIMATE or 64</para>
       </listitem>
+
       <listitem>
         <para>FFTW_ESTIMATE_PATIENT or 128</para>
       </listitem>
+
       <listitem>
         <para>FFTW_BELIEVE_PCOST or 256</para>
       </listitem>
+
       <listitem>
         <para>FFTW_NO_DFT_R2HC or 512</para>
       </listitem>
+
       <listitem>
         <para>FFTW_NO_NONTHREADED or 1024</para>
       </listitem>
+
       <listitem>
         <para>FFTW_NO_BUFFERING or 2048</para>
       </listitem>
+
       <listitem>
         <para>FFTW_NO_INDIRECT_OP or 4096</para>
       </listitem>
+
       <listitem>
         <para>FFTW_ALLOW_LARGE_GENERIC or 8192</para>
       </listitem>
+
       <listitem>
         <para>FFTW_NO_RANK_SPLITS or 16384</para>
       </listitem>
+
       <listitem>
         <para>FFTW_NO_VRANK_SPLITS or 32768</para>
       </listitem>
+
       <listitem>
         <para>FFTW_NO_VRECURSE or 65536</para>
       </listitem>
+
       <listitem>
         <para>FFTW_NO_SIMD or 131072</para>
       </listitem>
+
       <listitem>
         <para>FFTW_NO_SLOW or 262144</para>
       </listitem>
+
       <listitem>
         <para>FFTW_NO_FIXED_RADIX_LARGE_N or 524288</para>
       </listitem>
+
       <listitem>
         <para>FFTW_ALLOW_PRUNING or 1048576</para>
       </listitem>
     </itemizedlist>
-    <para>
-     Rmk : when using FFTW_MEASURE/FFTW_PATIENT/FFTW_EXHAUSTIVE you must call two times fftw.
-     (first call for initialisation, second and others calls for computation)
-   </para>
+
+    <para>Rmk : when using FFTW_MEASURE/FFTW_PATIENT/FFTW_EXHAUSTIVE you must
+    call two times fftw. (first call for initialisation, second and others
+    calls for computation)</para>
   </refsection>
+
   <refsection>
     <title>Examples</title>
-    <programlisting role="example"><![CDATA[
+
+    <programlisting role="example">
 
  //return the integer value of the flag
  fftw_flags()
  //change flags and display current value of fftw flags (both integer and strings)
  [a,S]=fftw_flags("FFTW_PATIENT")
  
-  ]]></programlisting>
+  </programlisting>
   </refsection>
+
   <refsection>
     <title>See Also</title>
+
     <simplelist type="inline">
-      <member>
-        <link linkend="fftw">fftw</link>
-      </member>
+      <member><link linkend="fftw">fftw</link></member>
     </simplelist>
   </refsection>
-</refentry>
+</refentry>
\ No newline at end of file
index 99f2b3b..55f45e6 100644 (file)
-<?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="fr" xml:id="fftw">
+<?xml version="1.0" encoding="UTF-8"?>
+<refentry version="5.0-subset Scilab" xml:id="fftw" xml:lang="fr"
+          xmlns="http://docbook.org/ns/docbook"
+          xmlns:xlink="http://www.w3.org/1999/xlink"
+          xmlns:svg="http://www.w3.org/2000/svg"
+          xmlns:ns4="http://www.w3.org/1999/xhtml"
+          xmlns:mml="http://www.w3.org/1998/Math/MathML"
+          xmlns:db="http://docbook.org/ns/docbook">
   <info>
     <pubdate>October 2006</pubdate>
   </info>
+
   <refnamediv>
     <refname>fftw</refname>
-    <refpurpose>transformée de Fourier rapide qui utilise la librairie FFTW</refpurpose>
+
+    <refpurpose>transformée de Fourier rapide qui utilise la librairie
+    FFTW</refpurpose>
   </refnamediv>
+
   <refsynopsisdiv>
-    <title>Séquence d'appel</title>
+    <title>Séquence d'appel</title>
+
     <synopsis>[y]=fftw(x)
 [y]=fftw(x,sign)
 [y]=fftw(x,sign,dim,incr)
 [y]=fftw(x,sign,[dim1 dim2 ...dimN],[incr1 incr2 ...incrN])</synopsis>
   </refsynopsisdiv>
+
   <refsection>
-    <title>Paramètres</title>
+    <title>Paramètres</title>
+
     <variablelist>
       <varlistentry>
         <term>y,x</term>
+
         <listitem>
-          <para>matrice/vecteur de donnée réelle ou complexe. Données d'entrée/sortie.</para>
+          <para>matrice/vecteur de donnée réelle ou complexe. Données
+          d'entrée/sortie.</para>
         </listitem>
       </varlistentry>
+
       <varlistentry>
         <term>sign</term>
+
         <listitem>
-          <para>entier. 1 ou -1. Choix du type de transformée (inverse ou directe).</para>
+          <para>entier. 1 ou -1. Choix du type de transformée (inverse ou
+          directe).</para>
         </listitem>
       </varlistentry>
+
       <varlistentry>
         <term>dim</term>
+
         <listitem>
-          <para>entier. Donne la dimension (la longueur) de la transformée.</para>
+          <para>entier. Donne la dimension (la longueur) de la
+          transformée.</para>
         </listitem>
       </varlistentry>
+
       <varlistentry>
         <term>incr</term>
+
         <listitem>
-          <para>entier. Donne l'entrelacement (l'écart entre les données consécutives) de la transformée.</para>
+          <para>entier. Donne l'entrelacement (l'écart entre les données
+          consécutives) de la transformée.</para>
         </listitem>
       </varlistentry>
     </variablelist>
   </refsection>
+
   <refsection>
     <title>Description</title>
-    <para>
-    Cette fonction réalise une Transformée de Fourier Discrete (TFD) inverse ou directe au moyen de la libraire FFTW.
-    </para>
-    <para>
-    Elle permet le calcul de transformée vectorielle, 2D et M-D.
-    </para>
-    <para>
-    Pour plus de détails concernant la syntaxe de l'appel à fftw, consultez la fonction <link xlink:href="fft.htm"><literal>fft</literal></link> de scilab.
-    </para>
-    <para>
-    Pour plus de détails concernant la libraire FFW, consultez le site web <link xlink:href="http://www.fftw.org"><literal> http://www.fftw.org </literal></link>.
-    </para>
-    <para>
-    Rmq : La fonction ffw enregistre automatiquement les dernières paramètres utilisés lors d'un appel pour les ré-utiliser une seconde fois.
-    </para>
-    <para>
-    Cela permet une amélioration significative du temps de calcul lorsque la fonction fftw est appelée consécutivement avec les mêmes paramètres.
-    </para>
+
+    <para>Cette fonction réalise une Transformée de Fourier Discrete (TFD)
+    inverse ou directe au moyen de la libraire FFTW.</para>
+
+    <para>Elle permet le calcul de transformée vectorielle, 2D et M-D.</para>
+
+    <para>Pour plus de détails concernant la syntaxe de l'appel à fftw,
+    consultez la fonction <link linkend="fft">fft</link> de scilab.</para>
+
+    <para>Pour plus de détails concernant la libraire FFW, consultez le site
+    web <link linkend="http://www.fftw.org">http://www.fftw.org</link>.</para>
+
+    <para>Rmq : La fonction ffw enregistre automatiquement les dernières
+    paramètres utilisés lors d'un appel pour les ré-utiliser une seconde
+    fois.</para>
+
+    <para>Cela permet une amélioration significative du temps de calcul
+    lorsque la fonction fftw est appelée consécutivement avec les mêmes
+    paramètres.</para>
   </refsection>
+
   <refsection>
     <title>Exemples</title>
-    <programlisting role="example"><![CDATA[
+
+    <programlisting role="example">
   
-  //transformée 1D
+  //transformée 1D
   a = rand(50,1)+%i*rand(50,1);
   y = fftw(a);
   y = fftw(a,-1);
-  //transformée inverse
+  //transformée inverse
   b = fftw(y,1);
 
-  //transformée 2D
+  //transformée 2D
   a = rand(512,512)+%i*rand(512,512);
   y = fftw(a);
 
-  //transformée M-D -ancienne séquence d'appel-
+  //transformée M-D -ancienne séquence d'appel-
   a = rand(120,1);
   y = a;
   dim=[5 6 4];incr=[1 5 30];
     y = fftw(y,-1,dim(i),incr(i));
   end
 
-  //transformée M-D transform -nouvelle séquence d'appel-
+  //transformée M-D transform -nouvelle séquence d'appel-
   //plus performante que l'ancienne
   y = fftw(a,-1,[5 6 4],[1 5 30]);
   b = fftw(y,1,[5 6 4],[1 5 30]);
   
-  ]]></programlisting>
+  </programlisting>
   </refsection>
+
   <refsection>
     <title>Voir Aussi</title>
+
     <simplelist type="inline">
-      <member>
-        <link linkend="fftw_flags">fftw_flags</link>
-      </member>
-      <member>
-        <link linkend="get_fftw_wisdom">get_fftw_wisdom</link>
-      </member>
-      <member>
-        <link linkend="set_fftw_wisdom">set_fftw_wisdom</link>
-      </member>
-      <member>
-        <link linkend="fftw_forget_wisdom">fftw_forget_wisdom</link>
-      </member>
+      <member><link linkend="fftw_flags">fftw_flags</link></member>
+
+      <member><link linkend="get_fftw_wisdom">get_fftw_wisdom</link></member>
+
+      <member><link linkend="set_fftw_wisdom">set_fftw_wisdom</link></member>
+
+      <member><link
+      linkend="fftw_forget_wisdom">fftw_forget_wisdom</link></member>
     </simplelist>
   </refsection>
+
   <refsection>
     <title>Bibliographie</title>
-    <para>
-    Matteo Frigo and Steven G. Johnson, "FFTW Manual fo version 3.1.2" June 2006. Available : http://www.fftw.org
-    </para>
+
+    <para>Matteo Frigo and Steven G. Johnson, "FFTW Manual fo version 3.1.2"
+    June 2006. Available : http://www.fftw.org</para>
   </refsection>
-</refentry>
+</refentry>
\ No newline at end of file
index 5b96e64..71e9344 100644 (file)
-<?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="ReadHBSparse">
+<?xml version="1.0" encoding="UTF-8"?>
+<refentry version="5.0-subset Scilab" xml:id="ReadHBSparse" xml:lang="en"
+          xmlns="http://docbook.org/ns/docbook"
+          xmlns:xlink="http://www.w3.org/1999/xlink"
+          xmlns:svg="http://www.w3.org/2000/svg"
+          xmlns:ns4="http://www.w3.org/1999/xhtml"
+          xmlns:mml="http://www.w3.org/1998/Math/MathML"
+          xmlns:db="http://docbook.org/ns/docbook">
   <info>
-    <pubdate>  </pubdate>
+    <pubdate></pubdate>
   </info>
+
   <refnamediv>
     <refname>ReadHBSparse</refname>
-    <refpurpose> read a Harwell-Boeing sparse format file  </refpurpose>
+
+    <refpurpose>read a Harwell-Boeing sparse format file</refpurpose>
   </refnamediv>
+
   <refsynopsisdiv>
     <title>Calling Sequence</title>
+
     <synopsis>[A, description, ref, mtype] = ReadHBSparse([filename])</synopsis>
   </refsynopsisdiv>
+
   <refsection>
     <title>Parameters</title>
+
     <variablelist>
       <varlistentry>
-        <term>filename  </term>
+        <term>filename</term>
+
         <listitem>
-          <para>(optional) a string given the filename (eventually preceeding by the path), if filename is not given then the function use <link linkend="xgetfile">xgetfile</link> to get filename interactively</para>
+          <para>(optional) a string given the filename (eventually preceeding
+          by the path), if filename is not given then the function use <link
+          linkend="xgetfile">xgetfile</link> to get filename
+          interactively</para>
         </listitem>
       </varlistentry>
+
       <varlistentry>
-        <term>A  </term>
+        <term>A</term>
+
         <listitem>
           <para>the sparse matrix</para>
         </listitem>
       </varlistentry>
+
       <varlistentry>
-        <term>description  </term>
+        <term>description</term>
+
         <listitem>
           <para>a string given some information about the matrix</para>
         </listitem>
       </varlistentry>
+
       <varlistentry>
-        <term>ref  </term>
+        <term>ref</term>
+
         <listitem>
           <para>a string given the reference of the matrix</para>
         </listitem>
       </varlistentry>
+
       <varlistentry>
-        <term>mtype  </term>
+        <term>mtype</term>
+
         <listitem>
           <para>a string given the type of the matrix</para>
         </listitem>
       </varlistentry>
     </variablelist>
   </refsection>
+
   <refsection>
     <title>Description</title>
-    <para>
-    An utility to read the Harwell-Boeing sparse matrix 
-    format. Currently don't work for unassembled matrix.
-    Also the eventual rhs vectors of the file are not returned.
-    Generally the file name is of the form ref.mtype  
-    where mtype is a 3 letters word abc given some 
-    informations (already inside the file) on the matrix : 
-  </para>
-    <programlisting><![CDATA[
+
+    <para>An utility to read the Harwell-Boeing sparse matrix format.
+    Currently don't work for unassembled matrix. Also the eventual rhs vectors
+    of the file are not returned. Generally the file name is of the form
+    ref.mtype where mtype is a 3 letters word abc given some informations
+    (already inside the file) on the matrix :</para>
+
+    <programlisting>
    a = R|C|P   for real|complex|pattern (no values given)
    b = S|H|Z|U for symetric|hermitian|skew symetric|unsymetric
    c = A|E     for assembled|unassembled matrix 
                (case E is not treated by this func)
-   ]]></programlisting>
+   </programlisting>
   </refsection>
+
   <refsection>
     <title>References</title>
-    <para>
-    Users' Guide for the Harwell-Boeing Sparse Matrix Collection Iain S. Duff, Roger G. Grimes, John G. Lewis. 
-    You may found  this guide and numerous sparse matrices (in the Harwell-Boeing  format) at the University of 
-    Florida Sparse Matrix Collection web site :
-    <link xlink:href="http://www.cise.ufl.edu/research/sparse/matrices/">http://www.cise.ufl.edu/research/sparse/matrices/</link>
-  </para>
-    <para>
-    maintained by Tim Davis (<link xlink:href="http://www.cise.ufl.edu/~davis/">http://www.cise.ufl.edu/~davis/</link>);
-  </para>
+
+    <para>Users' Guide for the Harwell-Boeing Sparse Matrix Collection Iain S.
+    Duff, Roger G. Grimes, John G. Lewis. You may found this guide and
+    numerous sparse matrices (in the Harwell-Boeing format) at the University
+    of Florida Sparse Matrix Collection </para>
+
+    <para>web site : <link
+    linkend="http://www.cise.ufl.edu/research/sparse/matrices/">http://www.cise.ufl.edu/research/sparse/matrices/</link></para>
+
+    <para>maintained by Tim Davis (<link
+    linkend="http://www.cise.ufl.edu/~davis/">http://www.cise.ufl.edu/~davis/</link>)</para>
   </refsection>
+
   <refsection>
     <title>Examples</title>
-    <programlisting role="example"><![CDATA[
+
+    <programlisting role="example">
 [A] = ReadHBSparse(DIR_SCISPT_DEM+"arc130.rua");
- ]]></programlisting>
+ </programlisting>
   </refsection>
+
   <refsection>
     <title>See Also</title>
+
     <simplelist type="inline">
-      <member>
-        <link linkend="PlotSparse">PlotSparse</link>
-      </member>
+      <member><link linkend="PlotSparse">PlotSparse</link></member>
     </simplelist>
   </refsection>
+
   <refsection>
     <title>Authors</title>
-    <para>Bruno Pincon &lt;Bruno.Pincon@iecn.u-nancy.fr&gt;  </para>
+
+    <para>Bruno Pincon &lt;Bruno.Pincon@iecn.u-nancy.fr&gt;</para>
   </refsection>
-</refentry>
+</refentry>
\ No newline at end of file
index d28b2be..5a00c25 100644 (file)
@@ -33,7 +33,7 @@
   <refsection>
     <title>Availability</title>
     <para>
-      <link xlink:href="http://www.tau.ac.il/~stoledo/taucs/">http://www.tau.ac.il/~stoledo/taucs/</link>
+<link linkend='http://www.tau.ac.il/~stoledo/taucs/'>http://www.tau.ac.il/~stoledo/taucs/</link>
     </para>
   </refsection>
 </refentry>
index 53d6f3c..1fafe50 100644 (file)
@@ -49,7 +49,7 @@ UMFPACK is available under alternate licences; contact T. Davis for details.
   <refsection>
     <title>Availability</title>
     <para>
-      <link xlink:href="http://www.cise.ufl.edu/research/sparse">http://www.cise.ufl.edu/research/sparse</link>
+<link linkend='http://www.cise.ufl.edu/research/sparse'>http://www.cise.ufl.edu/research/sparse</link>
     </para>
   </refsection>
 </refentry>
index 28a7d35..9f7a89b 100644 (file)
   <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. 
+    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. 
   </para>
   </refsection>
   <refsection>
     <title>Examples</title>
     <para>
-    see the example section of <link linkend="umf_lufact">umf_lufact</link> 
+    see the example section of <link linkend='umf_lufact'>umf_lufact</link>
   </para>
   </refsection>
   <refsection>
index f9aea98..5e37d4e 100644 (file)
     (the memory used for them is "outside" scilab stack). 
   </para>
     <para>
-    This function must be used in place of <link linkend="umfpack">umfpack</link> if you
+    This function must be used in place of <simplelist type='inline'>
+      <member>
+        <link linkend='umfpack'>umfpack</link>
+      </member>
+    </simplelist> if you
     have multiple linear systems with the same matrix to solve when
     the rhs are not known at the same time (for instance A x1 = b1
     and A x2 = b2 but b2 depends on x1, etc...). 
     When such a 
     factorisation have been computed, a linear system must be solved
     with umf_lusolve (in general x = umf_lusolve(LU_ptr, b) but others
-    options are possible, see <link linkend="umf_lusolve">umf_lusolve</link>). To free the memory used
-    by the LU factors, use umf_ludel(LU_ptr) (<link linkend="umf_ludel">umf_ludel</link>); to retrieve the LU 
-    factors at the scilab level (for example to display their sparse 
-    patterns), use <link linkend="umf_luget">umf_luget</link> ; to get some informations (number of
-    non zeros in L and U), use <link linkend="umf_luinfo">umf_luinfo</link>. To compute an approximation
-    of the condition number use <link linkend="condestsp">condestsp</link>.
+    options are possible, see <link linkend='umf_lusolve'>umf_lusolve</link>.
+    To free the memory used by the LU factors, use umf_ludel(LU_ptr) (<link linkend='umf_ludel'>umf_ludel</link>);
+    to retrieve the LU factors at the scilab level (for example to display their sparse 
+    patterns), use <link linkend='umf_luget'>umf_luget</link>; to get some informations (number of
+    non zeros in L and U), use <link linkend='umf_luinfo'>umf_luinfo</link>.
+    To compute an approximation of the condition number use <link linkend='condestsp'>condestsp</link>
   </para>
   </refsection>
   <refsection>
index 9cb6346..3c88f46 100644 (file)
@@ -51,7 +51,7 @@
   <refsection>
     <title>Description</title>
     <para>
-    This function must be used in conjonction with <link linkend="umf_lufact">umf_lufact</link> which
+    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
     <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
@@ -62,7 +62,7 @@
   <refsection>
     <title>Examples</title>
     <para>
-    see the example section of <link linkend="umf_lufact">umf_lufact</link>
+    see the example section of <link linkend='umf_lufact'>umf_lufact</link>
   </para>
   </refsection>
   <refsection>