Deploying to gh-pages from @ a4dbdb0 🚀

jacobwilliams · Jan 23, 2024 · 19d77bf · 19d77bf
1 parent e576d5c
commit 19d77bf
Show file tree

Hide file tree

Showing 10 changed files with 1,200 additions and 1,304 deletions.
diff --git a/interface/linesearch_func.html b/interface/linesearch_func.html
@@ -226,7 +226,10 @@ <h3>Arguments</h3>
             <td>::</td>
             <td><strong>f</strong></td>
             <td>
-
+                <ul>
+<li>input: current magnitude of <code>fvec</code>,</li>
+<li>output: new value of <code>f</code></li>
+</ul>
             </td>
         </tr>
         <tr>
@@ -241,7 +244,10 @@ <h3>Arguments</h3>
             <td>::</td>
             <td><strong>fvec</strong></td>
             <td>
-
+                <ul>
+<li>input: current function vector,</li>
+<li>output: new function vector</li>
+</ul>
             </td>
         </tr>
         <tr>

diff --git a/lists/modules.html b/lists/modules.html
@@ -83,76 +83,64 @@ <h1>Modules</h1>
 <!-- Generated by graphviz version 2.43.0 (0)
  -->
 <!-- Title: module~~graph~~ModuleGraph Pages: 1 -->
-<svg id="modulegraphModuleGraph" width="432pt" height="158pt"
- viewBox="0.00 0.00 432.00 158.00" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
+<svg id="modulegraphModuleGraph" width="251pt" height="158pt"
+ viewBox="0.00 0.00 251.00 158.00" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
 <g id="module~~graph~~ModuleGraph" class="graph" transform="scale(1 1) rotate(0) translate(4 154)">
 <title>module~~graph~~ModuleGraph</title>
-<polygon fill="white" stroke="transparent" points="-4,4 -4,-154 428,-154 428,4 -4,4"/>
+<polygon fill="white" stroke="transparent" points="-4,4 -4,-154 247,-154 247,4 -4,4"/>
 <!-- module~nlesolver_module -->
 <g id="module~~graph~~ModuleGraph_node1" class="node">
 <title>module~nlesolver_module</title>
-<g id="a_module~~graph~~ModuleGraph_node1"><a xlink:href="../module/nlesolver_module.html" xlink:title="nlesolver_module">
-<polygon fill="#337ab7" stroke="#337ab7" points="333.5,-45 226.5,-45 226.5,-21 333.5,-21 333.5,-45"/>
-<text text-anchor="middle" x="280" y="-30.6" font-family="Helvetica,sans-Serif" font-size="10.50" fill="white">nlesolver_module</text>
-</a>
-</g>
+<polygon fill="none" stroke="black" points="243,-87 136,-87 136,-63 243,-63 243,-87"/>
+<text text-anchor="middle" x="189.5" y="-72.6" font-family="Helvetica,sans-Serif" font-size="10.50">nlesolver_module</text>
 </g>
 <!-- fmin_module -->
-<g id="module~~graph~~ModuleGraph_node3" class="node">
+<g id="module~~graph~~ModuleGraph_node2" class="node">
 <title>fmin_module</title>
-<polygon fill="#337ab7" stroke="#337ab7" points="91,-66 9,-66 9,-42 91,-42 91,-66"/>
-<text text-anchor="middle" x="50" y="-51.6" font-family="Helvetica,sans-Serif" font-size="10.50" fill="white">fmin_module</text>
+<polygon fill="#337ab7" stroke="#337ab7" points="91,-150 9,-150 9,-126 91,-126 91,-150"/>
+<text text-anchor="middle" x="50" y="-135.6" font-family="Helvetica,sans-Serif" font-size="10.50" fill="white">fmin_module</text>
 </g>
 <!-- module~nlesolver_module&#45;&gt;fmin_module -->
 <g id="module~~graph~~ModuleGraph_edge1" class="edge">
 <title>module~nlesolver_module&#45;&gt;fmin_module</title>
