Update documentation

jchristopherson · Apr 17, 2024 · 31e172a · 31e172a
1 parent b428dfa
commit 31e172a
Show file tree

Hide file tree

Showing 111 changed files with 1,426 additions and 841 deletions.
diff --git a/doc/index.html b/doc/index.html
@@ -140,7 +140,7 @@ <h3>Derived Types</h3>
             <p class="text-end">
               Documentation generated by
               <a href="https://github.com/Fortran-FOSS-Programmers/ford">FORD</a>
- on 2024-04-16 13:46              </p>
+ on 2024-04-16 20:51              </p>
           </div>
         </div>
         <br>

diff --git a/doc/interface/anova.html b/doc/interface/anova.html
@@ -74,7 +74,7 @@ <h1>anova
             <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="<p> 0.3% of total for procedures.</p>Including implementation: 146 statements,  9.1% of total for procedures.">5 statements</a>
+                 title="<p> 0.3% of total for procedures.</p>Including implementation: 146 statements,  8.8% of total for procedures.">5 statements</a>
             </li>
 
             <li class="list-inline-item" id="source-file">
@@ -237,7 +237,7 @@ <h4>Arguments</h4>
     <tbody>
         <tr>
             <td>
-              <span class="anchor" id="variable-x~16"></span>
+              <span class="anchor" id="variable-x~9"></span>
               real(kind=real64),
             </td>
 <td>intent(in)</td>
@@ -282,7 +282,7 @@ <h4>Arguments</h4>
     <tbody>
         <tr>
             <td>
-              <span class="anchor" id="variable-x~17"></span>
+              <span class="anchor" id="variable-x~10"></span>
               real(kind=real64),
             </td>
 <td>intent(in)</td>
@@ -357,7 +357,7 @@ <h4>Arguments</h4>
         </tr>
         <tr>
             <td>
-              <span class="anchor" id="variable-ymod~3"></span>
+              <span class="anchor" id="variable-ymod"></span>
               real(kind=real64),
             </td>
 <td>intent(in)</td>
@@ -372,7 +372,7 @@ <h4>Arguments</h4>
         </tr>
         <tr>
             <td>
-              <span class="anchor" id="variable-err~5"></span>
+              <span class="anchor" id="variable-err"></span>
               class(errors),
             </td>
 <td>intent(inout),</td>
@@ -416,7 +416,7 @@ <h4>
             <p class="text-end">
               Documentation generated by
               <a href="https://github.com/Fortran-FOSS-Programmers/ford">FORD</a>
- on 2024-04-16 13:46              </p>
+ on 2024-04-16 20:51              </p>
           </div>
         </div>
         <br>

diff --git a/doc/interface/bootstrap_resampling_routine.html b/doc/interface/bootstrap_resampling_routine.html
@@ -153,7 +153,7 @@ <h3>Arguments</h3>
     <tbody>
         <tr>
             <td>
-              <span class="anchor" id="variable-x~8"></span>
+              <span class="anchor" id="variable-x~23"></span>
               real(kind=real64),
             </td>
 <td>intent(in),</td>
@@ -205,7 +205,7 @@ <h3>Description</h3>
             <p class="text-end">
               Documentation generated by
               <a href="https://github.com/Fortran-FOSS-Programmers/ford">FORD</a>
- on 2024-04-16 13:46              </p>
+ on 2024-04-16 20:51              </p>
           </div>
         </div>
         <br>

diff --git a/doc/interface/bootstrap_statistic_routine.html b/doc/interface/bootstrap_statistic_routine.html
@@ -153,7 +153,7 @@ <h3>Arguments</h3>
     <tbody>
         <tr>
             <td>
-              <span class="anchor" id="variable-x~9"></span>
+              <span class="anchor" id="variable-x~24"></span>
               real(kind=real64),
             </td>
 <td>intent(in),</td>
@@ -169,7 +169,7 @@ <h3>Arguments</h3>
     </tbody>
   </table>
 
-      <h3>Return Value <span class="anchor" id="variable-rst~10"></span><small>real(kind=real64)</small></h3>
+      <h3>Return Value <span class="anchor" id="variable-rst~18"></span><small>real(kind=real64)</small></h3>
     <p>The resulting statistic.</p>
     <h3>Description</h3>
     <p>Defines the signature of a function for computing the desired
@@ -191,7 +191,7 @@ <h3>Description</h3>
             <p class="text-end">
               Documentation generated by
               <a href="https://github.com/Fortran-FOSS-Programmers/ford">FORD</a>
- on 2024-04-16 13:46              </p>
+ on 2024-04-16 20:51              </p>
           </div>
         </div>
         <br>

diff --git a/doc/interface/box_muller_sample.html b/doc/interface/box_muller_sample.html
@@ -262,7 +262,7 @@ <h4>Arguments</h4>
         </tr>
         <tr>
             <td>
-              <span class="anchor" id="variable-n"></span>
+              <span class="anchor" id="variable-n~37"></span>
               integer(kind=int32),
             </td>
 <td>intent(in)</td>
@@ -301,7 +301,7 @@ <h4>
             <p class="text-end">
               Documentation generated by
               <a href="https://github.com/Fortran-FOSS-Programmers/ford">FORD</a>
- on 2024-04-16 13:46              </p>
+ on 2024-04-16 20:51              </p>
           </div>
         </div>
         <br>

diff --git a/doc/interface/confidence_interval.html b/doc/interface/confidence_interval.html
@@ -174,7 +174,7 @@ <h4>Arguments</h4>
     <tbody>
         <tr>
             <td>
-              <span class="anchor" id="variable-dist~4"></span>
+              <span class="anchor" id="variable-dist"></span>
               class(<a href='..\type\distribution.html'>distribution</a>),
             </td>
 <td>intent(in)</td>
@@ -190,7 +190,7 @@ <h4>Arguments</h4>
         </tr>
         <tr>
             <td>
-              <span class="anchor" id="variable-alpha~12"></span>
+              <span class="anchor" id="variable-alpha"></span>
               real(kind=real64),
             </td>
 <td>intent(in)</td>
@@ -206,7 +206,7 @@ <h4>Arguments</h4>
         </tr>
         <tr>
             <td>
-              <span class="anchor" id="variable-s~3"></span>
+              <span class="anchor" id="variable-s"></span>
               real(kind=real64),
             </td>
 <td>intent(in)</td>
@@ -221,7 +221,7 @@ <h4>Arguments</h4>
         </tr>
         <tr>
             <td>
-              <span class="anchor" id="variable-n~36"></span>
+              <span class="anchor" id="variable-n~15"></span>
               integer(kind=int32),
             </td>
 <td>intent(in)</td>
@@ -265,7 +265,7 @@ <h4>Arguments</h4>
     <tbody>
         <tr>
             <td>
-              <span class="anchor" id="variable-dist~5"></span>
+              <span class="anchor" id="variable-dist~2"></span>
               class(<a href='..\type\distribution.html'>distribution</a>),
             </td>
 <td>intent(in)</td>
@@ -281,7 +281,7 @@ <h4>Arguments</h4>
         </tr>
         <tr>
             <td>
-              <span class="anchor" id="variable-alpha~13"></span>
+              <span class="anchor" id="variable-alpha~2"></span>
               real(kind=real64),
             </td>
 <td>intent(in)</td>
@@ -297,7 +297,7 @@ <h4>Arguments</h4>
         </tr>
         <tr>
             <td>
-              <span class="anchor" id="variable-x~51"></span>
+              <span class="anchor" id="variable-x~16"></span>
               real(kind=real64),
             </td>
 <td>intent(in)</td>
@@ -336,7 +336,7 @@ <h4>
             <p class="text-end">
               Documentation generated by
               <a href="https://github.com/Fortran-FOSS-Programmers/ford">FORD</a>
- on 2024-04-16 13:46              </p>
+ on 2024-04-16 20:51              </p>
           </div>
         </div>
         <br>

diff --git a/doc/interface/distribution_function.html b/doc/interface/distribution_function.html
@@ -168,7 +168,7 @@ <h3>Arguments</h3>
         </tr>
         <tr>
             <td>
-              <span class="anchor" id="variable-x~39"></span>
+              <span class="anchor" id="variable-x~46"></span>
               real(kind=real64),
             </td>
 <td>intent(in)</td>
@@ -184,7 +184,7 @@ <h3>Arguments</h3>
     </tbody>
   </table>
 
-      <h3>Return Value <span class="anchor" id="variable-rst~32"></span><small>real(kind=real64)</small></h3>
+      <h3>Return Value <span class="anchor" id="variable-rst~34"></span><small>real(kind=real64)</small></h3>
     <p>The value of the function.</p>
     <h3>Description</h3>
     <p>Defines the interface for a probability distribution function.</p>
@@ -205,7 +205,7 @@ <h3>Description</h3>
             <p class="text-end">
               Documentation generated by
               <a href="https://github.com/Fortran-FOSS-Programmers/ford">FORD</a>
- on 2024-04-16 13:46              </p>
+ on 2024-04-16 20:51              </p>
           </div>
         </div>
         <br>

diff --git a/doc/interface/distribution_property.html b/doc/interface/distribution_property.html
@@ -169,7 +169,7 @@ <h3>Arguments</h3>
     </tbody>
   </table>
 
-      <h3>Return Value <span class="anchor" id="variable-rst~33"></span><small>real(kind=real64)</small></h3>
+      <h3>Return Value <span class="anchor" id="variable-rst~35"></span><small>real(kind=real64)</small></h3>
     <p>The property value.</p>
     <h3>Description</h3>
     <p>Computes the value of a distribution property.</p>
@@ -190,7 +190,7 @@ <h3>Description</h3>
             <p class="text-end">
               Documentation generated by
               <a href="https://github.com/Fortran-FOSS-Programmers/ford">FORD</a>
- on 2024-04-16 13:46              </p>
+ on 2024-04-16 20:51              </p>
           </div>
         </div>
         <br>

diff --git a/doc/interface/iteration_update.html b/doc/interface/iteration_update.html
@@ -153,7 +153,7 @@ <h3>Arguments</h3>
     <tbody>
         <tr>
             <td>
-              <span class="anchor" id="variable-iter~2"></span>
+              <span class="anchor" id="variable-iter"></span>
               integer(kind=int32),
             </td>
 <td>intent(in)</td>
@@ -183,7 +183,7 @@ <h3>Arguments</h3>
         </tr>
         <tr>
             <td>
-              <span class="anchor" id="variable-resid~5"></span>
+              <span class="anchor" id="variable-resid~4"></span>
               real(kind=real64),
             </td>
 <td>intent(in)</td>
@@ -246,7 +246,7 @@ <h3>Arguments</h3>
             <p class="text-end">
               Documentation generated by
               <a href="https://github.com/Fortran-FOSS-Programmers/ford">FORD</a>
- on 2024-04-16 13:46              </p>
+ on 2024-04-16 20:51              </p>
           </div>
         </div>
         <br>

diff --git a/doc/interface/pooled_variance.html b/doc/interface/pooled_variance.html
@@ -74,7 +74,7 @@ <h1>pooled_variance
             <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="<p> 0.2% of total for procedures.</p>Including implementation: 32 statements,  2.0% of total for procedures.">4 statements</a>
+                 title="<p> 0.2% of total for procedures.</p>Including implementation: 32 statements,  1.9% of total for procedures.">4 statements</a>
             </li>
 
             <li class="list-inline-item" id="source-file">
@@ -231,7 +231,7 @@ <h4>Arguments</h4>
     <tbody>
         <tr>
             <td>
-              <span class="anchor" id="variable-x~28"></span>
+              <span class="anchor" id="variable-x~8"></span>
               type(<a href='..\type\array_container.html'>array_container</a>),
             </td>
 <td>intent(in),</td>
@@ -270,7 +270,7 @@ <h4>
             <p class="text-end">
               Documentation generated by
               <a href="https://github.com/Fortran-FOSS-Programmers/ford">FORD</a>
- on 2024-04-16 13:46              </p>
+ on 2024-04-16 20:51              </p>
           </div>
         </div>
         <br>

