From 57dda85533fbac18389a3ddc70e3640aa4484a91 Mon Sep 17 00:00:00 2001 From: Gilles Sadowski Date: Thu, 3 Mar 2022 12:02:58 +0100 Subject: [PATCH] HTML5 javadoc comments. As of Java 11, the "javadoc" command requires compliance. --- .../fitting/leastsquares/LevenbergMarquardtOptimizer.java | 3 ++- .../commons/math4/legacy/linear/RealLinearOperator.java | 2 +- .../legacy/ode/nonstiff/GraggBulirschStoerIntegrator.java | 3 ++- .../ode/nonstiff/GraggBulirschStoerStepInterpolator.java | 3 ++- .../org/apache/commons/math4/legacy/ode/package-info.java | 6 ++++-- .../math4/legacy/ode/sampling/FieldStepNormalizer.java | 3 ++- .../commons/math4/legacy/ode/sampling/StepNormalizer.java | 3 ++- .../commons/math4/legacy/stat/ranking/NaturalRanking.java | 3 ++- .../math4/legacy/fitting/leastsquares/MinpackTest.java | 2 +- .../gradient/NonLinearConjugateGradientOptimizerTest.java | 3 ++- .../commons/math4/transform/FastHadamardTransform.java | 6 ++++-- 11 files changed, 24 insertions(+), 13 deletions(-) diff --git a/commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/fitting/leastsquares/LevenbergMarquardtOptimizer.java b/commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/fitting/leastsquares/LevenbergMarquardtOptimizer.java index 14518e696..a1f37bd06 100644 --- a/commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/fitting/leastsquares/LevenbergMarquardtOptimizer.java +++ b/commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/fitting/leastsquares/LevenbergMarquardtOptimizer.java @@ -57,7 +57,8 @@ import org.apache.commons.numbers.core.Precision; * href="http://www.netlib.org/minpack/disclaimer">here, for convenience, it * is reproduced below. * - * + *
+ * *
MINPACK redistribution policy
* Minpack Copyright Notice (1999) University of Chicago. * All rights reserved diff --git a/commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/linear/RealLinearOperator.java b/commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/linear/RealLinearOperator.java index 2f5024d3b..358336396 100644 --- a/commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/linear/RealLinearOperator.java +++ b/commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/linear/RealLinearOperator.java @@ -38,7 +38,7 @@ import org.apache.commons.math4.legacy.exception.DimensionMismatchException; *
* *
- *
Barret et al. (1994)
+ *
Barret et al. (1994)
*
* R. Barrett, M. Berry, T. F. Chan, J. Demmel, J. M. Donato, J. Dongarra, * V. Eijkhout, R. Pozo, C. Romine and H. Van der Vorst, diff --git a/commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/ode/nonstiff/GraggBulirschStoerIntegrator.java b/commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/ode/nonstiff/GraggBulirschStoerIntegrator.java index 9916e0b6e..ba6dd0ec5 100644 --- a/commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/ode/nonstiff/GraggBulirschStoerIntegrator.java +++ b/commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/ode/nonstiff/GraggBulirschStoerIntegrator.java @@ -62,7 +62,8 @@ import org.apache.commons.math4.core.jdkmath.JdkMath; * href="http://www.unige.ch/~hairer/prog/licence.txt">here, for * convenience, it is reproduced below.

* - * + *
+ * * * *
odex redistribution policy
Copyright (c) 2004, Ernst Hairer
Redistribution and use in source and binary forms, with or diff --git a/commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/ode/nonstiff/GraggBulirschStoerStepInterpolator.java b/commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/ode/nonstiff/GraggBulirschStoerStepInterpolator.java index 41f5de47d..7c095ecfa 100644 --- a/commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/ode/nonstiff/GraggBulirschStoerStepInterpolator.java +++ b/commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/ode/nonstiff/GraggBulirschStoerStepInterpolator.java @@ -42,7 +42,8 @@ import org.apache.commons.math4.core.jdkmath.JdkMath; * href="http://www.unige.ch/~hairer/prog/licence.txt">here, for * convenience, it is reproduced below.

* - * + *
+ * * * *
odex redistribution policy
Copyright (c) 2004, Ernst Hairer
Redistribution and use in source and binary forms, with or diff --git a/commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/ode/package-info.java b/commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/ode/package-info.java index 11acd927e..73e69744d 100644 --- a/commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/ode/package-info.java +++ b/commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/ode/package-info.java @@ -127,7 +127,8 @@ * automatic guess is wrong. *

* - * + *
+ * * * * @@ -138,7 +139,8 @@ * *
Fixed Step Integrators
Fixed Step Integrators
NameOrder
{@link org.apache.commons.math4.legacy.ode.nonstiff.EulerIntegrator Euler}1
{@link org.apache.commons.math4.legacy.ode.nonstiff.LutherIntegrator Luther}6
* - * + *
+ * * * * diff --git a/commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/ode/sampling/FieldStepNormalizer.java b/commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/ode/sampling/FieldStepNormalizer.java index 94cd515d8..15b1a5267 100644 --- a/commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/ode/sampling/FieldStepNormalizer.java +++ b/commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/ode/sampling/FieldStepNormalizer.java @@ -42,7 +42,8 @@ import org.apache.commons.numbers.core.Precision; * it needs (time steps longer or shorter than the fixed time step and * non-integer ratios are all allowed).

