Deploying to gh-pages from @ 3367ca7 🚀

index.html

@@ -161,6 +161,11 @@ <h3>License</h3>
 <ul>
 <li>The NLESolver-Fortran source code and related files and documentation are distributed under a permissive free software <a href="https://github.com/jacobwilliams/nlesolver-fortran/blob/master/LICENSE">license</a> (BSD-3).</li>
 </ul>
+<h3>References</h3>
+<ul>
+<li>C. G. Broyden, "<a href="https://www.ams.org/journals/mcom/1965-19-092/S0025-5718-1965-0198670-6/S0025-5718-1965-0198670-6.pdf">A Class of Methods for Solving Nonlinear Simultaneous Equations</a>", Math. Comp. 19 (1965), 577-593</li>
+<li>L. K. Schubert, "<a href="https://www.ams.org/journals/mcom/1970-24-109/S0025-5718-1970-0258276-9/S0025-5718-1970-0258276-9.pdf">Modification of a Quasi-Newton Method for Nonlinear Equations with a Sparse Jacobian</a>", Mathematics of Computation, Vol. 24, No. 109 (Jan., 1970), pp. 27-30.</li>
+</ul>
 <h3>See also</h3>
 <ul>
 <li><a href="https://github.com/fortran-lang/minpack">MINPACK</a> -- Modernized Minpack: for solving nonlinear equations and nonlinear least squares problems</li>

interface/export_func.html

@@ -77,7 +77,7 @@ <h1>export_func
             <li class="list-inline-item" id="statements"><i class="fa fa-list-ol"></i>
               <a data-bs-toggle="tooltip"
                  data-bs-placement="bottom" data-html="true"
-                 title=" 8.5% of total for procedures.">49 statements</a>
+                 title=" 8.1% of total for procedures.">49 statements</a>
             </li>
 
             <li class="list-inline-item" id="source-file">

interface/func_func.html

@@ -77,7 +77,7 @@ <h1>func_func
             <li class="list-inline-item" id="statements"><i class="fa fa-list-ol"></i>
               <a data-bs-toggle="tooltip"
                  data-bs-placement="bottom" data-html="true"
-                 title=" 8.5% of total for procedures.">49 statements</a>
+                 title=" 8.1% of total for procedures.">49 statements</a>
             </li>
 
             <li class="list-inline-item" id="source-file">

interface/grad_func.html

@@ -77,7 +77,7 @@ <h1>grad_func
             <li class="list-inline-item" id="statements"><i class="fa fa-list-ol"></i>
               <a data-bs-toggle="tooltip"
                  data-bs-placement="bottom" data-html="true"
-                 title=" 8.5% of total for procedures.">49 statements</a>
+                 title=" 8.1% of total for procedures.">49 statements</a>
             </li>
 
             <li class="list-inline-item" id="source-file">

interface/grad_func_sparse.html

@@ -77,7 +77,7 @@ <h1>grad_func_sparse
             <li class="list-inline-item" id="statements"><i class="fa fa-list-ol"></i>
               <a data-bs-toggle="tooltip"
                  data-bs-placement="bottom" data-html="true"
-                 title=" 8.5% of total for procedures.">49 statements</a>
+                 title=" 8.1% of total for procedures.">49 statements</a>
             </li>
 
             <li class="list-inline-item" id="source-file">

interface/linesearch_func.html

@@ -77,7 +77,7 @@ <h1>linesearch_func
             <li class="list-inline-item" id="statements"><i class="fa fa-list-ol"></i>
               <a data-bs-toggle="tooltip"
                  data-bs-placement="bottom" data-html="true"
-                 title=" 8.5% of total for procedures.">49 statements</a>
+                 title=" 8.1% of total for procedures.">49 statements</a>
             </li>
 
             <li class="list-inline-item" id="source-file">

interface/wait_func.html

@@ -77,7 +77,7 @@ <h1>wait_func
             <li class="list-inline-item" id="statements"><i class="fa fa-list-ol"></i>
               <a data-bs-toggle="tooltip"
                  data-bs-placement="bottom" data-html="true"
-                 title=" 8.5% of total for procedures.">49 statements</a>
+                 title=" 8.1% of total for procedures.">49 statements</a>
             </li>
 
             <li class="list-inline-item" id="source-file">

module/nlesolver_module.html

@@ -77,7 +77,7 @@ <h1>nlesolver_module
             <li class="list-inline-item" id="statements"><i class="fa fa-list-ol"></i>
               <a data-bs-toggle="tooltip"
                  data-bs-placement="bottom" data-html="true"
-                 title="100.0% of total for modules and submodules.">686 statements</a>
+                 title="100.0% of total for modules and submodules.">715 statements</a>
             </li>
 
             <li class="list-inline-item" id="source-file">
@@ -240,10 +240,10 @@ <h3 class="card-header card-title bg-light">Uses</h3>
         <ul class="list-group list-group-flush">
             <li class="list-group-item">
               <ul class="list-inline">
+                  <li class="list-inline-item"><a href='https://jacobwilliams.github.io/fmin'>fmin_module</a></li>
                   <li class="list-inline-item"><a href='https://jacobwilliams.github.io/lusol'>lusol_ez_module</a></li>
-                  <li class="list-inline-item"><a href='https://jacobwilliams.github.io/LSQR'>lsqr_module</a></li>
                   <li class="list-inline-item"><a href='http://fortranwiki.org/fortran/show/iso_fortran_env'>iso_fortran_env</a></li>
-                  <li class="list-inline-item"><a href='https://jacobwilliams.github.io/fmin'>fmin_module</a></li>
+                  <li class="list-inline-item"><a href='https://jacobwilliams.github.io/LSQR'>lsqr_module</a></li>
               </ul>
             </li>
             <li class="list-group-item">
@@ -1683,7 +1683,7 @@ <h4>Components</h4>
 <td> =</td>
                 <td>0</td>
             <td>
-
+<a href="../type/nlesolver_type.html#variable-lusol_method" class="pull-right"><emph>Read more&hellip;</emph></a>
             </td>
         </tr>
         <tr>
@@ -2100,7 +2100,7 @@ <h4>Arguments</h4>
             <td>::</td>
             <td><strong>fmin_tol</strong></td>
             <td>
-<p>convergence tolerance for <a>fmin</a> (used when <code>step_mode=3</code>)</p>
+<p>convergence tolerance for <a href="../https:/jacobwilliams.github.io/fmin/proc/fmin.html">fmin</a> (used when <code>step_mode=3</code>)</p>
             </td>
         </tr>
         <tr>
@@ -2468,7 +2468,7 @@ <h4>Arguments</h4>
             <td>::</td>
             <td><strong>lusol_method</strong></td>
             <td>
-
+<p><code>LUSOL</code> method:</p><a href="../proc/initialize_nlesolver_variables.html#variable-lusol_method~2" class="pull-right"><emph>Read more&hellip;</emph></a>
             </td>
         </tr>
     </tbody>

proc/backtracking_linesearch.html

@@ -77,7 +77,7 @@ <h1>backtracking_linesearch
             <li class="list-inline-item" id="statements"><i class="fa fa-list-ol"></i>
               <a data-bs-toggle="tooltip"
                  data-bs-placement="bottom" data-html="true"
-                 title="11.7% of total for procedures.">67 statements</a>
+                 title="11.1% of total for procedures.">67 statements</a>
             </li>
 
             <li class="list-inline-item" id="source-file">
@@ -374,7 +374,7 @@ <h2><span class="anchor" id="src"></span>Source Code</h2>
 <span class="k">        end if</span>
 
 <span class="k">        if</span><span class="w"> </span><span class="p">(((</span><span class="n">f</span><span class="w"> </span><span class="o">-</span><span class="w"> </span><span class="n">ftmp</span><span class="p">)</span><span class="w"> </span><span class="o">/</span><span class="w"> </span><span class="mf">2.0_wp</span><span class="w"> </span><span class="o">&gt;=</span><span class="w"> </span><span class="n">alpha</span><span class="o">*</span><span class="n">t</span><span class="p">)</span><span class="w"> </span><span class="p">.</span><span class="nb">or</span><span class="p">.</span><span class="w"> </span><span class="n">min_alpha_reached</span><span class="p">)</span><span class="w"> </span><span class="k">then</span>
