This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-math.git
The following commit(s) were added to refs/heads/master by this push:
new af0c6732b Javadoc
af0c6732b is described below
commit af0c6732b4ec335ccfc3808a856c53e49bd01482
Author: Gary Gregory <[email protected]>
AuthorDate: Mon Mar 23 11:39:55 2026 -0700
Javadoc
---
.../main/java/org/apache/commons/math4/legacy/core/MathArrays.java | 2 +-
.../main/java/org/apache/commons/math4/legacy/core/dfp/DfpField.java | 2 +-
.../apache/commons/math4/legacy/exception/util/LocalizedFormats.java | 2 +-
.../apache/commons/math4/legacy/analysis/solvers/AllowedSolution.java | 2 +-
.../math4/legacy/fitting/leastsquares/GaussNewtonOptimizer.java | 2 +-
.../commons/math4/legacy/ml/clustering/KMeansPlusPlusClusterer.java | 2 +-
.../main/java/org/apache/commons/math4/legacy/ode/events/Action.java | 2 +-
.../java/org/apache/commons/math4/legacy/ode/events/FilterType.java | 3 +--
.../commons/math4/legacy/ode/sampling/StepNormalizerBounds.java | 2 +-
.../apache/commons/math4/legacy/ode/sampling/StepNormalizerMode.java | 2 +-
.../apache/commons/math4/legacy/optim/linear/PivotSelectionRule.java | 2 +-
.../org/apache/commons/math4/legacy/optim/linear/Relationship.java | 2 +-
.../apache/commons/math4/legacy/optim/nonlinear/scalar/GoalType.java | 2 +-
.../scalar/gradient/NonLinearConjugateGradientOptimizer.java | 2 +-
.../commons/math4/legacy/stat/descriptive/ResizableDoubleArray.java | 2 +-
.../commons/math4/legacy/stat/descriptive/moment/SemiVariance.java | 2 +-
.../commons/math4/legacy/optim/nonlinear/scalar/TestFunction.java | 2 +-
.../java/org/apache/commons/math4/neuralnet/SquareNeighbourhood.java | 2 +-
.../org/apache/commons/math4/neuralnet/twod/NeuronSquareMesh2D.java | 4 ++--
19 files changed, 20 insertions(+), 21 deletions(-)
diff --git
a/commons-math-legacy-core/src/main/java/org/apache/commons/math4/legacy/core/MathArrays.java
b/commons-math-legacy-core/src/main/java/org/apache/commons/math4/legacy/core/MathArrays.java
index 7d69aa739..8d10992da 100644
---
a/commons-math-legacy-core/src/main/java/org/apache/commons/math4/legacy/core/MathArrays.java
+++
b/commons-math-legacy-core/src/main/java/org/apache/commons/math4/legacy/core/MathArrays.java
@@ -286,7 +286,7 @@ public final class MathArrays {
}
/**
- * Specification of ordering direction.
+ * Enumerates specifications of ordering directions.
*/
public enum OrderDirection {
/** Constant for increasing direction. */
diff --git
a/commons-math-legacy-core/src/main/java/org/apache/commons/math4/legacy/core/dfp/DfpField.java
b/commons-math-legacy-core/src/main/java/org/apache/commons/math4/legacy/core/dfp/DfpField.java
index 9d82d44ef..26af00942 100644
---
a/commons-math-legacy-core/src/main/java/org/apache/commons/math4/legacy/core/dfp/DfpField.java
+++
b/commons-math-legacy-core/src/main/java/org/apache/commons/math4/legacy/core/dfp/DfpField.java
@@ -25,7 +25,7 @@ import org.apache.commons.math4.legacy.core.FieldElement;
*/
public class DfpField implements Field<Dfp> {
- /** Enumerate for rounding modes. */
+ /** Enumerates rounding modes. */
public enum RoundingMode {
/** Rounds toward zero (truncation). */
diff --git
a/commons-math-legacy-exception/src/main/java/org/apache/commons/math4/legacy/exception/util/LocalizedFormats.java
b/commons-math-legacy-exception/src/main/java/org/apache/commons/math4/legacy/exception/util/LocalizedFormats.java
index 5420bf0c5..730b53efb 100644
---
a/commons-math-legacy-exception/src/main/java/org/apache/commons/math4/legacy/exception/util/LocalizedFormats.java
+++
b/commons-math-legacy-exception/src/main/java/org/apache/commons/math4/legacy/exception/util/LocalizedFormats.java
@@ -21,7 +21,7 @@ import java.util.MissingResourceException;
import java.util.ResourceBundle;
/**
- * Enumeration for localized messages formats used in exceptions messages.
+ * Enumerates localized messages formats used in exceptions messages.
* <p>
* The constants in this enumeration represent the available
* formats as localized strings. These formats are intended to be
diff --git
a/commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/analysis/solvers/AllowedSolution.java
b/commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/analysis/solvers/AllowedSolution.java
index 8e94fbc2d..8398fa372 100644
---
a/commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/analysis/solvers/AllowedSolution.java
+++
b/commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/analysis/solvers/AllowedSolution.java
@@ -18,7 +18,7 @@
package org.apache.commons.math4.legacy.analysis.solvers;
-/** The kinds of solutions that a {@link BracketedUnivariateSolver
+/** Enumerates the kinds of solutions that a {@link BracketedUnivariateSolver
* (bracketed univariate real) root-finding algorithm} may accept as solutions.
* This basically controls whether or not under-approximations and
* over-approximations are allowed.
diff --git
a/commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/fitting/leastsquares/GaussNewtonOptimizer.java
b/commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/fitting/leastsquares/GaussNewtonOptimizer.java
index ea68f98be..fee31c7ec 100644
---
a/commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/fitting/leastsquares/GaussNewtonOptimizer.java
+++
b/commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/fitting/leastsquares/GaussNewtonOptimizer.java
@@ -48,7 +48,7 @@ import org.apache.commons.math4.legacy.core.Pair;
*/
public class GaussNewtonOptimizer implements LeastSquaresOptimizer {
- /** The decomposition algorithm to use to solve the normal equations. */
+ /** Enumerates the decomposition algorithm to use to solve the normal
equations. */
//TODO move to linear package and expand options?
public enum Decomposition {
/**
diff --git
a/commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/ml/clustering/KMeansPlusPlusClusterer.java
b/commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/ml/clustering/KMeansPlusPlusClusterer.java
index 99c614b3b..6996efa2c 100644
---
a/commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/ml/clustering/KMeansPlusPlusClusterer.java
+++
b/commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/ml/clustering/KMeansPlusPlusClusterer.java
@@ -40,7 +40,7 @@ import java.util.List;
*/
public class KMeansPlusPlusClusterer<T extends Clusterable> extends
Clusterer<T> {
- /** Strategies to use for replacing an empty cluster. */
+ /** Enumerates strategies to use for replacing an empty cluster. */
public enum EmptyClusterStrategy {
/** Split the cluster with largest distance variance. */
diff --git
a/commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/ode/events/Action.java
b/commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/ode/events/Action.java
index 300d8a6c6..6e8d0aced 100644
---
a/commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/ode/events/Action.java
+++
b/commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/ode/events/Action.java
@@ -17,7 +17,7 @@
package org.apache.commons.math4.legacy.ode.events;
-/** Enumerate for actions to be performed when an event occurs during ODE
integration.
+/** Enumerates for actions to be performed when an event occurs during ODE
integration.
* @since 3.6
*/
public enum Action {
diff --git
a/commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/ode/events/FilterType.java
b/commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/ode/events/FilterType.java
index 439af4c8d..ac27000b8 100644
---
a/commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/ode/events/FilterType.java
+++
b/commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/ode/events/FilterType.java
@@ -19,11 +19,10 @@ package org.apache.commons.math4.legacy.ode.events;
import org.apache.commons.math4.legacy.exception.MathInternalError;
-/** Enumerate for {@link EventFilter filtering events}.
+/** Enumerates {@link EventFilter filtering events}.
*
* @since 3.2
*/
-
public enum FilterType {
/** Constant for triggering only decreasing events.
diff --git
a/commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/ode/sampling/StepNormalizerBounds.java
b/commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/ode/sampling/StepNormalizerBounds.java
index 367226e2a..a64116ac5 100644
---
a/commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/ode/sampling/StepNormalizerBounds.java
+++
b/commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/ode/sampling/StepNormalizerBounds.java
@@ -17,7 +17,7 @@
package org.apache.commons.math4.legacy.ode.sampling;
-/** {@link StepNormalizer Step normalizer} bounds settings. They influence
+/** Enumerates {@link StepNormalizer Step normalizer} bounds settings. They
influence
* whether the underlying fixed step size step handler is called for the first
* and last points. Note that if the last point coincides with a normalized
* point, then the underlying fixed step size step handler is always called,
diff --git
a/commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/ode/sampling/StepNormalizerMode.java
b/commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/ode/sampling/StepNormalizerMode.java
index 80810001e..4bdf1f458 100644
---
a/commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/ode/sampling/StepNormalizerMode.java
+++
b/commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/ode/sampling/StepNormalizerMode.java
@@ -18,7 +18,7 @@
package org.apache.commons.math4.legacy.ode.sampling;
-/** {@link StepNormalizer Step normalizer} modes. Determines how the step size
+/** Enumerates {@link StepNormalizer Step normalizer} modes. Determines how
the step size
* is interpreted.
* @see FieldStepNormalizer
* @see StepNormalizer
diff --git
a/commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/optim/linear/PivotSelectionRule.java
b/commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/optim/linear/PivotSelectionRule.java
index 8fa4d8831..c000c20cd 100644
---
a/commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/optim/linear/PivotSelectionRule.java
+++
b/commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/optim/linear/PivotSelectionRule.java
@@ -19,7 +19,7 @@ package org.apache.commons.math4.legacy.optim.linear;
import org.apache.commons.math4.legacy.optim.OptimizationData;
/**
- * Pivot selection rule to the use for a Simplex solver.
+ * Enumerates pivot selection rule to the use for a Simplex solver.
*
* @since 3.3
*/
diff --git
a/commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/optim/linear/Relationship.java
b/commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/optim/linear/Relationship.java
index e0a8ba9c7..779b77b03 100644
---
a/commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/optim/linear/Relationship.java
+++
b/commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/optim/linear/Relationship.java
@@ -17,7 +17,7 @@
package org.apache.commons.math4.legacy.optim.linear;
/**
- * Types of relationships between two cells in a Solver {@link
LinearConstraint}.
+ * Enumerates types of relationships between two cells in a Solver {@link
LinearConstraint}.
*
* @since 2.0
*/
diff --git
a/commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/optim/nonlinear/scalar/GoalType.java
b/commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/optim/nonlinear/scalar/GoalType.java
index 90779c994..1c22a8b0a 100644
---
a/commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/optim/nonlinear/scalar/GoalType.java
+++
b/commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/optim/nonlinear/scalar/GoalType.java
@@ -19,7 +19,7 @@ package
org.apache.commons.math4.legacy.optim.nonlinear.scalar;
import org.apache.commons.math4.legacy.optim.OptimizationData;
/**
- * Goal type for an optimization problem (minimization or maximization of
+ * Enumerates goal type for an optimization problem (minimization or
maximization of
* a scalar function.
*
* @since 2.0
diff --git
a/commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/optim/nonlinear/scalar/gradient/NonLinearConjugateGradientOptimizer.java
b/commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/optim/nonlinear/scalar/gradient/NonLinearConjugateGradientOptimizer.java
index 3589fd0f4..ee2f4e330 100644
---
a/commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/optim/nonlinear/scalar/gradient/NonLinearConjugateGradientOptimizer.java
+++
b/commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/optim/nonlinear/scalar/gradient/NonLinearConjugateGradientOptimizer.java
@@ -51,7 +51,7 @@ public class NonLinearConjugateGradientOptimizer
private final Preconditioner preconditioner;
/**
- * Available choices of update formulas for the updating the parameter
+ * Enumerates available choices of update formulas for the updating the
parameter
* that is used to compute the successive conjugate search directions.
* For non-linear conjugate gradients, there are
* two formulas:
diff --git
a/commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/stat/descriptive/ResizableDoubleArray.java
b/commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/stat/descriptive/ResizableDoubleArray.java
index 23e5de3f8..1b6dc4c12 100644
---
a/commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/stat/descriptive/ResizableDoubleArray.java
+++
b/commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/stat/descriptive/ResizableDoubleArray.java
@@ -126,7 +126,7 @@ class ResizableDoubleArray implements DoubleArray { // Not
in public API.
private int startIndex;
/**
- * Specification of expansion algorithm.
+ * Enumerates specifications of expansion algorithms.
* @since 3.1
*/
public enum ExpansionMode {
diff --git
a/commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/stat/descriptive/moment/SemiVariance.java
b/commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/stat/descriptive/moment/SemiVariance.java
index cb1e646d3..079a97144 100644
---
a/commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/stat/descriptive/moment/SemiVariance.java
+++
b/commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/stat/descriptive/moment/SemiVariance.java
@@ -223,7 +223,7 @@ public class SemiVariance extends
AbstractUnivariateStatistic {
}
/**
- * The direction of the semivariance - either upside or downside. The
direction
+ * Enumerates the direction of the semivariance - either upside or
downside. The direction
* is represented by boolean, with true corresponding to UPSIDE
semivariance.
*/
public enum Direction {
diff --git
a/commons-math-legacy/src/test/java/org/apache/commons/math4/legacy/optim/nonlinear/scalar/TestFunction.java
b/commons-math-legacy/src/test/java/org/apache/commons/math4/legacy/optim/nonlinear/scalar/TestFunction.java
index 3a935ebdf..9892df881 100644
---
a/commons-math-legacy/src/test/java/org/apache/commons/math4/legacy/optim/nonlinear/scalar/TestFunction.java
+++
b/commons-math-legacy/src/test/java/org/apache/commons/math4/legacy/optim/nonlinear/scalar/TestFunction.java
@@ -21,7 +21,7 @@ import java.util.function.DoubleUnaryOperator;
import org.apache.commons.math4.legacy.analysis.MultivariateFunction;
/**
- * Generators of {@link MultivariateFunction multivariate scalar functions}.
+ * Enumerates generators of {@link MultivariateFunction multivariate scalar
functions}.
* The functions are intended for testing optimizer implementations.
* <p>
* Note: The {@link #withDimension(int) function generators} take the space
diff --git
a/commons-math-neuralnet/src/main/java/org/apache/commons/math4/neuralnet/SquareNeighbourhood.java
b/commons-math-neuralnet/src/main/java/org/apache/commons/math4/neuralnet/SquareNeighbourhood.java
index 3d341c541..4237b706a 100644
---
a/commons-math-neuralnet/src/main/java/org/apache/commons/math4/neuralnet/SquareNeighbourhood.java
+++
b/commons-math-neuralnet/src/main/java/org/apache/commons/math4/neuralnet/SquareNeighbourhood.java
@@ -18,7 +18,7 @@
package org.apache.commons.math4.neuralnet;
/**
- * Defines neighbourhood types.
+ * Enumerates neighbourhood types.
*
* @since 3.3
*/
diff --git
a/commons-math-neuralnet/src/main/java/org/apache/commons/math4/neuralnet/twod/NeuronSquareMesh2D.java
b/commons-math-neuralnet/src/main/java/org/apache/commons/math4/neuralnet/twod/NeuronSquareMesh2D.java
index f6be18c4c..63bda44c2 100644
---
a/commons-math-neuralnet/src/main/java/org/apache/commons/math4/neuralnet/twod/NeuronSquareMesh2D.java
+++
b/commons-math-neuralnet/src/main/java/org/apache/commons/math4/neuralnet/twod/NeuronSquareMesh2D.java
@@ -67,7 +67,7 @@ public class NeuronSquareMesh2D
private final long[][] identifiers;
/**
- * Horizontal (along row) direction.
+ * Enumerates horizontal (along row) direction.
* @since 3.6
*/
public enum HorizontalDirection {
@@ -79,7 +79,7 @@ public class NeuronSquareMesh2D
LEFT,
}
/**
- * Vertical (along column) direction.
+ * Enumerates vertical (along column) direction.
* @since 3.6
*/
public enum VerticalDirection {
