Solver

class Solver(*args)

SolverImplementation of 1D non linear equations.

Available constructor:

SolverImplementation()

SolverImplementation(solverImplementation)

SolverImplementation(absError, relError, resError, maximumFunctionEvaluation)

Parameters:

solverImplementation : SolverImplementationImplementation

The implementation of a particular solver which is Bisection, Brent or Secant.

absError : positive float

Absolute error: distance between two successive iterates at the end point. Default is 10^{-5}.

relError : positive float

Relative error: distance between the two last successive iterates with regards to the last iterate. Default is 10^{-5}.

resError : positive float

Residual error: difference between the last iterate value and the expected value. Default is 10^{-8}.

maximumFunctionEvaluation : int

The maximum number of evaluations of the function. Default is 100.

See also

Bisection, Brent, Secant

Notes

This class enables to solve 1D non linear equations :

f(x) = value, \forall x \in [infPoint, supPoint]

if f is a continuous function from \Rset to \Rset, infPoint, supPoint \in \Rset and if f is such that f(infPoint) \times f(supPoint) < 0, then f has at least a zero in the interval [infPoint, supPoint]. In particular, it is used in the root research of a Directional Sampling simulation.

Methods

getAbsoluteError() Accessor to the absolute error.
getClassName() Accessor to the object’s name.
getId() Accessor to the object’s id.
getImplementation(*args) Accessor to the underlying implementation.
getMaximumFunctionEvaluation() Accessor to the maximum number of evaluations of the function.
getName() Accessor to the object’s name.
getRelativeError() Accessor to the relative error.
getResidualError() Accessor to the residual error.
getUsedFunctionEvaluation() Accessor to the number of evaluations of the function.
setAbsoluteError(absoluteError) Accessor to the absolute error.
setMaximumFunctionEvaluation(…) Accessor to the maximum number of evaluations of the function.
setName(name) Accessor to the object’s name.
setRelativeError(relativeError) Accessor to the relative error.
setResidualError(residualError) Accessor to the residual error.
solve(*args)
__init__(*args)
getAbsoluteError()

Accessor to the absolute error.

Returns:

absError : float

The absolute error: distance between two successive iterates at the end point.

getClassName()

Accessor to the object’s name.

Returns:

class_name : str

The object class name (object.__class__.__name__).

getId()

Accessor to the object’s id.

Returns:

id : int

Internal unique identifier.

getImplementation(*args)

Accessor to the underlying implementation.

Returns:

impl : Implementation

The implementation class.

getMaximumFunctionEvaluation()

Accessor to the maximum number of evaluations of the function.

Returns:

maxEval : int

The maximum number of evaluations of the function.

getName()

Accessor to the object’s name.

Returns:

name : str

The name of the object.

getRelativeError()

Accessor to the relative error.

Returns:

relError : float

The relative error: distance between the two last successive iterates with regards to the last iterate.

getResidualError()

Accessor to the residual error.

Returns:

resError : float

The residual errors: difference between the last iterate value and the expected value.

getUsedFunctionEvaluation()

Accessor to the number of evaluations of the function.

Returns:

nEval : int

The number of evaluations of the function.

setAbsoluteError(absoluteError)

Accessor to the absolute error.

Parameters:

absError : float

The absolute error: distance between two successive iterates at the end point.

setMaximumFunctionEvaluation(maximumFunctionEvaluation)

Accessor to the maximum number of evaluations of the function.

Parameters:

maxEval : int

The maximum number of evaluations of the function.

setName(name)

Accessor to the object’s name.

Parameters:

name : str

The name of the object.

setRelativeError(relativeError)

Accessor to the relative error.

Parameters:

relError : float

The relative error: distance between the two last successive iterates with regards to the last iterate.

setResidualError(residualError)

Accessor to the residual error.

Parameters:

resError : float

The residual errors: difference between the last iterate value and the expected value.