You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by ah...@apache.org on 2022/06/07 12:41:02 UTC
[commons-math] 01/03: Correct javadoc tags to allow build on JDK 17
This is an automated email from the ASF dual-hosted git repository.
aherbert pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-math.git
commit 2f8b4da5b93ce352c44b040a0942e520edbde7e0
Author: aherbert <ah...@apache.org>
AuthorDate: Tue Jun 7 12:58:37 2022 +0100
Correct javadoc tags to allow build on JDK 17
Remove heading tags
Correctly close paragraph tags
---
.../commons/math4/legacy/linear/ConjugateGradient.java | 8 ++++----
.../org/apache/commons/math4/legacy/linear/FieldVector.java | 2 +-
.../java/org/apache/commons/math4/legacy/linear/SymmLQ.java | 12 ++++++------
.../legacy/ode/nonstiff/AdamsBashforthFieldIntegrator.java | 2 +-
.../math4/legacy/ode/nonstiff/AdamsBashforthIntegrator.java | 2 +-
.../legacy/ode/nonstiff/AdamsMoultonFieldIntegrator.java | 2 +-
.../math4/legacy/ode/nonstiff/AdamsMoultonIntegrator.java | 2 +-
.../commons/math4/legacy/stat/descriptive/package-info.java | 6 +++---
8 files changed, 18 insertions(+), 18 deletions(-)
diff --git a/commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/linear/ConjugateGradient.java b/commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/linear/ConjugateGradient.java
index 20a198505..ed987e9b0 100644
--- a/commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/linear/ConjugateGradient.java
+++ b/commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/linear/ConjugateGradient.java
@@ -28,7 +28,7 @@ import org.apache.commons.math4.legacy.exception.util.ExceptionContext;
* href="#BARR1994">Barrett et al. (1994)</a> (figure 2.5). The linear system at
* hand is A · x = b, and the residual is r = b - A · x.
* </p>
- * <h3><a id="stopcrit">Default stopping criterion</a></h3>
+ * <p><b><a id="stopcrit">Default stopping criterion</a></b></p>
* <p>
* A default stopping criterion is implemented. The iterations stop when || r ||
* ≤ δ || b ||, where b is the right-hand side vector, r the current
@@ -37,13 +37,13 @@ import org.apache.commons.math4.legacy.exception.util.ExceptionContext;
* differ from the true residual due to rounding-off errors (see e.g. <a
* href="#STRA2002">Strakos and Tichy, 2002</a>).
* </p>
- * <h3>Iteration count</h3>
+ * <p><b>Iteration count</b></p>
* <p>
* In the present context, an iteration should be understood as one evaluation
* of the matrix-vector product A · x. The initialization phase therefore
* counts as one iteration.
* </p>
- * <h3><a id="context">Exception context</a></h3>
+ * <p><b><a id="context">Exception context</a></b></p>
* <p>
* Besides standard {@link DimensionMismatchException}, this class might throw
* {@link NonPositiveDefiniteOperatorException} if the linear operator or
@@ -55,7 +55,7 @@ import org.apache.commons.math4.legacy.exception.util.ExceptionContext;
* x<sup>T</sup> · L · x < 0.</li>
* </ul>
*
- * <h3>References</h3>
+ * <p><b>References</b></p>
* <dl>
* <dt><a id="BARR1994">Barret et al. (1994)</a></dt>
* <dd>R. Barrett, M. Berry, T. F. Chan, J. Demmel, J. M. Donato, J. Dongarra,
diff --git a/commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/linear/FieldVector.java b/commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/linear/FieldVector.java
index cc917a5a3..a2da59bb2 100644
--- a/commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/linear/FieldVector.java
+++ b/commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/linear/FieldVector.java
@@ -49,7 +49,7 @@ import org.apache.commons.math4.legacy.exception.OutOfRangeException;
* of <code>FieldVector</code> implementations to make sure no null elements
* are inserted into the vector. This must be done in all constructors and
* all setters.
- * <p>
+ * </p>
*
* @param <T> the type of the field elements
* @since 2.0
diff --git a/commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/linear/SymmLQ.java b/commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/linear/SymmLQ.java
index 33925213b..cf1127cb8 100644
--- a/commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/linear/SymmLQ.java
+++ b/commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/linear/SymmLQ.java
@@ -46,7 +46,7 @@ import org.apache.commons.math4.core.jdkmath.JdkMath;
* definite (but <em>must</em> be self-adjoint). The work per iteration is very
* slightly less if shift = 0.
* </p>
- * <h3>Preconditioning</h3>
+ * <p><b>Preconditioning</b></p>
* <p>
* Preconditioning may reduce the number of iterations required. The solver may
* be provided with a positive definite preconditioner
@@ -75,14 +75,14 @@ import org.apache.commons.math4.core.jdkmath.JdkMath;
* the <em>preconditioned</em>, updated residual, ||P · r||, not the norm
* of the <em>true</em> residual ||r||.
* </p>
- * <h3><a id="stopcrit">Default stopping criterion</a></h3>
+ * <p><b><a id="stopcrit">Default stopping criterion</a></b></p>
* <p>
* A default stopping criterion is implemented. The iterations stop when || rhat
* || ≤ δ || Ahat || || xhat ||, where xhat is the current estimate of
* the solution of the transformed system, rhat the current estimate of the
* corresponding residual, and δ a user-specified tolerance.
* </p>
- * <h3>Iteration count</h3>
+ * <p><b>Iteration count</b></p>
* <p>
* In the present context, an iteration should be understood as one evaluation
* of the matrix-vector product A · x. The initialization phase therefore
@@ -97,7 +97,7 @@ import org.apache.commons.math4.core.jdkmath.JdkMath;
* the original FOTRAN code, where the initialization phase was <em>not</em>
* taken into account.
* </p>
- * <h3><a id="initguess">Initial guess of the solution</a></h3>
+ * <p><b><a id="initguess">Initial guess of the solution</a></b></p>
* <p>
* The {@code x} parameter in
* <ul>
@@ -112,7 +112,7 @@ import org.apache.commons.math4.core.jdkmath.JdkMath;
* should compute r<sub>0</sub> = b - A · x, solve A · dx = r0,
* and set x = x<sub>0</sub> + dx.
*
- * <h3><a id="context">Exception context</a></h3>
+ * <p><b><a id="context">Exception context</a></b></p>
* <p>
* Besides standard {@link DimensionMismatchException}, this class might throw
* {@link NonSelfAdjointOperatorException} if the linear operator or the
@@ -137,7 +137,7 @@ import org.apache.commons.math4.core.jdkmath.JdkMath;
* that x<sup>T</sup> · L · x < 0.</li>
* </ul>
*
- * <h3>References</h3>
+ * <p><b>References</b></p>
* <dl>
* <dt><a id="PAIG1975">Paige and Saunders (1975)</a></dt>
* <dd>C. C. Paige and M. A. Saunders, <a
diff --git a/commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/ode/nonstiff/AdamsBashforthFieldIntegrator.java b/commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/ode/nonstiff/AdamsBashforthFieldIntegrator.java
index e85095f7d..757bc460c 100644
--- a/commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/ode/nonstiff/AdamsBashforthFieldIntegrator.java
+++ b/commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/ode/nonstiff/AdamsBashforthFieldIntegrator.java
@@ -53,7 +53,7 @@ import org.apache.commons.math4.legacy.core.MathArrays;
*
* <p>A k-steps Adams-Bashforth method is of order k.</p>
*
- * <h3>Implementation details</h3>
+ * <p><b>Implementation details</b></p>
*
* <p>We define scaled derivatives s<sub>i</sub>(n) at step n as:
* <div style="white-space: pre"><code>
diff --git a/commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/ode/nonstiff/AdamsBashforthIntegrator.java b/commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/ode/nonstiff/AdamsBashforthIntegrator.java
index c1ac06c8d..a3ef59193 100644
--- a/commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/ode/nonstiff/AdamsBashforthIntegrator.java
+++ b/commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/ode/nonstiff/AdamsBashforthIntegrator.java
@@ -51,7 +51,7 @@ import org.apache.commons.math4.core.jdkmath.JdkMath;
*
* <p>A k-steps Adams-Bashforth method is of order k.</p>
*
- * <h3>Implementation details</h3>
+ * <p><b>Implementation details</b></p>
*
* <p>We define scaled derivatives s<sub>i</sub>(n) at step n as:
* <div style="white-space: pre"><code>
diff --git a/commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/ode/nonstiff/AdamsMoultonFieldIntegrator.java b/commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/ode/nonstiff/AdamsMoultonFieldIntegrator.java
index 32ceee121..94ba8f7ef 100644
--- a/commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/ode/nonstiff/AdamsMoultonFieldIntegrator.java
+++ b/commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/ode/nonstiff/AdamsMoultonFieldIntegrator.java
@@ -58,7 +58,7 @@ import org.apache.commons.math4.legacy.core.MathArrays;
*
* <p>A k-steps Adams-Moulton method is of order k+1.</p>
*
- * <h3>Implementation details</h3>
+ * <p><b>Implementation details</b></p>
*
* <p>We define scaled derivatives s<sub>i</sub>(n) at step n as:
* <div style="white-space: pre"><code>
diff --git a/commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/ode/nonstiff/AdamsMoultonIntegrator.java b/commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/ode/nonstiff/AdamsMoultonIntegrator.java
index 20b05db0e..f44d30acd 100644
--- a/commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/ode/nonstiff/AdamsMoultonIntegrator.java
+++ b/commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/ode/nonstiff/AdamsMoultonIntegrator.java
@@ -56,7 +56,7 @@ import org.apache.commons.math4.core.jdkmath.JdkMath;
*
* <p>A k-steps Adams-Moulton method is of order k+1.</p>
*
- * <h3>Implementation details</h3>
+ * <p><b>Implementation details</b></p>
*
* <p>We define scaled derivatives s<sub>i</sub>(n) at step n as:
* <div style="white-space: pre"><code>
diff --git a/commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/stat/descriptive/package-info.java b/commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/stat/descriptive/package-info.java
index 1280898ed..1f19eb4bf 100644
--- a/commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/stat/descriptive/package-info.java
+++ b/commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/stat/descriptive/package-info.java
@@ -18,16 +18,16 @@
*
* Generic univariate summary statistic objects.
*
- * <h3>UnivariateStatistic API Usage Examples:</h3>
+ * <p><b>UnivariateStatistic API Usage Examples:</b></p>
*
- * <h4>UnivariateStatistic:</h4>
+ * <p><b><em>UnivariateStatistic:</em></b></p>
* <code>/∗ evaluation approach ∗/<br>
* double[] values = new double[] { 1, 2, 3, 4, 5 };<br>
* <span style="font-weight: bold;">UnivariateStatistic stat = new Mean();</span><br>
* out.println("mean = " + <span style="font-weight: bold;">stat.evaluate(values)</span>);<br>
* </code>
*
- * <h4>StorelessUnivariateStatistic:</h4>
+ * <p><b><em>StorelessUnivariateStatistic:</em></b></p>
* <code>/∗ incremental approach ∗/<br>
* double[] values = new double[] { 1, 2, 3, 4, 5 };<br>
* <span style="font-weight: bold;">StorelessUnivariateStatistic stat = new Mean();</span><br>