-<span class="k">            if</span><span class="w"> </span><span class="p">(</span><span class="n">min_alpha_reached</span><span class="p">)</span><span class="w"> </span><span class="k">then</span>
+<span class="k">            if</span><span class="w"> </span><span class="p">(</span><span class="n">me</span><span class="p">%</span><span class="n">verbose</span><span class="w"> </span><span class="p">.</span><span class="nb">and</span><span class="p">.</span><span class="w"> </span><span class="n">min_alpha_reached</span><span class="p">)</span><span class="w"> </span><span class="k">then</span>
 <span class="k">                write</span><span class="p">(</span><span class="n">me</span><span class="p">%</span><span class="n">iunit</span><span class="p">,</span><span class="s1">&#39;(A)&#39;</span><span class="p">)</span><span class="w"> </span><span class="s1">&#39;        Minimum alpha reached&#39;</span>
 <span class="w">            </span><span class="k">end if</span>
 <span class="w">            </span><span class="c">! Armijo-Goldstein condition is satisfied</span>

proc/exact_linesearch.html

@@ -77,7 +77,7 @@ <h1>exact_linesearch
             <li class="list-inline-item" id="statements"><i class="fa fa-list-ol"></i>
               <a data-bs-toggle="tooltip"
                  data-bs-placement="bottom" data-html="true"
-                 title=" 5.4% of total for procedures.">31 statements</a>
+                 title=" 5.1% of total for procedures.">31 statements</a>
             </li>
 
             <li class="list-inline-item" id="source-file">

proc/fixed_point_linesearch.html

@@ -77,7 +77,7 @@ <h1>fixed_point_linesearch
             <li class="list-inline-item" id="statements"><i class="fa fa-list-ol"></i>
               <a data-bs-toggle="tooltip"
                  data-bs-placement="bottom" data-html="true"
-                 title=" 7.1% of total for procedures.">41 statements</a>
+                 title=" 6.8% of total for procedures.">41 statements</a>
             </li>
 
             <li class="list-inline-item" id="source-file">

proc/get_status.html

@@ -77,7 +77,7 @@ <h1>get_status
             <li class="list-inline-item" id="statements"><i class="fa fa-list-ol"></i>
               <a data-bs-toggle="tooltip"
                  data-bs-placement="bottom" data-html="true"
-                 title=" 2.4% of total for procedures.">14 statements</a>
+                 title=" 2.3% of total for procedures.">14 statements</a>
             </li>
 
             <li class="list-inline-item" id="source-file">

proc/initialize_nlesolver_variables.html

@@ -77,7 +77,7 @@ <h1>initialize_nlesolver_variables
             <li class="list-inline-item" id="statements"><i class="fa fa-list-ol"></i>
               <a data-bs-toggle="tooltip"
                  data-bs-placement="bottom" data-html="true"
-                 title="25.0% of total for procedures.">144 statements</a>
+                 title="23.2% of total for procedures.">140 statements</a>
             </li>
 
             <li class="list-inline-item" id="source-file">
@@ -309,7 +309,7 @@ <h3>Arguments</h3>
             <td>::</td>
             <td><strong>fmin_tol</strong></td>
             <td>
-                <p>convergence tolerance for <a>fmin</a> (used when <code>step_mode=3</code>)</p>
+                <p>convergence tolerance for <a href="../https:/jacobwilliams.github.io/fmin/proc/fmin.html">fmin</a> (used when <code>step_mode=3</code>)</p>
             </td>
         </tr>
         <tr>
@@ -691,7 +691,12 @@ <h3>Arguments</h3>
             <td>::</td>
             <td><strong>lusol_method</strong></td>
             <td>
-
+                <p><code>LUSOL</code> method:</p>
+<ul>
+<li>0 =&gt; TPP: Threshold Partial   Pivoting.</li>
+<li>1 =&gt; TRP: Threshold Rook      Pivoting.</li>
+<li>2 =&gt; TCP: Threshold Complete  Pivoting.</li>
+</ul>
             </td>
         </tr>
     </tbody>
@@ -901,7 +906,11 @@ <h2><span class="anchor" id="src"></span>Source Code</h2>
 <span class="w">    </span><span class="kt">real</span><span class="p">(</span><span class="n">wp</span><span class="p">),</span><span class="k">intent</span><span class="p">(</span><span class="n">in</span><span class="p">),</span><span class="k">optional</span><span class="w">      </span><span class="kd">::</span><span class="w"> </span><span class="n">damp</span><span class="w">    </span><span class="c">!! `LSQR`: damp factor</span>
 <span class="w">    </span><span class="kt">integer</span><span class="p">,</span><span class="k">intent</span><span class="p">(</span><span class="n">in</span><span class="p">),</span><span class="k">optional</span><span class="w">       </span><span class="kd">::</span><span class="w"> </span><span class="n">itnlim</span><span class="w">  </span><span class="c">!! `LSQR`: max iterations</span>
 <span class="w">    </span><span class="kt">integer</span><span class="p">,</span><span class="k">intent</span><span class="p">(</span><span class="n">in</span><span class="p">),</span><span class="k">optional</span><span class="w">       </span><span class="kd">::</span><span class="w"> </span><span class="n">nout</span><span class="w">    </span><span class="c">!! `LSQR`: output unit for printing</span>
-<span class="w">    </span><span class="kt">integer</span><span class="p">,</span><span class="k">intent</span><span class="p">(</span><span class="n">in</span><span class="p">),</span><span class="k">optional</span><span class="w">       </span><span class="kd">::</span><span class="w"> </span><span class="n">lusol_method</span>
+<span class="w">    </span><span class="kt">integer</span><span class="p">,</span><span class="k">intent</span><span class="p">(</span><span class="n">in</span><span class="p">),</span><span class="k">optional</span><span class="w">       </span><span class="kd">::</span><span class="w"> </span><span class="n">lusol_method</span><span class="w"> </span><span class="c">!! `LUSOL` method:</span>
+<span class="w">                                                      </span><span class="c">!!</span>
+<span class="w">                                                      </span><span class="c">!! * 0 =&gt; TPP: Threshold Partial   Pivoting.</span>
+<span class="w">                                                      </span><span class="c">!! * 1 =&gt; TRP: Threshold Rook      Pivoting.</span>
+<span class="w">                                                      </span><span class="c">!! * 2 =&gt; TCP: Threshold Complete  Pivoting.</span>
 
 <span class="w">    </span><span class="kt">logical</span><span class="w"> </span><span class="kd">::</span><span class="w"> </span><span class="n">status_ok</span><span class="w"> </span><span class="c">!! true if there were no errors</span>
 
@@ -1018,13 +1027,7 @@ <h2><span class="anchor" id="src"></span>Source Code</h2>
 <span class="w">            </span><span class="c">! LUSOL method</span>
 <span class="w">            </span><span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="nb">present</span><span class="p">(</span><span class="n">nout</span><span class="p">))</span><span class="w"> </span><span class="n">me</span><span class="p">%</span><span class="n">lusol_method</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">lusol_method</span>
 
