#include <math_NewtonMinimum.hxx>

 math_NewtonMinimum (const math_MultipleVarFunctionWithHessian &theFunction, const Standard_Real theTolerance=1.0e7, const Standard_Integer theNbIterations=40, const Standard_Real theConvexity=1.0e6, 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 subclass to implement a specific test. More...


Standard_Boolean  IsDone () const 
 Tests if an error has occured. 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 occured. More...


void  Location (math_Vector &Loc) const 
 outputs the location vector of the minimum in Loc. Exception NotDone is raised if an error has occured. 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 occured.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 occured. More...


math_Status  GetStatus () const 
 Returns the Status of computation. The exception NotDone is raised if an error has occured. 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...


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 math_NewtonMinimum::~math_NewtonMinimum 
( 
 ) 


virtual 
Prints on the stream o information on the current state of the object. Is used to redefine the operator <<.
Returns the Status of computation. The exception NotDone is raised if an error has occured.
const math_Vector& math_NewtonMinimum::Gradient 
( 
 ) 
const 
returns the gradient vector at the minimum. Exception NotDone is raised if an error has occured.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.
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 subclass to implement a specific test.
Reimplemented in FairCurve_Newton.
Tests if the Function is convexe during optimization.
Tests if an error has occured.
const math_Vector& math_NewtonMinimum::Location 
( 
 ) 
const 
returns the location vector of the minimum. Exception NotDone is raised if an error has occured.
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 occured. Exception DimensionError is raised if the range of Loc is not equal to the range of the StartingPoint.
returns the value of the minimum. Exception NotDone is raised if the minimum was not found.
returns the number of iterations really done in the calculation of the minimum. The exception NotDone is raised if an error has occured.
void math_NewtonMinimum::SetBoundary 
( 
const math_Vector & 
theLeftBorder, 


const math_Vector & 
theRightBorder 

) 
 
The documentation for this class was generated from the following file: