Open CASCADE Technology
7.7.0
|
#include <math_NewtonMinimum.hxx>
Public Member Functions | |
math_NewtonMinimum (const math_MultipleVarFunctionWithHessian &theFunction, const Standard_Real theTolerance=Precision::Confusion(), const Standard_Integer theNbIterations=40, const Standard_Real theConvexity=1.0e-6, const Standard_Boolean theWithSingularity=Standard_True) | |
The tolerance required on the solution is given by Tolerance. Iteration are stopped if (!WithSingularity) and H(F(Xi)) is not definite positive (if the smaller eigenvalue of H < Convexity) or IsConverged() returns True for 2 successives Iterations. Warning: This constructor does not perform computation. More... | |
void | Perform (math_MultipleVarFunctionWithHessian &theFunction, const math_Vector &theStartingPoint) |
Search the solution. More... | |
virtual | ~math_NewtonMinimum () |
Destructor. More... | |
virtual Standard_Boolean | IsConverged () const |
This method is called at the end of each iteration to check the convergence: || Xi+1 - Xi || < Tolerance or || F(Xi+1) - F(Xi)|| < Tolerance * || F(Xi) || It can be redefined in a sub-class to implement a specific test. More... | |
Standard_Boolean | IsDone () const |
Tests if an error has occurred. More... | |
Standard_Boolean | IsConvex () const |
Tests if the Function is convexe during optimization. More... | |
const math_Vector & | Location () const |
returns the location vector of the minimum. Exception NotDone is raised if an error has occurred. More... | |
void | Location (math_Vector &Loc) const |
outputs the location vector of the minimum in Loc. Exception NotDone is raised if an error has occurred. Exception DimensionError is raised if the range of Loc is not equal to the range of the StartingPoint. More... | |
void | SetBoundary (const math_Vector &theLeftBorder, const math_Vector &theRightBorder) |
Set boundaries. More... | |
Standard_Real | Minimum () const |
returns the value of the minimum. Exception NotDone is raised if the minimum was not found. More... | |
const math_Vector & | Gradient () const |
returns the gradient vector at the minimum. Exception NotDone is raised if an error has occurred. The minimum was not found. More... | |
void | Gradient (math_Vector &Grad) const |
outputs the gradient vector at the minimum in Grad. Exception NotDone is raised if the minimum was not found. Exception DimensionError is raised if the range of Grad is not equal to the range of the StartingPoint. More... | |
Standard_Integer | NbIterations () const |
returns the number of iterations really done in the calculation of the minimum. The exception NotDone is raised if an error has occurred. More... | |
math_Status | GetStatus () const |
Returns the Status of computation. The exception NotDone is raised if an error has occurred. More... | |
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 <<. More... | |
math_NewtonMinimum::math_NewtonMinimum | ( | const math_MultipleVarFunctionWithHessian & | theFunction, |
const Standard_Real | theTolerance = Precision::Confusion() , |
||
const Standard_Integer | theNbIterations = 40 , |
||
const Standard_Real | theConvexity = 1.0e-6 , |
||
const Standard_Boolean | theWithSingularity = Standard_True |
||
) |
The tolerance required on the solution is given by Tolerance. Iteration are stopped if (!WithSingularity) and H(F(Xi)) is not definite positive (if the smaller eigenvalue of H < Convexity) or IsConverged() returns True for 2 successives Iterations. Warning: This constructor does not perform computation.
|
virtual |
Destructor.
void math_NewtonMinimum::Dump | ( | Standard_OStream & | o | ) | const |
Prints on the stream o information on the current state of the object. Is used to redefine the operator <<.
math_Status math_NewtonMinimum::GetStatus | ( | ) | const |
Returns the Status of computation. The exception NotDone is raised if an error has occurred.
const math_Vector& math_NewtonMinimum::Gradient | ( | ) | const |
returns the gradient vector at the minimum. Exception NotDone is raised if an error has occurred. The minimum was not found.
void math_NewtonMinimum::Gradient | ( | math_Vector & | Grad | ) | const |
outputs the gradient vector at the minimum in Grad. Exception NotDone is raised if the minimum was not found. Exception DimensionError is raised if the range of Grad is not equal to the range of the StartingPoint.
|
virtual |
This method is called at the end of each iteration to check the convergence: || Xi+1 - Xi || < Tolerance or || F(Xi+1) - F(Xi)|| < Tolerance * || F(Xi) || It can be redefined in a sub-class to implement a specific test.
Reimplemented in FairCurve_Newton.
Standard_Boolean math_NewtonMinimum::IsConvex | ( | ) | const |
Tests if the Function is convexe during optimization.
Standard_Boolean math_NewtonMinimum::IsDone | ( | ) | const |
Tests if an error has occurred.
const math_Vector& math_NewtonMinimum::Location | ( | ) | const |
returns the location vector of the minimum. Exception NotDone is raised if an error has occurred.
void math_NewtonMinimum::Location | ( | math_Vector & | Loc | ) | const |
outputs the location vector of the minimum in Loc. Exception NotDone is raised if an error has occurred. Exception DimensionError is raised if the range of Loc is not equal to the range of the StartingPoint.
Standard_Real math_NewtonMinimum::Minimum | ( | ) | const |
returns the value of the minimum. Exception NotDone is raised if the minimum was not found.
Standard_Integer math_NewtonMinimum::NbIterations | ( | ) | const |
returns the number of iterations really done in the calculation of the minimum. The exception NotDone is raised if an error has occurred.
void math_NewtonMinimum::Perform | ( | math_MultipleVarFunctionWithHessian & | theFunction, |
const math_Vector & | theStartingPoint | ||
) |
Search the solution.
void math_NewtonMinimum::SetBoundary | ( | const math_Vector & | theLeftBorder, |
const math_Vector & | theRightBorder | ||
) |
Set boundaries.
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |