add details of linear solvers used where necessary in C docs

ralna · Feb 12, 2024 · 7fbaaf2 · 7fbaaf2
1 parent 1f18bbd
commit 7fbaaf2
Show file tree

Hide file tree

Showing 76 changed files with 10,184 additions and 9,467 deletions.
diff --git a/html/C/arc.html b/html/C/arc.html
diff --git a/html/C/bgo.html b/html/C/bgo.html
diff --git a/html/C/blls.html b/html/C/blls.html
diff --git a/html/C/blls_functions.html b/html/C/blls_functions.html
diff --git a/html/C/bllsb.html b/html/C/bllsb.html
diff --git a/html/C/bqp.html b/html/C/bqp.html
diff --git a/html/C/bqpb.html b/html/C/bqpb.html
diff --git a/html/C/clls.html b/html/C/clls.html
diff --git a/html/C/cqp.html b/html/C/cqp.html
diff --git a/html/C/cro.html b/html/C/cro.html
diff --git a/html/C/cro_functions.html b/html/C/cro_functions.html
diff --git a/html/C/dgo.html b/html/C/dgo.html
diff --git a/html/C/dps.html b/html/C/dps.html
diff --git a/html/C/dps_functions.html b/html/C/dps_functions.html
diff --git a/html/C/dqp.html b/html/C/dqp.html
diff --git a/html/C/dqp_functions.html b/html/C/dqp_functions.html
diff --git a/html/C/eqp.html b/html/C/eqp.html
diff --git a/html/C/fdc.html b/html/C/fdc.html
diff --git a/html/C/fdc_functions.html b/html/C/fdc_functions.html
diff --git a/html/C/glrt.html b/html/C/glrt.html
diff --git a/html/C/gltr.html b/html/C/gltr.html
diff --git a/html/C/l2rt.html b/html/C/l2rt.html
diff --git a/html/C/lhs.html b/html/C/lhs.html
diff --git a/html/C/llsr.html b/html/C/llsr.html
diff --git a/html/C/llsr_functions.html b/html/C/llsr_functions.html
diff --git a/html/C/llst.html b/html/C/llst.html
diff --git a/html/C/llst_functions.html b/html/C/llst_functions.html
diff --git a/html/C/lp.html b/html/C/lp.html
@@ -45,7 +45,7 @@
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
     <link rel="next" title="GALAHAD LPA package" href="lpa.html" />
-    <link rel="prev" title="nls_time_type structure" href="struct_nls_time_type.html" />
+    <link rel="prev" title="slls_time_type structure" href="struct_slls_time_type.html" />
   <meta name="viewport" content="width=device-width, initial-scale=1" />
   <meta name="docsearch:language" content="en">
   </head>
@@ -529,11 +529,11 @@ <h2>References<a class="headerlink" href="#references" title="Permalink to this
             <footer class="bd-footer-article">
                 <!-- Previous / next buttons -->
 <div class='prev-next-area'>
-  <a class='left-prev' id="prev-link" href="struct_nls_time_type.html" title="previous page">
+  <a class='left-prev' id="prev-link" href="struct_slls_time_type.html" title="previous page">
       <i class="fa-solid fa-angle-left"></i>
       <div class="prev-next-info">
           <p class="prev-next-subtitle">previous</p>
-          <p class="prev-next-title">nls_time_type structure</p>
+          <p class="prev-next-title">slls_time_type structure</p>
       </div>
   </a>
   <a class='right-next' id="next-link" href="lpa.html" title="next page">

diff --git a/html/C/lpa.html b/html/C/lpa.html
diff --git a/html/C/lpb.html b/html/C/lpb.html
diff --git a/html/C/ls.html b/html/C/ls.html
@@ -576,7 +576,7 @@
   <section id="least-squares">
 <h1>Least-Squares<a class="headerlink" href="#least-squares" title="Permalink to this heading">#</a></h1>
 <p><strong>Release:</strong> 1.0</p>
-<p><strong>Date:</strong> Jan 02, 2024</p>
+<p><strong>Date:</strong> Feb 12, 2024</p>
 <p><strong>Author:</strong> <a class="reference external" href="mailto:jaroslav&#46;fowkes&#37;&#52;&#48;stfc&#46;ac&#46;uk">Jaroslav Fowkes</a> and <a class="reference external" href="mailto:nick&#46;gould&#37;&#52;&#48;stfc&#46;ac&#46;uk">Nick Gould</a></p>
 <p>GALAHAD <a class="footnote-reference superscript" href="#id2" id="id1" role="doc-noteref"><span class="fn-bracket">[</span>1<span class="fn-bracket">]</span></a> is a suite of open-source routines for large-scale continuous
 optimization.  Currently there is a single package designed to find a local

diff --git a/html/C/lsqp.html b/html/C/lsqp.html
diff --git a/html/C/lsrt.html b/html/C/lsrt.html
diff --git a/html/C/lstr.html b/html/C/lstr.html
diff --git a/html/C/nls.html b/html/C/nls.html
diff --git a/html/C/objects.inv b/html/C/objects.inv
diff --git a/html/C/presolve.html b/html/C/presolve.html
diff --git a/html/C/psls.html b/html/C/psls.html
diff --git a/html/C/psls_functions.html b/html/C/psls_functions.html
diff --git a/html/C/qpa.html b/html/C/qpa.html
diff --git a/html/C/qpa_functions.html b/html/C/qpa_functions.html
diff --git a/html/C/qpb.html b/html/C/qpb.html
diff --git a/html/C/rpd.html b/html/C/rpd.html
diff --git a/html/C/rqs.html b/html/C/rqs.html
diff --git a/html/C/rqs_functions.html b/html/C/rqs_functions.html
diff --git a/html/C/sbls.html b/html/C/sbls.html
diff --git a/html/C/sbls_functions.html b/html/C/sbls_functions.html
diff --git a/html/C/searchindex.js b/html/C/searchindex.js
diff --git a/html/C/sha.html b/html/C/sha.html
diff --git a/html/C/slls.html b/html/C/slls.html
diff --git a/html/C/slls_functions.html b/html/C/slls_functions.html
diff --git a/html/C/sls.html b/html/C/sls.html
diff --git a/html/C/sls_functions.html b/html/C/sls_functions.html
@@ -637,8 +637,8 @@
 </div>
 <pre class="highlight doxyrest-overview-code-block literal-block"><span></span><span class="c1">// typedefs</span>
 
-<span class="k">typedef</span> <span class="kt">float</span> <a class="reference internal" href="wcp_functions.html#doxid-galahad-precision-8h-1a3455cab03087949fd428a31cf302f98b"><span class="std std-ref">real_sp_</span></a><span></span><span class="p">;</span>
-<span class="k">typedef</span> <span class="kt">double</span> <a class="reference internal" href="wcp_functions.html#doxid-galahad-precision-8h-1ab82133d435678ff159433d2e50cf295e"><span class="std std-ref">real_wp_</span></a><span></span><span class="p">;</span>
+<span class="k">typedef</span> <span class="kt">float</span> <a class="reference internal" href="wcp.html#doxid-galahad-precision-8h-1a3455cab03087949fd428a31cf302f98b"><span class="std std-ref">real_sp_</span></a><span></span><span class="p">;</span>
+<span class="k">typedef</span> <span class="kt">double</span> <a class="reference internal" href="wcp.html#doxid-galahad-precision-8h-1ab82133d435678ff159433d2e50cf295e"><span class="std std-ref">real_wp_</span></a><span></span><span class="p">;</span>
 
 <span class="c1">// structs</span>
 
@@ -679,17 +679,17 @@
     <span class="kt">void</span><span class="o">**</span> <span class="n">data</span><span class="p">,</span>
     <span class="kt">int</span><span class="o">*</span> <span class="n">status</span><span class="p">,</span>
     <span class="kt">int</span> <span class="n">ne</span><span class="p">,</span>
-    <span class="k">const</span> <a class="reference internal" href="wcp_functions.html#doxid-galahad-precision-8h-1ab82133d435678ff159433d2e50cf295e"><span class="std std-ref">real_wp_</span></a><span></span> <span class="n">val</span><span class="p">[]</span>
+    <span class="k">const</span> <a class="reference internal" href="wcp.html#doxid-galahad-precision-8h-1ab82133d435678ff159433d2e50cf295e"><span class="std std-ref">real_wp_</span></a><span></span> <span class="n">val</span><span class="p">[]</span>
 <span class="p">);</span>
 
-<span class="kt">void</span> <a class="reference internal" href="#doxid-galahad-sls-8h-1a1b3e7546b59b06160c51e16b6781bc0b"><span class="std std-ref">sls_solve_system</span></a><span></span><span class="p">(</span><span class="kt">void</span><span class="o">**</span> <span class="n">data</span><span class="p">,</span> <span class="kt">int</span><span class="o">*</span> <span class="n">status</span><span class="p">,</span> <span class="kt">int</span> <span class="n">n</span><span class="p">,</span> <a class="reference internal" href="wcp_functions.html#doxid-galahad-precision-8h-1ab82133d435678ff159433d2e50cf295e"><span class="std std-ref">real_wp_</span></a><span></span> <span class="n">sol</span><span class="p">[]);</span>
+<span class="kt">void</span> <a class="reference internal" href="#doxid-galahad-sls-8h-1a1b3e7546b59b06160c51e16b6781bc0b"><span class="std std-ref">sls_solve_system</span></a><span></span><span class="p">(</span><span class="kt">void</span><span class="o">**</span> <span class="n">data</span><span class="p">,</span> <span class="kt">int</span><span class="o">*</span> <span class="n">status</span><span class="p">,</span> <span class="kt">int</span> <span class="n">n</span><span class="p">,</span> <a class="reference internal" href="wcp.html#doxid-galahad-precision-8h-1ab82133d435678ff159433d2e50cf295e"><span class="std std-ref">real_wp_</span></a><span></span> <span class="n">sol</span><span class="p">[]);</span>
 
 <span class="kt">void</span> <a class="reference internal" href="#doxid-galahad-sls-8h-1ac66dc50d8b54acab90d70ae649b92905"><span class="std std-ref">sls_partial_solve_system</span></a><span></span><span class="p">(</span>
     <span class="k">const</span> <span class="kt">char</span> <span class="n">part</span><span class="p">[],</span>
     <span class="kt">void</span><span class="o">**</span> <span class="n">data</span><span class="p">,</span>
     <span class="kt">int</span><span class="o">*</span> <span class="n">status</span><span class="p">,</span>
     <span class="kt">int</span> <span class="n">n</span><span class="p">,</span>
-    <a class="reference internal" href="wcp_functions.html#doxid-galahad-precision-8h-1ab82133d435678ff159433d2e50cf295e"><span class="std std-ref">real_wp_</span></a><span></span> <span class="n">sol</span><span class="p">[]</span>
+    <a class="reference internal" href="wcp.html#doxid-galahad-precision-8h-1ab82133d435678ff159433d2e50cf295e"><span class="std std-ref">real_wp_</span></a><span></span> <span class="n">sol</span><span class="p">[]</span>
 <span class="p">);</span>
 
 <span class="kt">void</span> <a class="reference internal" href="#doxid-galahad-sls-8h-1a0ca4a126813c3aafac9d791a152b233c"><span class="std std-ref">sls_information</span></a><span></span><span class="p">(</span><span class="kt">void</span><span class="o">**</span> <span class="n">data</span><span class="p">,</span> <span class="k">struct</span> <a class="reference internal" href="sls.html#doxid-structsls-inform-type"><span class="std std-ref">sls_inform_type</span></a><span></span><span class="o">*</span> <span class="n">inform</span><span class="p">,</span> <span class="kt">int</span><span class="o">*</span> <span class="n">status</span><span class="p">);</span>
@@ -724,7 +724,7 @@ <h1>function calls<a class="headerlink" href="#function-calls" title="Permalink
 </colgroup>
 <tbody>
 <tr class="row-odd"><td><p>solver</p></td>
-<td><p>is a one-dimensional array of type char that specifies the <span class="xref std std-ref">solver package</span> that should be used to factorize the matrix <span class="math notranslate nohighlight">\(A\)</span>. It should be one of ‘sils’, ‘ma27’, ‘ma57’, ‘ma77’, ‘ma86’, ‘ma87’, ‘ma97’, ‘ssids’, ‘mumps’, ‘pardiso’, ‘mkl pardiso’, ‘pastix’, ‘wsmp’, ‘potr’, ‘sytr’ or ‘pbtr’; lower or upper case variants are allowed.</p></td>
+<td><p>is a one-dimensional array of type char that specifies the <span class="xref std std-ref">solver package</span> that should be used to factorize the matrix <span class="math notranslate nohighlight">\(A\)</span>. It should be one of ‘sils’, ‘ma27’, ‘ma57’, ‘ma77’, ‘ma86’, ‘ma87’, ‘ma97’, ‘ssids’, ‘mumps’, ‘pardiso’, ‘mkl pardiso’, ‘pastix’, ‘wsmp’, ‘potr’, ‘sytr’ or ‘pbtr’; lower or upper case variants are allowed.  Only ‘potr’, ‘sytr’, ‘pbtr’ and, for OMP 4.0-compliant compilers, ‘ssids’ are installed by default, but others are easily installed (see README.external).</p></td>
 </tr>
 <tr class="row-even"><td><p>data</p></td>
 <td><p>holds private internal data</p></td>
@@ -964,7 +964,7 @@ <h1>function calls<a class="headerlink" href="#function-calls" title="Permalink
     <span class="kt">void</span><span class="o">**</span> <span class="n">data</span><span class="p">,</span>
     <span class="kt">int</span><span class="o">*</span> <span class="n">status</span><span class="p">,</span>
     <span class="kt">int</span> <span class="n">ne</span><span class="p">,</span>
-    <span class="k">const</span> <a class="reference internal" href="wcp_functions.html#doxid-galahad-precision-8h-1ab82133d435678ff159433d2e50cf295e"><span class="std std-ref">real_wp_</span></a><span></span> <span class="n">val</span><span class="p">[]</span>
+    <span class="k">const</span> <a class="reference internal" href="wcp.html#doxid-galahad-precision-8h-1ab82133d435678ff159433d2e50cf295e"><span class="std std-ref">real_wp_</span></a><span></span> <span class="n">val</span><span class="p">[]</span>
 <span class="p">)</span></pre>
 <p>Form and factorize the symmetric matrix <span class="math notranslate nohighlight">\(A\)</span>.</p>
 <p class="rubric">Parameters:</p>
@@ -1094,7 +1094,7 @@ <h1>function calls<a class="headerlink" href="#function-calls" title="Permalink
 </tr>
 </tbody>
 </table>
-<pre class="highlight doxyrest-title-code-block literal-block" id="doxid-galahad-sls-8h-1a1b3e7546b59b06160c51e16b6781bc0b"><span id="index-7"></span><span></span><span class="kt">void</span> <span class="n">sls_solve_system</span><span class="p">(</span><span class="kt">void</span><span class="o">**</span> <span class="n">data</span><span class="p">,</span> <span class="kt">int</span><span class="o">*</span> <span class="n">status</span><span class="p">,</span> <span class="kt">int</span> <span class="n">n</span><span class="p">,</span> <a class="reference internal" href="wcp_functions.html#doxid-galahad-precision-8h-1ab82133d435678ff159433d2e50cf295e"><span class="std std-ref">real_wp_</span></a><span></span> <span class="n">sol</span><span class="p">[])</span></pre>
+<pre class="highlight doxyrest-title-code-block literal-block" id="doxid-galahad-sls-8h-1a1b3e7546b59b06160c51e16b6781bc0b"><span id="index-7"></span><span></span><span class="kt">void</span> <span class="n">sls_solve_system</span><span class="p">(</span><span class="kt">void</span><span class="o">**</span> <span class="n">data</span><span class="p">,</span> <span class="kt">int</span><span class="o">*</span> <span class="n">status</span><span class="p">,</span> <span class="kt">int</span> <span class="n">n</span><span class="p">,</span> <a class="reference internal" href="wcp.html#doxid-galahad-precision-8h-1ab82133d435678ff159433d2e50cf295e"><span class="std std-ref">real_wp_</span></a><span></span> <span class="n">sol</span><span class="p">[])</span></pre>
 <p>Solve the linear system <span class="math notranslate nohighlight">\(Ax=b\)</span>.</p>
 <p class="rubric">Parameters:</p>
 <table class="table">
@@ -1167,7 +1167,7 @@ <h1>function calls<a class="headerlink" href="#function-calls" title="Permalink
     <span class="kt">void</span><span class="o">**</span> <span class="n">data</span><span class="p">,</span>
     <span class="kt">int</span><span class="o">*</span> <span class="n">status</span><span class="p">,</span>
     <span class="kt">int</span> <span class="n">n</span><span class="p">,</span>
-    <a class="reference internal" href="wcp_functions.html#doxid-galahad-precision-8h-1ab82133d435678ff159433d2e50cf295e"><span class="std std-ref">real_wp_</span></a><span></span> <span class="n">sol</span><span class="p">[]</span>
+    <a class="reference internal" href="wcp.html#doxid-galahad-precision-8h-1ab82133d435678ff159433d2e50cf295e"><span class="std std-ref">real_wp_</span></a><span></span> <span class="n">sol</span><span class="p">[]</span>
 <span class="p">)</span></pre>
 <p>Given the factorization <span class="math notranslate nohighlight">\(A = L D U\)</span> with <span class="math notranslate nohighlight">\(U = L^T\)</span>, solve the linear system <span class="math notranslate nohighlight">\(Mx=b\)</span>, where <span class="math notranslate nohighlight">\(M\)</span> is one of <span class="math notranslate nohighlight">\(L\)</span>, <span class="math notranslate nohighlight">\(D\)</span>, <span class="math notranslate nohighlight">\(U\)</span> or <span class="math notranslate nohighlight">\(S = L \sqrt{D}\)</span>.</p>
 <p class="rubric">Parameters:</p>