Update comments and documentation

jchristopherson · Apr 16, 2024 · cf4d29e · cf4d29e
1 parent f93b8a3
commit cf4d29e
Show file tree

Hide file tree

Showing 114 changed files with 4,253 additions and 2,487 deletions.
diff --git a/doc/index.html b/doc/index.html
@@ -108,7 +108,7 @@ <h3>Modules</h3>
           <div class="col-xs-6 col-sm-3">
             <div>
               <h3>Procedures</h3>
-              <ul><li><a href='proc\adjusted_r_squared.html'>adjusted_r_squared</a></li><li><a href='proc\allan_variance.html'>allan_variance</a></li><li><a href='interface\anova.html'>anova</a></li><li><a href='proc\beta.html'>beta</a></li><li><a href='proc\bootstrap.html'>bootstrap</a></li><li><a href='proc\bootstrap_linear_least_squares.html'>bootstrap_linear_least_squares</a></li><li><a href='proc\bootstrap_nonlinear_least_squares.html'>bootstrap_nonlinear_least_squares</a></li><li><a href='interface\bootstrap_resampling_routine.html'>bootstrap_resampling_routine</a></li><li><a href='interface\bootstrap_statistic_routine.html'>bootstrap_statistic_routine</a></li><li><a href='interface\box_muller_sample.html'>box_muller_sample</a></li></ul>
+              <ul><li><a href='proc\adjusted_r_squared.html'>adjusted_r_squared</a></li><li><a href='proc\allan_variance.html'>allan_variance</a></li><li><a href='interface\anova.html'>anova</a></li><li><a href='proc\bartletts_test.html'>bartletts_test</a></li><li><a href='proc\beta.html'>beta</a></li><li><a href='proc\bootstrap.html'>bootstrap</a></li><li><a href='proc\bootstrap_linear_least_squares.html'>bootstrap_linear_least_squares</a></li><li><a href='proc\bootstrap_nonlinear_least_squares.html'>bootstrap_nonlinear_least_squares</a></li><li><a href='interface\bootstrap_resampling_routine.html'>bootstrap_resampling_routine</a></li><li><a href='interface\bootstrap_statistic_routine.html'>bootstrap_statistic_routine</a></li></ul>
             </div>
             <div>
               <ul>
@@ -119,7 +119,7 @@ <h3>Procedures</h3>
           <div class="col-xs-6 col-sm-3">
             <div>
               <h3>Derived Types</h3>
-              <ul><li><a href='type\anova_factor.html'>anova_factor</a></li><li><a href='type\binomial_distribution.html'>binomial_distribution</a></li><li><a href='type\bootstrap_regression_statistics.html'>bootstrap_regression_statistics</a></li><li><a href='type\bootstrap_statistics.html'>bootstrap_statistics</a></li><li><a href='type\chi_squared_distribution.html'>chi_squared_distribution</a></li><li><a href='type\convergence_info.html'>convergence_info</a></li><li><a href='type\distribution.html'>distribution</a></li><li><a href='type\f_distribution.html'>f_distribution</a></li><li><a href='type\iteration_controls.html'>iteration_controls</a></li><li><a href='type\lm_solver_options.html'>lm_solver_options</a></li></ul>
+              <ul><li><a href='type\anova_factor.html'>anova_factor</a></li><li><a href='type\array_container.html'>array_container</a></li><li><a href='type\binomial_distribution.html'>binomial_distribution</a></li><li><a href='type\bootstrap_regression_statistics.html'>bootstrap_regression_statistics</a></li><li><a href='type\bootstrap_statistics.html'>bootstrap_statistics</a></li><li><a href='type\chi_squared_distribution.html'>chi_squared_distribution</a></li><li><a href='type\convergence_info.html'>convergence_info</a></li><li><a href='type\distribution.html'>distribution</a></li><li><a href='type\f_distribution.html'>f_distribution</a></li><li><a href='type\iteration_controls.html'>iteration_controls</a></li></ul>
             </div>
             <div>
               <ul>
@@ -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-03-26 07:52              </p>
+ on 2024-04-16 13:46              </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.3% of total for procedures.">5 statements</a>
+                 title="<p> 0.3% of total for procedures.</p>Including implementation: 146 statements,  9.1% 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~51"></span>
+              <span class="anchor" id="variable-x~16"></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~52"></span>
+              <span class="anchor" id="variable-x~17"></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~5"></span>
+              <span class="anchor" id="variable-ymod~3"></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~24"></span>
+              <span class="anchor" id="variable-err~5"></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-03-26 07:52              </p>
+ on 2024-04-16 13:46              </p>
           </div>
         </div>
         <br>

diff --git a/doc/interface/bootstrap_resampling_routine.html b/doc/interface/bootstrap_resampling_routine.html
@@ -74,7 +74,7 @@ <h1>bootstrap_resampling_routine
             <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=" 0.8% of total for procedures.">12 statements</a>
+                 title=" 0.7% of total for procedures.">12 statements</a>
             </li>
 
             <li class="list-inline-item" id="source-file">
