From 77af8e95856211098d213f73aaede9afec024b71 Mon Sep 17 00:00:00 2001
From: Luc Maisonobe <luc@apache.org>
Date: Fri, 1 Jul 2011 11:39:28 +0000
Subject: [PATCH] renamed BracketedSolution into BracketedUnivariateRealSolver
 and make it extend UnivariateRealSolver.

This will allow specifying directly a sub-category of solvers when needed. It will be used for example by the ODE events detection mechanism, as it will ensure the integrator can automatically go past the event time.

JIRA: MATH-605

git-svn-id: https://svn.apache.org/repos/asf/commons/proper/math/trunk@1141905 13f79535-47bb-0310-9956-ffa450edef68
---
 .../commons/math/analysis/solvers/AllowedSolutions.java       | 2 +-
 .../math/analysis/solvers/BaseBracketedSecantSolver.java      | 4 ++--
 ...cketedSolution.java => BracketedUnivariateRealSolver.java} | 2 +-
 .../commons/math/analysis/solvers/RegulaFalsiSolver.java      | 2 +-
 4 files changed, 5 insertions(+), 5 deletions(-)
 rename src/main/java/org/apache/commons/math/analysis/solvers/{BracketedSolution.java => BracketedUnivariateRealSolver.java} (97%)

diff --git a/src/main/java/org/apache/commons/math/analysis/solvers/AllowedSolutions.java b/src/main/java/org/apache/commons/math/analysis/solvers/AllowedSolutions.java
index f5e35cb0d..9c729a0ec 100644
--- a/src/main/java/org/apache/commons/math/analysis/solvers/AllowedSolutions.java
+++ b/src/main/java/org/apache/commons/math/analysis/solvers/AllowedSolutions.java
@@ -33,7 +33,7 @@ package org.apache.commons.math.analysis.solvers;
  * may be necessary to guarantee that a solution is returned that does not
  * under-approximate the solution.</p>
  *
- * @see BracketedSolution
+ * @see BracketedUnivariateRealSolver
  * @since 3.0
  * @version $Id$
  */
diff --git a/src/main/java/org/apache/commons/math/analysis/solvers/BaseBracketedSecantSolver.java b/src/main/java/org/apache/commons/math/analysis/solvers/BaseBracketedSecantSolver.java
index 0199e910e..4a96e7e0b 100644
--- a/src/main/java/org/apache/commons/math/analysis/solvers/BaseBracketedSecantSolver.java
+++ b/src/main/java/org/apache/commons/math/analysis/solvers/BaseBracketedSecantSolver.java
@@ -19,13 +19,13 @@ package org.apache.commons.math.analysis.solvers;
 
 /**
  * Base class for <em>Secant</em> methods that guarantee convergence
- * by maintaining a {@link BracketedSolution bracketed solution}.
+ * by maintaining a {@link BracketedUnivariateRealSolver bracketed solution}.
  *
  * @since 3.0
  * @version $Id$
  */
 public class BaseBracketedSecantSolver extends BaseSecantSolver
-    implements BracketedSolution {
+    implements BracketedUnivariateRealSolver {
     /**
      * Construct a solver with default accuracy (1e-6).
      *
diff --git a/src/main/java/org/apache/commons/math/analysis/solvers/BracketedSolution.java b/src/main/java/org/apache/commons/math/analysis/solvers/BracketedUnivariateRealSolver.java
similarity index 97%
rename from src/main/java/org/apache/commons/math/analysis/solvers/BracketedSolution.java
rename to src/main/java/org/apache/commons/math/analysis/solvers/BracketedUnivariateRealSolver.java
index e08261b8f..eee7c7f15 100644
--- a/src/main/java/org/apache/commons/math/analysis/solvers/BracketedSolution.java
+++ b/src/main/java/org/apache/commons/math/analysis/solvers/BracketedUnivariateRealSolver.java
@@ -41,7 +41,7 @@ package org.apache.commons.math.analysis.solvers;
  * @since 3.0
  * @version $Id$
  */
-public interface BracketedSolution {
+public interface BracketedUnivariateRealSolver extends UnivariateRealSolver {
     /** Returns the kind of solutions that the root-finding algorithm may
      * accept as solutions.
      *
diff --git a/src/main/java/org/apache/commons/math/analysis/solvers/RegulaFalsiSolver.java b/src/main/java/org/apache/commons/math/analysis/solvers/RegulaFalsiSolver.java
index 949e3e93f..4ab3426bb 100644
--- a/src/main/java/org/apache/commons/math/analysis/solvers/RegulaFalsiSolver.java
+++ b/src/main/java/org/apache/commons/math/analysis/solvers/RegulaFalsiSolver.java
@@ -22,7 +22,7 @@ package org.apache.commons.math.analysis.solvers;
  * root-finding (approximating a zero of a univariate real function). It is a
  * modified {@link SecantSolver <em>Secant</em>} method. Unlike the
  * <em>Secant</em> method, convergence is guaranteed by maintaining a
- * {@link BracketedSolution bracketed solution}.
+ * bracketed solution.
  *
  * <p>The <em>Regula Falsi</em> method assumes that the function is continuous,
  * but not necessarily smooth.</p>