* - *
Adaptive Stepsize Integrators
Adaptive Stepsize Integrators
NameIntegration OrderError Estimation Order
{@link org.apache.commons.math4.legacy.ode.nonstiff.HighamHall54Integrator Higham and Hall}54
+ *
+ * * * * diff --git a/commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/ode/sampling/StepNormalizer.java b/commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/ode/sampling/StepNormalizer.java index 636d9eeee..296295a0c 100644 --- a/commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/ode/sampling/StepNormalizer.java +++ b/commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/ode/sampling/StepNormalizer.java @@ -40,7 +40,8 @@ import org.apache.commons.numbers.core.Precision; * it needs (time steps longer or shorter than the fixed time step and * non-integer ratios are all allowed).

* - *
Examples (step size = 0.5)
Examples (step size = 0.5)
Start timeEnd timeDirection{@link StepNormalizerMode Mode}
+ *
+ * * * * diff --git a/commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/stat/ranking/NaturalRanking.java b/commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/stat/ranking/NaturalRanking.java index d1103fe94..31c081dca 100644 --- a/commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/stat/ranking/NaturalRanking.java +++ b/commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/stat/ranking/NaturalRanking.java @@ -41,7 +41,8 @@ import org.apache.commons.math4.core.jdkmath.JdkMath; * {@link UniformRandomProvider random generator} may be supplied as a * constructor argument.

*

Examples: - *

Examples (step size = 0.5)
Examples (step size = 0.5)
Start timeEnd timeDirection{@link StepNormalizerMode Mode}
+ *
+ * * diff --git a/commons-math-legacy/src/test/java/org/apache/commons/math4/legacy/fitting/leastsquares/MinpackTest.java b/commons-math-legacy/src/test/java/org/apache/commons/math4/legacy/fitting/leastsquares/MinpackTest.java index 2eb7d187e..035d61b13 100644 --- a/commons-math-legacy/src/test/java/org/apache/commons/math4/legacy/fitting/leastsquares/MinpackTest.java +++ b/commons-math-legacy/src/test/java/org/apache/commons/math4/legacy/fitting/leastsquares/MinpackTest.java @@ -36,7 +36,7 @@ import org.junit.Test; * href="http://www.netlib.org/minpack/disclaimer">here, for * convenience, it is reproduced below.

- *
Examples
* Input data: (20, 17, 30, 42.3, 17, 50, Double.NaN, Double.NEGATIVE_INFINITY, 17) *
+ *
*
* Minpack Copyright Notice (1999) University of Chicago. * All rights reserved diff --git a/commons-math-legacy/src/test/java/org/apache/commons/math4/legacy/optim/nonlinear/scalar/gradient/NonLinearConjugateGradientOptimizerTest.java b/commons-math-legacy/src/test/java/org/apache/commons/math4/legacy/optim/nonlinear/scalar/gradient/NonLinearConjugateGradientOptimizerTest.java index 8f7c13f44..acd843f7f 100644 --- a/commons-math-legacy/src/test/java/org/apache/commons/math4/legacy/optim/nonlinear/scalar/gradient/NonLinearConjugateGradientOptimizerTest.java +++ b/commons-math-legacy/src/test/java/org/apache/commons/math4/legacy/optim/nonlinear/scalar/gradient/NonLinearConjugateGradientOptimizerTest.java @@ -42,7 +42,8 @@ import org.junit.Test; * href="http://www.netlib.org/minpack/disclaimer">here, for * convenience, it is reproduced below.

* - * + *
+ * *
MINPACK redistribution policy
* Minpack Copyright Notice (1999) University of Chicago. * All rights reserved diff --git a/commons-math-transform/src/main/java/org/apache/commons/math4/transform/FastHadamardTransform.java b/commons-math-transform/src/main/java/org/apache/commons/math4/transform/FastHadamardTransform.java index c6702117a..f0c548655 100644 --- a/commons-math-transform/src/main/java/org/apache/commons/math4/transform/FastHadamardTransform.java +++ b/commons-math-transform/src/main/java/org/apache/commons/math4/transform/FastHadamardTransform.java @@ -81,7 +81,8 @@ public class FastHadamardTransform implements RealTransform { *
  • y is the output vector (Fast Hadamard transform of x),
    • *
  • a and b are helper rows.
    • * - * + *
    + * * * * @@ -173,7 +174,8 @@ public class FastHadamardTransform implements RealTransform { *
  • Algorithm from chipcenter.
    • * *

    Visually

    - *
    manual calculation for N=8
    x
    + *
    + * * * *
    chipcenter algorithm
    0123