Open CASCADE Technology  7.6.0.dev
Public Member Functions
GeomInt_Gradient_BFGSOfMyGradientbisOfTheComputeLineOfWLApprox Class Reference

#include <GeomInt_Gradient_BFGSOfMyGradientbisOfTheComputeLineOfWLApprox.hxx>

Inheritance diagram for GeomInt_Gradient_BFGSOfMyGradientbisOfTheComputeLineOfWLApprox:
Inheritance graph
[legend]

Public Member Functions

 GeomInt_Gradient_BFGSOfMyGradientbisOfTheComputeLineOfWLApprox (math_MultipleVarFunctionWithGradient &F, const math_Vector &StartingPoint, const Standard_Real Tolerance3d, const Standard_Real Tolerance2d, const Standard_Real Eps, const Standard_Integer NbIterations=200)
 
virtual Standard_Boolean IsSolutionReached (math_MultipleVarFunctionWithGradient &F) const override
 This method is called at the end of each iteration to check if the solution is found. It can be redefined in a sub-class to implement a specific test to stop the iterations. More...
 
- Public Member Functions inherited from math_BFGS
 math_BFGS (const Standard_Integer NbVariables, const Standard_Real Tolerance=1.0e-8, const Standard_Integer NbIterations=200, const Standard_Real ZEPS=1.0e-12)
 Initializes the computation of the minimum of a function with NbVariables. Tolerance, ZEPS and NbIterations are described in the method Perform. Warning: A call to the Perform method must be made after this initialization to effectively compute the minimum of the function F. More...
 
virtual ~math_BFGS ()
 
void SetBoundary (const math_Vector &theLeftBorder, const math_Vector &theRightBorder)
 Set boundaries for conditional optimization. The expected indices range of vectors is [1, NbVariables]. More...
 
void Perform (math_MultipleVarFunctionWithGradient &F, const math_Vector &StartingPoint)
 Given the starting point StartingPoint, minimization is done on the function F. The solution F = Fi is found when : 2.0 * abs(Fi - Fi-1) <= Tolerance * (abs(Fi) + abs(Fi-1) + ZEPS). Tolerance, ZEPS and maximum number of iterations are given in the constructor. More...
 
Standard_Boolean IsDone () const
 Returns true if the computations are successful, otherwise returns false. More...
 
const math_VectorLocation () const
 returns the location vector of the minimum. Exception NotDone is raised if the minimum was not found. More...
 
void Location (math_Vector &Loc) const
 outputs the location vector of the minimum in Loc. Exception NotDone is raised if the minimum was not found. Exception DimensionError is raised if the range of Loc is not equal to the range of the StartingPoint. More...
 
Standard_Real Minimum () const
 returns the value of the minimum. Exception NotDone is raised if the minimum was not found. More...
 
const math_VectorGradient () const
 Returns the gradient vector at the minimum. Exception NotDone is raised if the minimum was not found. More...
 
void Gradient (math_Vector &Grad) const
 Returns the value of 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 the minimum was not found. 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...
 

Additional Inherited Members

- Protected Attributes inherited from math_BFGS
math_Status TheStatus
 
math_Vector TheLocation
 
math_Vector TheGradient
 
Standard_Real PreviousMinimum
 
Standard_Real TheMinimum
 
Standard_Real XTol
 
Standard_Real EPSZ
 
Standard_Integer nbiter
 
Standard_Boolean myIsBoundsDefined
 
math_Vector myLeft
 
math_Vector myRight
 

Constructor & Destructor Documentation

◆ GeomInt_Gradient_BFGSOfMyGradientbisOfTheComputeLineOfWLApprox()

GeomInt_Gradient_BFGSOfMyGradientbisOfTheComputeLineOfWLApprox::GeomInt_Gradient_BFGSOfMyGradientbisOfTheComputeLineOfWLApprox ( math_MultipleVarFunctionWithGradient F,
const math_Vector StartingPoint,
const Standard_Real  Tolerance3d,
const Standard_Real  Tolerance2d,
const Standard_Real  Eps,
const Standard_Integer  NbIterations = 200 
)

Member Function Documentation

◆ IsSolutionReached()

virtual Standard_Boolean GeomInt_Gradient_BFGSOfMyGradientbisOfTheComputeLineOfWLApprox::IsSolutionReached ( math_MultipleVarFunctionWithGradient F) const
overridevirtual

This method is called at the end of each iteration to check if the solution is found. It can be redefined in a sub-class to implement a specific test to stop the iterations.

Reimplemented from math_BFGS.


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