diff --git a/doc/interface/regression_function.html b/doc/interface/regression_function.html
@@ -183,7 +183,7 @@ <h3>Arguments</h3>
         </tr>
         <tr>
             <td>
-              <span class="anchor" id="variable-resid~4"></span>
+              <span class="anchor" id="variable-resid~3"></span>
               real(kind=real64),
             </td>
 <td>intent(out),</td>
@@ -231,7 +231,7 @@ <h3>Arguments</h3>
             <p class="text-end">
               Documentation generated by
               <a href="https://github.com/Fortran-FOSS-Programmers/ford">FORD</a>
- on 2024-04-16 13:46              </p>
+ on 2024-04-16 20:51              </p>
           </div>
         </div>
         <br>

diff --git a/doc/lists/files.html b/doc/lists/files.html
@@ -144,7 +144,7 @@ <h1>Source Files</h1>
             <p class="text-end">
               Documentation generated by
               <a href="https://github.com/Fortran-FOSS-Programmers/ford">FORD</a>
- on 2024-04-16 13:46              </p>
+ on 2024-04-16 20:51              </p>
           </div>
         </div>
         <br>

diff --git a/doc/lists/modules.html b/doc/lists/modules.html
@@ -161,7 +161,7 @@ <h1>Modules</h1>
             <p class="text-end">
               Documentation generated by
               <a href="https://github.com/Fortran-FOSS-Programmers/ford">FORD</a>
- on 2024-04-16 13:46              </p>
+ on 2024-04-16 20:51              </p>
           </div>
         </div>
         <br>

diff --git a/doc/lists/procedures.html b/doc/lists/procedures.html
@@ -91,7 +91,7 @@ <h1>Procedures</h1>
                  <td><a href='..\proc\bartletts_test.html'>bartletts_test</a></td>
                  <td><a href='..\module\fstats_hypothesis.html'>fstats_hypothesis</a></td>
                  <td>Subroutine</td>
-                 <td><p>Computes Bartlett's test statistic as follows.</p><a href="../proc/bartletts_test.html" class="pull-right"><emph>Read more&hellip;</emph></a></td>
+                 <td><p>Computes Bartlett's test statistic and associated probability.</p><a href="../proc/bartletts_test.html" class="pull-right"><emph>Read more&hellip;</emph></a></td>
                </tr>
 			   <tr>
                  <td><a href='..\proc\beta.html'>beta</a></td>
@@ -271,6 +271,12 @@ <h1>Procedures</h1>
                  <td><a href='..\module\fstats_regression.html'>fstats_regression</a></td>
                  <td>Subroutine</td>
                  <td><p>Computes the Jacobian matrix for a nonlinear regression problem.</p></td>
+               </tr>
+			   <tr>
+                 <td><a href='..\proc\levenes_test.html'>levenes_test</a></td>
+                 <td><a href='..\module\fstats_hypothesis.html'>fstats_hypothesis</a></td>
+                 <td>Subroutine</td>
+                 <td><p>Computes Levene's test statistic and associated probability.</p><a href="../proc/levenes_test.html" class="pull-right"><emph>Read more&hellip;</emph></a></td>
                </tr>
 			   <tr>
                  <td><a href='..\proc\linear_least_squares.html'>linear_least_squares</a></td>
@@ -446,7 +452,7 @@ <h1>Procedures</h1>
             <p class="text-end">
               Documentation generated by
               <a href="https://github.com/Fortran-FOSS-Programmers/ford">FORD</a>
- on 2024-04-16 13:46              </p>
+ on 2024-04-16 20:51              </p>
           </div>
         </div>
         <br>

diff --git a/doc/lists/types.html b/doc/lists/types.html
@@ -184,7 +184,7 @@ <h1>Derived Types</h1>
             <p class="text-end">
               Documentation generated by
               <a href="https://github.com/Fortran-FOSS-Programmers/ford">FORD</a>
- on 2024-04-16 13:46              </p>
+ on 2024-04-16 20:51              </p>
           </div>
         </div>
         <br>