Open CASCADE Technology  7.6.0.dev
Public Member Functions
math_Function Class Referenceabstract

This abstract class describes the virtual functions associated with a Function of a single variable. More...

#include <math_Function.hxx>

Inheritance diagram for math_Function:
Inheritance graph
[legend]

Public Member Functions

virtual ~math_Function ()
 Virtual destructor, for safe inheritance. More...
 
virtual Standard_Boolean Value (const Standard_Real X, Standard_Real &F)=0
 Computes the value of the function <F> for a given value of variable <X>. returns True if the computation was done successfully, False otherwise. More...
 
virtual Standard_Integer GetStateNumber ()
 returns the state of the function corresponding to the latest call of any methods associated with the function. This function is called by each of the algorithms described later which defined the function Integer Algorithm::StateNumber(). The algorithm has the responsibility to call this function when it has found a solution (i.e. a root or a minimum) and has to maintain the association between the solution found and this StateNumber. Byu default, this method returns 0 (which means for the algorithm: no state has been saved). It is the responsibility of the programmer to decide if he needs to save the current state of the function and to return an Integer that allows retrieval of the state. More...
 

Detailed Description

This abstract class describes the virtual functions associated with a Function of a single variable.

Constructor & Destructor Documentation

◆ ~math_Function()

virtual math_Function::~math_Function ( )
inlinevirtual

Virtual destructor, for safe inheritance.

Member Function Documentation

◆ GetStateNumber()

virtual Standard_Integer math_Function::GetStateNumber ( )
virtual

returns the state of the function corresponding to the latest call of any methods associated with the function. This function is called by each of the algorithms described later which defined the function Integer Algorithm::StateNumber(). The algorithm has the responsibility to call this function when it has found a solution (i.e. a root or a minimum) and has to maintain the association between the solution found and this StateNumber. Byu default, this method returns 0 (which means for the algorithm: no state has been saved). It is the responsibility of the programmer to decide if he needs to save the current state of the function and to return an Integer that allows retrieval of the state.

Reimplemented in BRepGProp_TFunction, Contap_ArcFunction, Geom2dInt_PCLocFOfTheLocateExtPCOfTheProjPCurOfGInter, Extrema_PCFOfEPCOfELPCOfLocateExtPC, Extrema_PCFOfEPCOfELPCOfLocateExtPC2d, Extrema_PCFOfEPCOfExtPC, Extrema_PCFOfEPCOfExtPC2d, Extrema_PCLocFOfLocEPCOfLocateExtPC, Extrema_PCLocFOfLocEPCOfLocateExtPC2d, HLRBRep_PCLocFOfTheLocateExtPCOfTheProjPCurOfCInter, and IntPatch_ArcFunction.

◆ Value()

virtual Standard_Boolean math_Function::Value ( const Standard_Real  X,
Standard_Real F 
)
pure virtual

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