-<path fill="none" stroke="#000000" stroke-dasharray="5,2" d="M226.41,-37.84C188.78,-41.31 138.43,-45.95 101.33,-49.36"/>
-<polygon fill="#000000" stroke="#000000" points="100.88,-45.89 91.24,-50.29 101.52,-52.86 100.88,-45.89"/>
+<path fill="none" stroke="#000000" stroke-dasharray="5,2" d="M163.82,-87.02C146.13,-95.56 121.7,-107.2 100,-117 96.4,-118.62 92.64,-120.29 88.87,-121.94"/>
+<polygon fill="#000000" stroke="#000000" points="87.36,-118.78 79.58,-125.97 90.15,-125.2 87.36,-118.78"/>
 </g>
 <!-- iso_fortran_env -->
-<g id="module~~graph~~ModuleGraph_node4" class="node">
+<g id="module~~graph~~ModuleGraph_node3" class="node">
 <title>iso_fortran_env</title>
-<polygon fill="#337ab7" stroke="#337ab7" points="97,-24 3,-24 3,0 97,0 97,-24"/>
-<text text-anchor="middle" x="50" y="-9.6" font-family="Helvetica,sans-Serif" font-size="10.50" fill="white">iso_fortran_env</text>
+<polygon fill="#337ab7" stroke="#337ab7" points="97,-108 3,-108 3,-84 97,-84 97,-108"/>
+<text text-anchor="middle" x="50" y="-93.6" font-family="Helvetica,sans-Serif" font-size="10.50" fill="white">iso_fortran_env</text>
 </g>
 <!-- module~nlesolver_module&#45;&gt;iso_fortran_env -->
 <g id="module~~graph~~ModuleGraph_edge2" class="edge">
 <title>module~nlesolver_module&#45;&gt;iso_fortran_env</title>
-<path fill="none" stroke="#000000" stroke-dasharray="5,2" d="M226.41,-28.16C190.7,-24.87 143.55,-20.52 107.12,-17.17"/>
-<polygon fill="#000000" stroke="#000000" points="107.43,-13.68 97.15,-16.25 106.79,-20.65 107.43,-13.68"/>
-</g>
-<!-- proc~nlesolver_solver -->
-<g id="module~~graph~~ModuleGraph_node2" class="node">
-<title>proc~nlesolver_solver</title>
-<g id="a_module~~graph~~ModuleGraph_node2"><a xlink:href="../proc/nlesolver_solver.html" xlink:title="nlesolver_module::nlesolver_type%nlesolver_solver">
-<polygon fill="#d9534f" stroke="#d9534f" points="424,-129 136,-129 136,-105 424,-105 424,-129"/>
-<text text-anchor="middle" x="280" y="-114.6" font-family="Helvetica,sans-Serif" font-size="10.50" fill="white">nlesolver_module::nlesolver_type%nlesolver_solver</text>
-</a>
-</g>
+<path fill="none" stroke="#000000" stroke-dasharray="5,2" d="M135.73,-83.06C126.39,-84.49 116.63,-85.98 107.19,-87.42"/>
+<polygon fill="#000000" stroke="#000000" points="106.48,-83.99 97.12,-88.96 107.53,-90.91 106.48,-83.99"/>
 </g>
 <!-- lsqr_module -->
-<g id="module~~graph~~ModuleGraph_node5" class="node">
+<g id="module~~graph~~ModuleGraph_node4" class="node">
 <title>lsqr_module</title>
-<polygon fill="#337ab7" stroke="#337ab7" points="89,-150 11,-150 11,-126 89,-126 89,-150"/>
-<text text-anchor="middle" x="50" y="-135.6" font-family="Helvetica,sans-Serif" font-size="10.50" fill="white">lsqr_module</text>
+<polygon fill="#337ab7" stroke="#337ab7" points="89,-66 11,-66 11,-42 89,-42 89,-66"/>
+<text text-anchor="middle" x="50" y="-51.6" font-family="Helvetica,sans-Serif" font-size="10.50" fill="white">lsqr_module</text>
 </g>
-<!-- proc~nlesolver_solver&#45;&gt;lsqr_module -->
+<!-- module~nlesolver_module&#45;&gt;lsqr_module -->
 <g id="module~~graph~~ModuleGraph_edge3" class="edge">
