SG++
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
sgpp::optimization::WrapperVectorFunctionGradient Class Reference

Implementation of VectorFunctionGradient that wraps a std::function object. More...

#include <WrapperVectorFunctionGradient.hpp>

Inheritance diagram for sgpp::optimization::WrapperVectorFunctionGradient:
sgpp::optimization::VectorFunctionGradient

Public Types

typedef std::function< void(const
base::DataVector
&, base::DataVector
&, base::DataMatrix &)> 
FunctionGradientEvalType
 

Public Member Functions

void clone (std::unique_ptr< VectorFunctionGradient > &clone) const override
 
void eval (const base::DataVector &x, base::DataVector &value, base::DataMatrix &gradient) override
 
 WrapperVectorFunctionGradient (size_t d, size_t m, FunctionGradientEvalType fGradient)
 Constructor. More...
 
 ~WrapperVectorFunctionGradient () override
 Destructor. More...
 
- Public Member Functions inherited from sgpp::optimization::VectorFunctionGradient
size_t getNumberOfComponents () const
 
size_t getNumberOfParameters () const
 
 VectorFunctionGradient (size_t d, size_t m)
 Constructor. More...
 
virtual ~VectorFunctionGradient ()
 Destructor. More...
 

Protected Attributes

FunctionGradientEvalType fGradient
 function gradient to be wrapped More...
 
- Protected Attributes inherited from sgpp::optimization::VectorFunctionGradient
size_t d
 dimension of the domain More...
 
size_t m
 number of components More...
 

Detailed Description

Implementation of VectorFunctionGradient that wraps a std::function object.

Member Typedef Documentation

Constructor & Destructor Documentation

sgpp::optimization::WrapperVectorFunctionGradient::WrapperVectorFunctionGradient ( size_t  d,
size_t  m,
FunctionGradientEvalType  fGradient 
)
inline

Constructor.

Parameters
ddimension of the domain
mnumber of components
fGradientfunction gradient to be wrapped

Referenced by clone().

sgpp::optimization::WrapperVectorFunctionGradient::~WrapperVectorFunctionGradient ( )
inlineoverride

Destructor.

Member Function Documentation

void sgpp::optimization::WrapperVectorFunctionGradient::clone ( std::unique_ptr< VectorFunctionGradient > &  clone) const
inlineoverridevirtual
void sgpp::optimization::WrapperVectorFunctionGradient::eval ( const base::DataVector x,
base::DataVector value,
base::DataMatrix gradient 
)
inlineoverridevirtual
Parameters
[in]xevaluation point \(\vec{x} \in [0, 1]^d\)
[out]value\(g(\vec{x})\)
[out]gradientJacobian \(\nabla g(\vec{x}) \in \mathbb{R}^{m \times d}\)

Implements sgpp::optimization::VectorFunctionGradient.

References fGradient.

Member Data Documentation

FunctionGradientEvalType sgpp::optimization::WrapperVectorFunctionGradient::fGradient
protected

function gradient to be wrapped

Referenced by clone(), and eval().


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