Apache Commons Math 3.6.1 · org.apache.commons.math3.dfp.BracketingNthOrderBrentSolverDFP

Access	Constructor and Description
public	BracketingNthOrderBrentSolverDFP(final Dfp Relative accuracy. relativeAccuracy, final Dfp Absolute accuracy. absoluteAccuracy, final Dfp Function value accuracy. functionValueAccuracy, final int maximal order. maximalOrder) Construct a solver.

Method Summary

Modifier and Type	Method and Description
public Dfp	Returns: absolute accuracy getAbsoluteAccuracy() Overrides org.apache.commons.math3.analysis.solvers.FieldBracketingNthOrderBrentSolver.getAbsoluteAccuracy. Implements org.apache.commons.math3.analysis.solvers.BracketedRealFieldUnivariateSolver.getAbsoluteAccuracy. Get the absolute accuracy.
public Dfp	Returns: function accuracy getFunctionValueAccuracy() Overrides org.apache.commons.math3.analysis.solvers.FieldBracketingNthOrderBrentSolver.getFunctionValueAccuracy. Implements org.apache.commons.math3.analysis.solvers.BracketedRealFieldUnivariateSolver.getFunctionValueAccuracy. Get the function accuracy.
public Dfp	Returns: relative accuracy getRelativeAccuracy() Overrides org.apache.commons.math3.analysis.solvers.FieldBracketingNthOrderBrentSolver.getRelativeAccuracy. Implements org.apache.commons.math3.analysis.solvers.BracketedRealFieldUnivariateSolver.getRelativeAccuracy. Get the relative accuracy.
public Dfp	Returns: a value where the function is zero. solve(final int Maximum number of evaluations. maxEval, final UnivariateDfpFunction Function to solve. f, final Dfp Lower bound for the interval. min, final Dfp Upper bound for the interval. max, final AllowedSolution The kind of solutions that the root-finding algorithm may accept as solutions. allowedSolution) Deprecated as a consequence of `UnivariateDfpFunction` being deprecated. Solve for a zero in the given interval.
public Dfp	Returns: a value where the function is zero. solve(final int Maximum number of evaluations. maxEval, final UnivariateDfpFunction Function to solve. f, final Dfp Lower bound for the interval. min, final Dfp Upper bound for the interval. max, final Dfp Start value to use. startValue, final AllowedSolution The kind of solutions that the root-finding algorithm may accept as solutions. allowedSolution) Deprecated as a consequence of `UnivariateDfpFunction` being deprecated. Solve for a zero in the given interval, start at `startValue`.

Inherited from org.apache.commons.math3.analysis.solvers.FieldBracketingNthOrderBrentSolver:: getEvaluations getMaxEvaluations getMaximalOrder solve solve

BracketingNthOrderBrentSolverDFP	back to summary
public BracketingNthOrderBrentSolverDFP(final Dfp relativeAccuracy, final Dfp absoluteAccuracy, final Dfp functionValueAccuracy, final int maximalOrder) throws NumberIsTooSmallException Construct a solver. Parameters relativeAccuracy:Dfp Relative accuracy. absoluteAccuracy:Dfp Absolute accuracy. functionValueAccuracy:Dfp Function value accuracy. maximalOrder:int maximal order. Exceptions NumberIsTooSmallException: if maximal order is lower than 2

Method Detail

getAbsoluteAccuracy	back to summary
public Dfp getAbsoluteAccuracy() Overrides org.apache.commons.math3.analysis.solvers.FieldBracketingNthOrderBrentSolver.getAbsoluteAccuracy. Implements org.apache.commons.math3.analysis.solvers.BracketedRealFieldUnivariateSolver.getAbsoluteAccuracy. Get the absolute accuracy. Returns:Dfp absolute accuracy Annotations @Override

getAbsoluteAccuracy

back to summary

public Dfp getAbsoluteAccuracy()

Overrides org.apache.commons.math3.analysis.solvers.FieldBracketingNthOrderBrentSolver.getAbsoluteAccuracy.

Implements org.apache.commons.math3.analysis.solvers.BracketedRealFieldUnivariateSolver.getAbsoluteAccuracy.

Get the absolute accuracy.

Returns:Dfp

absolute accuracy

Annotations

@Override

getFunctionValueAccuracy	back to summary
public Dfp getFunctionValueAccuracy() Overrides org.apache.commons.math3.analysis.solvers.FieldBracketingNthOrderBrentSolver.getFunctionValueAccuracy. Implements org.apache.commons.math3.analysis.solvers.BracketedRealFieldUnivariateSolver.getFunctionValueAccuracy. Get the function accuracy. Returns:Dfp function accuracy Annotations @Override