-<title>proc~nlesolver_solver&#45;&gt;lsqr_module</title>
-<path fill="none" stroke="#000000" stroke-dasharray="5,2" d="M148.68,-129C131.19,-130.61 114.21,-132.18 99.46,-133.54"/>
-<polygon fill="#000000" stroke="#000000" points="98.76,-130.09 89.13,-134.49 99.41,-137.06 98.76,-130.09"/>
+<title>module~nlesolver_module&#45;&gt;lsqr_module</title>
+<path fill="none" stroke="#000000" stroke-dasharray="5,2" d="M135.73,-66.94C123.78,-65.12 111.15,-63.19 99.39,-61.39"/>
+<polygon fill="#000000" stroke="#000000" points="99.74,-57.9 89.32,-59.85 98.68,-64.82 99.74,-57.9"/>
 </g>
 <!-- lusol_ez_module -->
-<g id="module~~graph~~ModuleGraph_node6" class="node">
+<g id="module~~graph~~ModuleGraph_node5" class="node">
 <title>lusol_ez_module</title>
-<polygon fill="#337ab7" stroke="#337ab7" points="100,-108 0,-108 0,-84 100,-84 100,-108"/>
-<text text-anchor="middle" x="50" y="-93.6" font-family="Helvetica,sans-Serif" font-size="10.50" fill="white">lusol_ez_module</text>
+<polygon fill="#337ab7" stroke="#337ab7" points="100,-24 0,-24 0,0 100,0 100,-24"/>
+<text text-anchor="middle" x="50" y="-9.6" font-family="Helvetica,sans-Serif" font-size="10.50" fill="white">lusol_ez_module</text>
 </g>
-<!-- proc~nlesolver_solver&#45;&gt;lusol_ez_module -->
+<!-- module~nlesolver_module&#45;&gt;lusol_ez_module -->
 <g id="module~~graph~~ModuleGraph_edge4" class="edge">
-<title>proc~nlesolver_solver&#45;&gt;lusol_ez_module</title>
-<path fill="none" stroke="#000000" stroke-dasharray="5,2" d="M148.68,-105C135.34,-103.77 122.29,-102.57 110.31,-101.46"/>
-<polygon fill="#000000" stroke="#000000" points="110.35,-97.95 100.07,-100.52 109.7,-104.92 110.35,-97.95"/>
+<title>module~nlesolver_module&#45;&gt;lusol_ez_module</title>
+<path fill="none" stroke="#000000" stroke-dasharray="5,2" d="M163.82,-62.98C146.13,-54.44 121.7,-42.8 100,-33 96.4,-31.38 92.64,-29.71 88.87,-28.06"/>
+<polygon fill="#000000" stroke="#000000" points="90.15,-24.8 79.58,-24.03 87.36,-31.22 90.15,-24.8"/>
 </g>
 </g>
 </svg>

diff --git a/module/nlesolver_module.html b/module/nlesolver_module.html
@@ -240,8 +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='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/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>
               </ul>
             </li>
             <li class="list-group-item">
@@ -251,40 +253,64 @@ <h3 class="card-header card-title bg-light">Uses</h3>
 <!-- Generated by graphviz version 2.43.0 (0)
  -->
 <!-- Title: module~~nlesolver_module~~UsesGraph Pages: 1 -->
-<svg id="modulenlesolver_moduleUsesGraph" width="245pt" height="74pt"
- viewBox="0.00 0.00 245.00 74.00" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
-<g id="module~~nlesolver_module~~UsesGraph" class="graph" transform="scale(1 1) rotate(0) translate(4 70)">
+<svg id="modulenlesolver_moduleUsesGraph" width="251pt" height="158pt"
+ viewBox="0.00 0.00 251.00 158.00" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
+<g id="module~~nlesolver_module~~UsesGraph" class="graph" transform="scale(1 1) rotate(0) translate(4 154)">
 <title>module~~nlesolver_module~~UsesGraph</title>
-<polygon fill="white" stroke="transparent" points="-4,4 -4,-70 241,-70 241,4 -4,4"/>
+<polygon fill="white" stroke="transparent" points="-4,4 -4,-154 247,-154 247,4 -4,4"/>
 <!-- module~nlesolver_module -->
 <g id="module~~nlesolver_module~~UsesGraph_node1" class="node">
 <title>module~nlesolver_module</title>
-<polygon fill="none" stroke="black" points="237,-45 130,-45 130,-21 237,-21 237,-45"/>
-<text text-anchor="middle" x="183.5" y="-30.6" font-family="Helvetica,sans-Serif" font-size="10.50">nlesolver_module</text>
+<polygon fill="none" stroke="black" points="243,-87 136,-87 136,-63 243,-63 243,-87"/>
+<text text-anchor="middle" x="189.5" y="-72.6" font-family="Helvetica,sans-Serif" font-size="10.50">nlesolver_module</text>
 </g>
 <!-- fmin_module -->
 <g id="module~~nlesolver_module~~UsesGraph_node2" class="node">
 <title>fmin_module</title>
