Open CASCADE Technology 6.6.0
Public Member Functions | Protected Attributes
math_FunctionSetRoot Class Reference

The math_FunctionSetRoot class calculates the root
of a set of N functions of M variables (N<M, N=M or N>M). Knowing
an initial guess of the solution and using a minimization algorithm, a search
is made in the Newton direction and then in the Gradient direction if there
is no success in the Newton direction. This algorithm can also be
used for functions minimization. Knowledge of all the partial
derivatives (the Jacobian) is required.

#include <math_FunctionSetRoot.hxx>

Public Member Functions

 math_FunctionSetRoot (math_FunctionSetWithDerivatives &F, const math_Vector &Tolerance, const Standard_Integer NbIterations=100)
 is used in a sub-class to initialize correctly all the fields
of this class.
The range (1, F.NbVariables()) must be especially
respected for all vectors and matrix declarations.

 math_FunctionSetRoot (math_FunctionSetWithDerivatives &F, const Standard_Integer NbIterations=100)
 is used in a sub-class to initialize correctly all the fields
of this class.
The range (1, F.NbVariables()) must be especially
respected for all vectors and matrix declarations.
The method SetTolerance must be called after this
constructor.

 math_FunctionSetRoot (math_FunctionSetWithDerivatives &F, const math_Vector &StartingPoint, const math_Vector &Tolerance, const Standard_Integer NbIterations=100)
 is used to improve the root of the function F
from the initial guess StartingPoint.
The maximum number of iterations allowed is given by
NbIterations.
In this case, the solution is found when:
abs(Xi - Xi-1)(j) <= Tolerance(j) for all unknowns.

 math_FunctionSetRoot (math_FunctionSetWithDerivatives &F, const math_Vector &StartingPoint, const math_Vector &Tolerance, const math_Vector &infBound, const math_Vector &supBound, const Standard_Integer NbIterations=100, const Standard_Boolean theStopOnDivergent=Standard_False)
 is used to improve the root of the function F
from the initial guess StartingPoint.
The maximum number of iterations allowed is given
by NbIterations.
In this case, the solution is found when:
abs(Xi - Xi-1) <= Tolerance for all unknowns.

virtual void Delete ()
virtual ~math_FunctionSetRoot ()
void SetTolerance (const math_Vector &Tolerance)
 Initializes the tolerance values.

void Perform (math_FunctionSetWithDerivatives &F, const math_Vector &StartingPoint, const math_Vector &infBound, const math_Vector &supBound, const Standard_Boolean theStopOnDivergent=Standard_False)
 Improves the root of function F from the initial guess
StartingPoint. infBound and supBound may be given to constrain the solution.
Warning
This method is called when computation of the solution is
not performed by the constructors.

virtual Standard_Boolean IsSolutionReached (math_FunctionSetWithDerivatives &F)
 This routine is called at the end of each iteration
to check if the solution was found. It can be redefined
in a sub-class to implement a specific test to stop the
iterations.
In this case, the solution is found when:
abs(Xi - Xi-1) <= Tolerance for all unknowns.

Standard_Boolean IsDone () const
 Returns true if the computations are successful, otherwise returns false.

Standard_Integer NbIterations () const
 Returns the number of iterations really done
during the computation of the root.
Exception NotDone is raised if the root was not found.

Standard_Integer StateNumber () const
 returns the stateNumber (as returned by
F.GetStateNumber()) associated to the root found.

const math_VectorRoot () const
 Returns the value of the root of function F.
Exception NotDone is raised if the root was not found.

void Root (math_Vector &Root) const
 Outputs the root vector in Root.
Exception NotDone is raised if the root was not found.
Exception DimensionError is raised if the range of Root
is not equal to the range of the StartingPoint.

const math_MatrixDerivative () const
 Returns the matrix value of the derivative at the root.
Exception NotDone is raised if the root was not found.

void Derivative (math_Matrix &Der) const
 outputs the matrix value of the derivative
at the root in Der.
Exception NotDone is raised if the root was not found.
Exception DimensionError is raised if the column range
of <Der> is not equal to the range of the startingPoint.

const math_VectorFunctionSetErrors () const
 returns the vector value of the error done
on the functions at the root.
Exception NotDone is raised if the root was not found.

void FunctionSetErrors (math_Vector &Err) const
 outputs the vector value of the error done
on the functions at the root in Err.
Exception NotDone is raised if the root was not found.
Exception DimensionError is raised if the range of Err
is not equal to the range of the StartingPoint.

void Dump (Standard_OStream &o) const
 Prints on the stream o information on the current state
of the object.
Is used to redefine the operator <<.

Standard_Boolean IsDivergent () const

Protected Attributes

math_Vector Delta
math_Vector Sol
math_Matrix DF
math_Vector Tol

Constructor & Destructor Documentation

math_FunctionSetRoot::math_FunctionSetRoot ( math_FunctionSetWithDerivatives F,
const math_Vector Tolerance,
const Standard_Integer  NbIterations = 100 
)
math_FunctionSetRoot::math_FunctionSetRoot ( math_FunctionSetWithDerivatives F,
const Standard_Integer  NbIterations = 100 
)
math_FunctionSetRoot::math_FunctionSetRoot ( math_FunctionSetWithDerivatives F,
const math_Vector StartingPoint,
const math_Vector Tolerance,
const Standard_Integer  NbIterations = 100 
)
math_FunctionSetRoot::math_FunctionSetRoot ( math_FunctionSetWithDerivatives F,
const math_Vector StartingPoint,
const math_Vector Tolerance,
const math_Vector infBound,
const math_Vector supBound,
const Standard_Integer  NbIterations = 100,
const Standard_Boolean  theStopOnDivergent = Standard_False 
)
virtual math_FunctionSetRoot::~math_FunctionSetRoot ( ) [inline, virtual]

Member Function Documentation

virtual void math_FunctionSetRoot::Delete ( ) [virtual]
const math_Matrix& math_FunctionSetRoot::Derivative ( ) const
void math_FunctionSetRoot::Derivative ( math_Matrix Der) const
void math_FunctionSetRoot::Dump ( Standard_OStream o) const
void math_FunctionSetRoot::FunctionSetErrors ( math_Vector Err) const
const math_Vector& math_FunctionSetRoot::FunctionSetErrors ( ) const
Standard_Boolean math_FunctionSetRoot::IsDivergent ( ) const
Standard_Boolean math_FunctionSetRoot::IsDone ( ) const
virtual Standard_Boolean math_FunctionSetRoot::IsSolutionReached ( math_FunctionSetWithDerivatives F) [virtual]
Standard_Integer math_FunctionSetRoot::NbIterations ( ) const
void math_FunctionSetRoot::Perform ( math_FunctionSetWithDerivatives F,
const math_Vector StartingPoint,
const math_Vector infBound,
const math_Vector supBound,
const Standard_Boolean  theStopOnDivergent = Standard_False 
)
void math_FunctionSetRoot::Root ( math_Vector Root) const
const math_Vector& math_FunctionSetRoot::Root ( ) const
void math_FunctionSetRoot::SetTolerance ( const math_Vector Tolerance)
Standard_Integer math_FunctionSetRoot::StateNumber ( ) const

Field Documentation


The documentation for this class was generated from the following file:
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines