GeomLib_PolyFunc Class Reference

Polynomial Function. More...

`#include <GeomLib_PolyFunc.hxx>`

Inheritance diagram for GeomLib_PolyFunc: [legend]

## Public Member Functions

GeomLib_PolyFunc (const math_Vector &Coeffs)

virtual Standard_Boolean Value (const Standard_Real X, Standard_Real &F) override
computes the value <F>of the function for the variable <X>. Returns True if the calculation were successfully done, False otherwise. More...

virtual Standard_Boolean Derivative (const Standard_Real X, Standard_Real &D) override
computes the derivative <D> of the function for the variable <X>. Returns True if the calculation were successfully done, False otherwise. More...

virtual Standard_Boolean Values (const Standard_Real X, Standard_Real &F, Standard_Real &D) override
computes the value <F> and the derivative <D> of the function for the variable <X>. Returns True if the calculation were successfully done, False otherwise. More... Public Member Functions inherited from math_FunctionWithDerivative
virtual ~math_FunctionWithDerivative () Public Member Functions inherited from math_Function
virtual ~math_Function ()
Virtual destructor, for safe inheritance. 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

Polynomial Function.

## Constructor & Destructor Documentation

 GeomLib_PolyFunc::GeomLib_PolyFunc ( const math_Vector & Coeffs )

## Member Function Documentation

 virtual Standard_Boolean GeomLib_PolyFunc::Derivative ( const Standard_Real X, Standard_Real & D )
overridevirtual

computes the derivative <D> of the function for the variable <X>. Returns True if the calculation were successfully done, False otherwise.

Implements math_FunctionWithDerivative.

 virtual Standard_Boolean GeomLib_PolyFunc::Value ( const Standard_Real X, Standard_Real & F )
overridevirtual

computes the value <F>of the function for the variable <X>. Returns True if the calculation were successfully done, False otherwise.

Implements math_FunctionWithDerivative.

 virtual Standard_Boolean GeomLib_PolyFunc::Values ( const Standard_Real X, Standard_Real & F, Standard_Real & D )
overridevirtual

computes the value <F> and the derivative <D> of the function for the variable <X>. Returns True if the calculation were successfully done, False otherwise.

Implements math_FunctionWithDerivative.

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