-<polygon fill="#337ab7" stroke="#337ab7" points="88,-66 6,-66 6,-42 88,-42 88,-66"/>
-<text text-anchor="middle" x="47" y="-51.6" font-family="Helvetica,sans-Serif" font-size="10.50" fill="white">fmin_module</text>
+<polygon fill="#337ab7" stroke="#337ab7" points="91,-150 9,-150 9,-126 91,-126 91,-150"/>
+<text text-anchor="middle" x="50" y="-135.6" font-family="Helvetica,sans-Serif" font-size="10.50" fill="white">fmin_module</text>
 </g>
 <!-- module~nlesolver_module&#45;&gt;fmin_module -->
 <g id="module~~nlesolver_module~~UsesGraph_edge1" class="edge">
 <title>module~nlesolver_module&#45;&gt;fmin_module</title>
-<path fill="none" stroke="#000000" stroke-dasharray="5,2" d="M129.73,-41.24C119.35,-42.86 108.49,-44.56 98.2,-46.16"/>
-<polygon fill="#000000" stroke="#000000" points="97.48,-42.73 88.14,-47.73 98.56,-49.65 97.48,-42.73"/>
+<path fill="none" stroke="#000000" stroke-dasharray="5,2" d="M163.82,-87.02C146.13,-95.56 121.7,-107.2 100,-117 96.4,-118.62 92.64,-120.29 88.87,-121.94"/>
+<polygon fill="#000000" stroke="#000000" points="87.36,-118.78 79.58,-125.97 90.15,-125.2 87.36,-118.78"/>
 </g>
 <!-- iso_fortran_env -->
 <g id="module~~nlesolver_module~~UsesGraph_node3" class="node">
 <title>iso_fortran_env</title>
-<polygon fill="#337ab7" stroke="#337ab7" points="94,-24 0,-24 0,0 94,0 94,-24"/>
-<text text-anchor="middle" x="47" y="-9.6" font-family="Helvetica,sans-Serif" font-size="10.50" fill="white">iso_fortran_env</text>
+<polygon fill="#337ab7" stroke="#337ab7" points="97,-108 3,-108 3,-84 97,-84 97,-108"/>
+<text text-anchor="middle" x="50" y="-93.6" font-family="Helvetica,sans-Serif" font-size="10.50" fill="white">iso_fortran_env</text>
 </g>
 <!-- module~nlesolver_module&#45;&gt;iso_fortran_env -->
 <g id="module~~nlesolver_module~~UsesGraph_edge2" class="edge">
 <title>module~nlesolver_module&#45;&gt;iso_fortran_env</title>