-<span class="w">            </span><span class="c">! now now, some options are not available for sparse mode</span>
-<span class="w">            </span><span class="c">!...see if this is possible in sparse mode... TODO</span>
-<span class="w">            </span><span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="n">me</span><span class="p">%</span><span class="n">use_broyden</span><span class="p">)</span><span class="w"> </span><span class="k">then</span>
-<span class="k">                call </span><span class="n">me</span><span class="p">%</span><span class="n">set_status</span><span class="p">(</span><span class="n">istat</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="o">-</span><span class="mi">16</span><span class="p">,</span><span class="w"> </span><span class="n">string</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s1">&#39;Error: broyden method not available for sparse solver&#39;</span><span class="p">)</span>
-<span class="w">                </span><span class="k">return</span>
-<span class="k">            end if</span>
-<span class="k">        end if</span>
+<span class="w">        </span><span class="k">end if</span>
 <span class="k">    end if</span>
 
 <span class="k">    if</span><span class="w"> </span><span class="p">(</span><span class="n">status_ok</span><span class="p">)</span><span class="w"> </span><span class="k">then</span>

proc/linear_solver.html

@@ -77,7 +77,7 @@ <h1>linear_solver
             <li class="list-inline-item" id="statements"><i class="fa fa-list-ol"></i>
               <a data-bs-toggle="tooltip"
                  data-bs-placement="bottom" data-html="true"
-                 title="10.4% of total for procedures.">60 statements</a>
+                 title=" 9.9% of total for procedures.">60 statements</a>
             </li>
 
             <li class="list-inline-item" id="source-file">