better wording

This commit is contained in:
conrad
2023-04-03 00:00:17 +10:00
parent 4e6528ace1
commit 4c86458e2f
+12 -11
View File
@@ -14189,26 +14189,18 @@ If no solution is found:
</li>
<br>
<li>
The <i>solver</i> argument is optional; <i>solver</i> is either <code>"superlu"</code> or <code>"lapack"</code>; by default <code>"superlu"</code> is used
the <i>solver</i> argument is optional; <i>solver</i> is either <code>"superlu"</code> or <code>"lapack"</code>; by default <code>"superlu"</code> is used
<ul>
<li>
For <code>"superlu"</code>, <i>ARMA_USE_SUPERLU</i> must be enabled in <a href="#config_hpp">config.hpp</a>
for <code>"superlu"</code>, <i>ARMA_USE_SUPERLU</i> must be enabled in <a href="#config_hpp">config.hpp</a>
</li>
<li>
For <code>"lapack"</code>, sparse matrix <i>A</i> is converted to a dense matrix before using the LAPACK solver; this considerably increases memory usage
for <code>"lapack"</code>, sparse matrix <i>A</i> is converted to a dense matrix before using the LAPACK solver; this considerably increases memory usage
</li>
</ul>
</li>
<br>
<li>
<b>Notes</b>:
<ul>
<li>The SuperLU solver is mainly useful for very large and/or very sparse matrices</li>
<li>If there is sufficient amount of memory to store a dense version of matrix <i>A</i>, the LAPACK solver can be faster</li>
</ul>
</li>
<br>
<li>
The <i>opts</i> argument is optional and applicable to the SuperLU solver;
<br><i>opts</i> is an instance of the <i>superlu_opts</i> structure:
<ul>
@@ -14270,6 +14262,15 @@ struct superlu_opts
</li>
<br>
<li>
<b>Notes</b>:
<ul>
<li>to reuse the factorisation of <i>A</i> for finding solutions where <i>B</i> is iteratively changed, use the <a href="#spsolve_factoriser">spsolve_factoriser</a> class instead</li>
<li>the SuperLU solver is mainly useful for very large and very sparse matrices</li>
<li>if there is sufficient amount of memory to store a dense version of matrix <i>A</i>, the LAPACK solver can be faster</li>
</ul>
</li>
<br>
<li>
Examples:
<ul>
<pre>