@@ -153,7 +153,7 @@ <h3>Arguments</h3>
     <tbody>
         <tr>
             <td>
-              <span class="anchor" id="variable-x"></span>
+              <span class="anchor" id="variable-x~8"></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-03-26 07:52              </p>
+ on 2024-04-16 13:46              </p>
           </div>
         </div>
         <br>

diff --git a/doc/interface/bootstrap_statistic_routine.html b/doc/interface/bootstrap_statistic_routine.html
@@ -74,7 +74,7 @@ <h1>bootstrap_statistic_routine
             <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=" 0.8% of total for procedures.">12 statements</a>
+                 title=" 0.7% of total for procedures.">12 statements</a>
             </li>
 
             <li class="list-inline-item" id="source-file">
@@ -153,7 +153,7 @@ <h3>Arguments</h3>
     <tbody>
         <tr>
             <td>
-              <span class="anchor" id="variable-x~2"></span>
+              <span class="anchor" id="variable-x~9"></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"></span><small>real(kind=real64)</small></h3>
+      <h3>Return Value <span class="anchor" id="variable-rst~10"></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-03-26 07:52              </p>
+ on 2024-04-16 13:46              </p>
           </div>
         </div>
         <br>

diff --git a/doc/interface/box_muller_sample.html b/doc/interface/box_muller_sample.html
@@ -74,7 +74,7 @@ <h1>box_muller_sample
             <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: 31 statements,  2.0% of total for procedures.">4 statements</a>
+                 title="<p> 0.2% of total for procedures.</p>Including implementation: 31 statements,  1.9% of total for procedures.">4 statements</a>
             </li>
 
             <li class="list-inline-item" id="source-file">
@@ -262,7 +262,7 @@ <h4>Arguments</h4>
         </tr>
         <tr>
             <td>
-              <span class="anchor" id="variable-n~13"></span>
+              <span class="anchor" id="variable-n"></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-03-26 07:52              </p>
+ on 2024-04-16 13:46              </p>
           </div>
         </div>
         <br>

diff --git a/doc/interface/confidence_interval.html b/doc/interface/confidence_interval.html
@@ -74,7 +74,7 @@ <h1>confidence_interval
             <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: 34 statements,  2.2% of total for procedures.">4 statements</a>
+                 title="<p> 0.2% of total for procedures.</p>Including implementation: 34 statements,  2.1% of total for procedures.">4 statements</a>
             </li>
 
             <li class="list-inline-item" id="source-file">
@@ -190,7 +190,7 @@ <h4>Arguments</h4>
         </tr>
         <tr>
             <td>
-              <span class="anchor" id="variable-alpha~11"></span>
+              <span class="anchor" id="variable-alpha~12"></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~27"></span>
+              <span class="anchor" id="variable-n~36"></span>
               integer(kind=int32),
             </td>
 <td>intent(in)</td>
@@ -281,7 +281,7 @@ <h4>Arguments</h4>
         </tr>
         <tr>
             <td>
-              <span class="anchor" id="variable-alpha~12"></span>
+              <span class="anchor" id="variable-alpha~13"></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~44"></span>
+              <span class="anchor" id="variable-x~51"></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-03-26 07:52              </p>
+ on 2024-04-16 13:46              </p>
           </div>
         </div>
         <br>

diff --git a/doc/interface/distribution_function.html b/doc/interface/distribution_function.html
@@ -74,7 +74,7 @@ <h1>distribution_function
             <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=" 1.0% of total for procedures.">15 statements</a>
+                 title=" 0.9% of total for procedures.">15 statements</a>
             </li>
 
             <li class="list-inline-item" id="source-file">
@@ -168,7 +168,7 @@ <h3>Arguments</h3>
         </tr>
         <tr>
             <td>
-              <span class="anchor" id="variable-x~15"></span>
+              <span class="anchor" id="variable-x~39"></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~10"></span><small>real(kind=real64)</small></h3>
+      <h3>Return Value <span class="anchor" id="variable-rst~32"></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-03-26 07:52              </p>
+ on 2024-04-16 13:46              </p>
           </div>
         </div>
         <br>

diff --git a/doc/interface/distribution_property.html b/doc/interface/distribution_property.html
@@ -74,7 +74,7 @@ <h1>distribution_property
             <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=" 1.0% of total for procedures.">15 statements</a>
+                 title=" 0.9% of total for procedures.">15 statements</a>
             </li>
 
             <li class="list-inline-item" id="source-file">
@@ -169,7 +169,7 @@ <h3>Arguments</h3>
     </tbody>
   </table>
 
-      <h3>Return Value <span class="anchor" id="variable-rst~11"></span><small>real(kind=real64)</small></h3>
+      <h3>Return Value <span class="anchor" id="variable-rst~33"></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-03-26 07:52              </p>
+ on 2024-04-16 13:46              </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"></span>
+              <span class="anchor" id="variable-iter~2"></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~4"></span>
+              <span class="anchor" id="variable-resid~5"></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-03-26 07:52              </p>
+ on 2024-04-16 13:46              </p>
           </div>
         </div>
         <br>