You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by er...@apache.org on 2020/02/12 19:59:07 UTC
[commons-numbers] 02/03: Javadoc.
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-numbers.git
commit b09535852dd45c066a506963eb51b581098b55e2
Author: Gilles Sadowski <gi...@harfang.homelinux.org>
AuthorDate: Wed Feb 12 20:56:53 2020 +0100
Javadoc.
---
.../org/apache/commons/numbers/rootfinder/BrentSolver.java | 12 +++++++-----
1 file changed, 7 insertions(+), 5 deletions(-)
diff --git a/commons-numbers-rootfinder/src/main/java/org/apache/commons/numbers/rootfinder/BrentSolver.java b/commons-numbers-rootfinder/src/main/java/org/apache/commons/numbers/rootfinder/BrentSolver.java
index 4fd4165..4b7c3c3 100644
--- a/commons-numbers-rootfinder/src/main/java/org/apache/commons/numbers/rootfinder/BrentSolver.java
+++ b/commons-numbers-rootfinder/src/main/java/org/apache/commons/numbers/rootfinder/BrentSolver.java
@@ -66,8 +66,9 @@ public class BrentSolver {
* @param min Lower bound.
* @param max Upper bound.
* @return the root.
- * @throws IllegalArgumentException if {@code min} > {@code max}.
- * @throws IllegalArgumentException if the given interval does not bracket the root.
+ * @throws IllegalArgumentException if {@code min > max}.
+ * @throws IllegalArgumentException if the given interval does
+ * not bracket the root.
*/
public double findRoot(DoubleUnaryOperator func,
double min,
@@ -84,9 +85,10 @@ public class BrentSolver {
* @param initial Initial guess.
* @param max Upper bound.
* @return the root.
- * @throws IllegalArgumentException if {@code min} > {@code max} or
- * {@code initial} is not in the range {@code (min, max)}.
- * @throws IllegalArgumentException if the given interval does not bracket the root.
+ * @throws IllegalArgumentException if {@code min > max} or
+ * {@code initial} is not in the {@code [min, max]} interval.
+ * @throws IllegalArgumentException if the given interval does
+ * not bracket the root.
*/
public double findRoot(DoubleUnaryOperator func,
double min,