getFunctionValueAccuracy

back to summary

public Dfp getFunctionValueAccuracy()

Overrides org.apache.commons.math3.analysis.solvers.FieldBracketingNthOrderBrentSolver.getFunctionValueAccuracy.

Implements org.apache.commons.math3.analysis.solvers.BracketedRealFieldUnivariateSolver.getFunctionValueAccuracy.

Get the function accuracy.

Returns:Dfp

function accuracy

Annotations

@Override

getRelativeAccuracy	back to summary
public Dfp getRelativeAccuracy() Overrides org.apache.commons.math3.analysis.solvers.FieldBracketingNthOrderBrentSolver.getRelativeAccuracy. Implements org.apache.commons.math3.analysis.solvers.BracketedRealFieldUnivariateSolver.getRelativeAccuracy. Get the relative accuracy. Returns:Dfp relative accuracy Annotations @Override

getRelativeAccuracy

back to summary

public Dfp getRelativeAccuracy()

Overrides org.apache.commons.math3.analysis.solvers.FieldBracketingNthOrderBrentSolver.getRelativeAccuracy.

Implements org.apache.commons.math3.analysis.solvers.BracketedRealFieldUnivariateSolver.getRelativeAccuracy.

Get the relative accuracy.

Returns:Dfp

relative accuracy

Annotations

@Override

solve back to summary

solve	back to summary
public Dfp solve(final int maxEval, final UnivariateDfpFunction f, final Dfp min, final Dfp max, final AllowedSolution allowedSolution) throws NullArgumentException, NoBracketingException Deprecated as a consequence of `UnivariateDfpFunction` being deprecated. See corresponding docs for further information. Solve for a zero 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 maxEval:int Maximum number of evaluations. f:UnivariateDfpFunction Function to solve. min:Dfp Lower bound for the interval. max:Dfp Upper bound for the interval. allowedSolution:AllowedSolution The kind of solutions that the root-finding algorithm may accept as solutions. Returns:Dfp a value where the function is zero. Exceptions NullArgumentException: if f is null. NoBracketingException: if root cannot be bracketed

public Dfp solve(final int maxEval, final UnivariateDfpFunction f, final Dfp min, final Dfp max, final AllowedSolution allowedSolution) throws NullArgumentException, NoBracketingException

Deprecated

as a consequence of UnivariateDfpFunction being deprecated. See corresponding docs for further information.

Solve for a zero 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

maxEval:int: Maximum number of evaluations.
f:UnivariateDfpFunction: Function to solve.
min:Dfp: Lower bound for the interval.
max:Dfp: Upper bound for the interval.
allowedSolution:AllowedSolution: The kind of solutions that the root-finding algorithm may accept as solutions.

Returns:Dfp

a value where the function is zero.

Exceptions

NullArgumentException:: if f is null.
NoBracketingException:: if root cannot be bracketed

solve back to summary

solve	back to summary
public Dfp solve(final int maxEval, final UnivariateDfpFunction f, final Dfp min, final Dfp max, final Dfp startValue, final AllowedSolution allowedSolution) throws NullArgumentException, NoBracketingException Deprecated as a consequence of `UnivariateDfpFunction` being deprecated. See corresponding docs for further information. 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 maxEval:int Maximum number of evaluations. f:UnivariateDfpFunction Function to solve. min:Dfp Lower bound for the interval. max:Dfp Upper bound for the interval. startValue:Dfp Start value to use. allowedSolution:AllowedSolution The kind of solutions that the root-finding algorithm may accept as solutions. Returns:Dfp a value where the function is zero. Exceptions NullArgumentException: if f is null. NoBracketingException: if root cannot be bracketed

public Dfp solve(final int maxEval, final UnivariateDfpFunction f, final Dfp min, final Dfp max, final Dfp startValue, final AllowedSolution allowedSolution) throws NullArgumentException, NoBracketingException

Deprecated

as a consequence of UnivariateDfpFunction being deprecated. See corresponding docs for further information.

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

maxEval:int: Maximum number of evaluations.
f:UnivariateDfpFunction: Function to solve.
min:Dfp: Lower bound for the interval.
max:Dfp: Upper bound for the interval.
startValue:Dfp: Start value to use.
allowedSolution:AllowedSolution: The kind of solutions that the root-finding algorithm may accept as solutions.

Returns:Dfp

a value where the function is zero.

Exceptions

NullArgumentException:: if f is null.
NoBracketingException:: if root cannot be bracketed

public Class BracketingNthOrderBrentSolverDFP

Constructor Summary

Method Summary

Constructor Detail

Method Detail