org.apache.commons.math.analysis.solvers
Class UnivariateRealSolverImpl

java.lang.Object
  extended by org.apache.commons.math.ConvergingAlgorithmImpl
      extended by org.apache.commons.math.analysis.solvers.UnivariateRealSolverImpl
All Implemented Interfaces:
UnivariateRealSolver, ConvergingAlgorithm
Direct Known Subclasses:
BisectionSolver, BrentSolver, LaguerreSolver, MullerSolver, NewtonSolver, RiddersSolver, SecantSolver

Deprecated. in 2.2 (to be removed in 3.0).

@Deprecated
public abstract class UnivariateRealSolverImpl
extends ConvergingAlgorithmImpl
implements UnivariateRealSolver

Provide a default implementation for several functions useful to generic solvers.


Method Summary
 double getFunctionValue()
          Deprecated. Get the result of the last run of the solver.
 double getFunctionValueAccuracy()
          Deprecated. Get the actual function value accuracy.
 double getResult()
          Deprecated. Get the result of the last run of the solver.
 void resetFunctionValueAccuracy()
          Deprecated. Reset the actual function accuracy to the default.
 void setFunctionValueAccuracy(double accuracy)
          Deprecated. Set the function value accuracy.
 double solve(int maxEval, UnivariateRealFunction function, double min, double max)
          Deprecated. Solve for a zero root in the given interval.
 double solve(int maxEval, UnivariateRealFunction function, double min, double max, double startValue)
          Deprecated. Solve for a zero in the given interval, start at startValue.
 
Methods inherited from class org.apache.commons.math.ConvergingAlgorithmImpl
getAbsoluteAccuracy, getIterationCount, getMaximalIterationCount, getRelativeAccuracy, resetAbsoluteAccuracy, resetMaximalIterationCount, resetRelativeAccuracy, setAbsoluteAccuracy, setMaximalIterationCount, setRelativeAccuracy
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.apache.commons.math.analysis.solvers.UnivariateRealSolver
solve, solve, solve, solve
 
Methods inherited from interface org.apache.commons.math.ConvergingAlgorithm
getAbsoluteAccuracy, getIterationCount, getMaximalIterationCount, getRelativeAccuracy, resetAbsoluteAccuracy, resetMaximalIterationCount, resetRelativeAccuracy, setAbsoluteAccuracy, setMaximalIterationCount, setRelativeAccuracy
 

Method Detail

getResult

public double getResult()
Deprecated. 
Get the result of the last run of the solver.

Specified by:
getResult in interface UnivariateRealSolver
Returns:
the last result.

getFunctionValue

public double getFunctionValue()
Deprecated. 
Get the result of the last run of the solver.

Specified by:
getFunctionValue in interface UnivariateRealSolver
Returns:
the value of the function at the last result.

setFunctionValueAccuracy

public void setFunctionValueAccuracy(double accuracy)
Deprecated. 
Set the function value accuracy.

This is used to determine when an evaluated function value or some other value which is used as divisor is zero.

This is a safety guard and it shouldn't be necessary to change this in general.

Specified by:
setFunctionValueAccuracy in interface UnivariateRealSolver
Parameters:
accuracy - the accuracy.

getFunctionValueAccuracy

public double getFunctionValueAccuracy()
Deprecated. 
Get the actual function value accuracy.

Specified by:
getFunctionValueAccuracy in interface UnivariateRealSolver
Returns:
the accuracy

resetFunctionValueAccuracy

public void resetFunctionValueAccuracy()
Deprecated. 
Reset the actual function accuracy to the default. The default value is provided by the solver implementation.

Specified by:
resetFunctionValueAccuracy in interface UnivariateRealSolver

solve

public double solve(int maxEval,
                    UnivariateRealFunction function,
                    double min,
                    double max)
             throws ConvergenceException,
                    FunctionEvaluationException
Deprecated. 
Solve for a zero root in the given interval.

A solver may require that the interval brackets a single zero root. Solvers that do require bracketing should be able to handle the case where one of the endpoints is itself a root.

Parameters:
function - the function to solve.
min - the lower bound for the interval.
max - the upper bound for the interval.
maxEval - Maximum number of evaluations.
Returns:
a value where the function is zero
Throws:
ConvergenceException - if the maximum iteration count is exceeded or the solver detects convergence problems otherwise.
FunctionEvaluationException - if an error occurs evaluating the function
IllegalArgumentException - if min > max or the endpoints do not satisfy the requirements specified by the solver
Since:
2.2

solve

public double solve(int maxEval,
                    UnivariateRealFunction function,
                    double min,
                    double max,
                    double startValue)
             throws ConvergenceException,
                    FunctionEvaluationException,
                    IllegalArgumentException
Deprecated. 
Solve for a zero in the given interval, start at startValue.

A solver may require that the interval brackets a single zero root. Solvers that do require bracketing should be able to handle the case where one of the endpoints is itself a root.

Parameters:
function - the function to solve.
min - the lower bound for the interval.
max - the upper bound for the interval.
startValue - the start value to use
maxEval - Maximum number of evaluations.
Returns:
a value where the function is zero
Throws:
ConvergenceException - if the maximum iteration count is exceeded or the solver detects convergence problems otherwise.
FunctionEvaluationException - if an error occurs evaluating the function
IllegalArgumentException - if min > max or the arguments do not satisfy the requirements specified by the solver
Since:
2.2


jHepWork 3.0 ©