This is an automated email from the ASF dual-hosted git repository.
erans pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-math.git
commit e3b029d28afa0c468fc942c046d5cfd1c7162e5c
Author: Gilles Sadowski <gillese...@gmail.com>
AuthorDate: Thu Aug 12 17:21:17 2021 +0200
Javadoc.
---
.../commons/math4/legacy/optim/nonlinear/scalar/TestFunction.java | 8 +++++++-
1 file changed, 7 insertions(+), 1 deletion(-)
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 216be58..0292bd8 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
@@ -22,7 +22,13 @@ import
org.apache.commons.math4.legacy.analysis.MultivariateFunction;
import org.apache.commons.math4.legacy.core.jdkmath.AccurateMath;
/**
- * Multivariate scalar functions for testing an optimizer.
+ * 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
+ * dimension (i.e. the length of the array argument passed to the generated
+ * function) as argument; it is thus assumed that the test functions can be
+ * generalized to any dimension.
*/
public enum TestFunction {
// https://www.sfu.ca/~ssurjano/spheref.html
