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

The abstract class MultipleVarFunctionWithGradient describes the virtual functions associated with a multiple variable function. More...

#include <math_MultipleVarFunctionWithGradient.hxx>

Inheritance diagram for math_MultipleVarFunctionWithGradient:
Inheritance graph
[legend]

Public Member Functions

virtual Standard_Integer NbVariables () const =0
 Returns the number of variables of the function. More...
 
virtual Standard_Boolean Value (const math_Vector &X, Standard_Real &F)=0
 Computes the values of the Functions <F> for the variable <X>. Returns True if the computation was done successfully, False otherwise. More...
 
virtual Standard_Boolean Gradient (const math_Vector &X, math_Vector &G)=0
 Computes the gradient <G> of the functions for the variable <X>. Returns True if the computation was done successfully, False otherwise. More...
 
virtual Standard_Boolean Values (const math_Vector &X, Standard_Real &F, math_Vector &G)=0
 computes the value <F> and the gradient <G> of the functions for the variable <X>. Returns True if the computation was done successfully, False otherwise. More...
 
- Public Member Functions inherited from math_MultipleVarFunction
virtual Standard_Integer GetStateNumber ()
 return the state of the function corresponding to the latestt call of any methods associated to 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_MultipleVarFunction ()
 

Detailed Description

The abstract class MultipleVarFunctionWithGradient describes the virtual functions associated with a multiple variable function.

Member Function Documentation

◆ Gradient()

virtual Standard_Boolean math_MultipleVarFunctionWithGradient::Gradient ( const math_Vector X,
math_Vector G 
)
pure virtual

◆ NbVariables()

virtual Standard_Integer math_MultipleVarFunctionWithGradient::NbVariables ( ) const
pure virtual

◆ Value()

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

◆ Values()

virtual Standard_Boolean math_MultipleVarFunctionWithGradient::Values ( const math_Vector X,
Standard_Real F,
math_Vector G 
)
pure virtual

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