-<path fill="none" stroke="#000000" stroke-dasharray="5,2" d="M129.73,-24.76C121.36,-23.45 112.67,-22.1 104.22,-20.78"/>
-<polygon fill="#000000" stroke="#000000" points="104.5,-17.28 94.08,-19.19 103.42,-24.19 104.5,-17.28"/>
+<path fill="none" stroke="#000000" stroke-dasharray="5,2" d="M135.73,-83.06C126.39,-84.49 116.63,-85.98 107.19,-87.42"/>
+<polygon fill="#000000" stroke="#000000" points="106.48,-83.99 97.12,-88.96 107.53,-90.91 106.48,-83.99"/>
+</g>
+<!-- lsqr_module -->
+<g id="module~~nlesolver_module~~UsesGraph_node4" class="node">
+<title>lsqr_module</title>
+<polygon fill="#337ab7" stroke="#337ab7" points="89,-66 11,-66 11,-42 89,-42 89,-66"/>
+<text text-anchor="middle" x="50" y="-51.6" font-family="Helvetica,sans-Serif" font-size="10.50" fill="white">lsqr_module</text>
+</g>
+<!-- module~nlesolver_module&#45;&gt;lsqr_module -->
+<g id="module~~nlesolver_module~~UsesGraph_edge3" class="edge">
+<title>module~nlesolver_module&#45;&gt;lsqr_module</title>
+<path fill="none" stroke="#000000" stroke-dasharray="5,2" d="M135.73,-66.94C123.78,-65.12 111.15,-63.19 99.39,-61.39"/>
+<polygon fill="#000000" stroke="#000000" points="99.74,-57.9 89.32,-59.85 98.68,-64.82 99.74,-57.9"/>
+</g>
+<!-- lusol_ez_module -->
+<g id="module~~nlesolver_module~~UsesGraph_node5" class="node">
+<title>lusol_ez_module</title>
+<polygon fill="#337ab7" stroke="#337ab7" points="100,-24 0,-24 0,0 100,0 100,-24"/>
+<text text-anchor="middle" x="50" y="-9.6" font-family="Helvetica,sans-Serif" font-size="10.50" fill="white">lusol_ez_module</text>
+</g>
+<!-- module~nlesolver_module&#45;&gt;lusol_ez_module -->
+<g id="module~~nlesolver_module~~UsesGraph_edge4" class="edge">
+<title>module~nlesolver_module&#45;&gt;lusol_ez_module</title>
+<path fill="none" stroke="#000000" stroke-dasharray="5,2" d="M163.82,-62.98C146.13,-54.44 121.7,-42.8 100,-33 96.4,-31.38 92.64,-29.71 88.87,-28.06"/>
+<polygon fill="#000000" stroke="#000000" points="90.15,-24.8 79.58,-24.03 87.36,-31.22 90.15,-24.8"/>
 </g>
 </g>
 </svg>
@@ -985,7 +1011,10 @@ <h4>Arguments</h4>
             <td>::</td>
             <td><strong>f</strong></td>
             <td>
-
+                <ul>
+<li>input: current magnitude of <code>fvec</code>,</li>
+<li>output: new value of <code>f</code></li>
+</ul>
             </td>
         </tr>
         <tr>
@@ -1000,7 +1029,10 @@ <h4>Arguments</h4>
             <td>::</td>
             <td><strong>fvec</strong></td>
             <td>
-
+                <ul>
+<li>input: current function vector,</li>
+<li>output: new function vector</li>
+</ul>
             </td>
         </tr>
         <tr>
@@ -2345,7 +2377,7 @@ <h4>Arguments</h4>
             <td>::</td>
             <td><strong>atol</strong></td>
             <td>
-<p>LSQR: relative error in definition of <code>A</code></p>
+<p><code>LSQR</code>: relative error in definition of <code>A</code></p>
             </td>
         </tr>
         <tr>
@@ -2360,7 +2392,7 @@ <h4>Arguments</h4>
             <td>::</td>
             <td><strong>btol</strong></td>
             <td>
-<p>LSQR: relative error in definition of <code>b</code></p>
+<p><code>LSQR</code>: relative error in definition of <code>b</code></p>
             </td>
         </tr>
         <tr>
@@ -2375,7 +2407,8 @@ <h4>Arguments</h4>
             <td>::</td>
             <td><strong>conlim</strong></td>
             <td>
-<p>condition number of the matrix <code>Abar</code>.</p>
+<p><code>LSQR</code>: An upper limit on <code>cond(Abar)</code>, the apparent
+condition number of the matrix <code>Abar</code>.</p>
             </td>
         </tr>
         <tr>
@@ -2390,7 +2423,7 @@ <h4>Arguments</h4>
             <td>::</td>
             <td><strong>damp</strong></td>
             <td>
-<p>LSQR: damp factor</p>
+<p><code>LSQR</code>: damp factor</p>
             </td>
         </tr>
         <tr>
@@ -2405,7 +2438,7 @@ <h4>Arguments</h4>
             <td>::</td>
             <td><strong>itnlim</strong></td>
             <td>
-<p>LSQR: max iterations</p>
+<p><code>LSQR</code>: max iterations</p>
             </td>
         </tr>
         <tr>
@@ -2420,7 +2453,7 @@ <h4>Arguments</h4>
             <td>::</td>
             <td><strong>nout</strong></td>
             <td>
-<p>LSQR: output unit for printing</p>
+<p><code>LSQR</code>: output unit for printing</p>
             </td>
         </tr>
         <tr>

diff --git a/proc/backtracking_linesearch.html b/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.6% of total for procedures.">67 statements</a>
+                 title="11.7% of total for procedures.">67 statements</a>
             </li>
 
             <li class="list-inline-item" id="source-file">