math_FunctionSetWithDerivatives Class Referenceabstract

This abstract class describes the virtual functions associated with a set of N Functions each of M independant variables. More...

`#include <math_FunctionSetWithDerivatives.hxx>`

Inheritance diagram for math_FunctionSetWithDerivatives:
[legend]

Public Member Functions

virtual Standard_Integer NbVariables () const =0
Returns the number of variables of the function. More...

virtual Standard_Integer NbEquations () const =0
Returns the number of equations of the function. More...

virtual Standard_Boolean Value (const math_Vector &X, math_Vector &F)=0
Computes the values <F> of the Functions for the variable <X>. Returns True if the computation was done successfully, False otherwise. More...

virtual Standard_Boolean Derivatives (const math_Vector &X, math_Matrix &D)=0
Returns the values <D> of the derivatives for the variable <X>. Returns True if the computation was done successfully, False otherwise. More...

virtual Standard_Boolean Values (const math_Vector &X, math_Vector &F, math_Matrix &D)=0
returns the values <F> of the functions and the derivatives <D> for the variable <X>. Returns True if the computation was done successfully, False otherwise. More...

Public Member Functions inherited from math_FunctionSet
virtual Standard_Integer GetStateNumber ()
Returns the state of the function corresponding to the latestcall of any methods associated with the function. This function is called by each of the algorithms described later which define 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...

virtual ~math_FunctionSet ()

Detailed Description

This abstract class describes the virtual functions associated with a set of N Functions each of M independant variables.

Member Function Documentation

 virtual Standard_Boolean math_FunctionSetWithDerivatives::Derivatives ( const math_Vector & X, math_Matrix & D )
pure virtual
 virtual Standard_Integer math_FunctionSetWithDerivatives::NbVariables ( ) const
pure virtual
 virtual Standard_Boolean math_FunctionSetWithDerivatives::Value ( const math_Vector & X, math_Vector & F )
pure virtual
 virtual Standard_Boolean math_FunctionSetWithDerivatives::Values ( const math_Vector & X, math_Vector & F, math_Matrix & D )
pure virtual

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