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

Sparse grid interpolant gradient of a vector-valued function. More...

#include <InterpolantVectorFunctionGradient.hpp>

Inheritance diagram for sgpp::optimization::InterpolantVectorFunctionGradient:
sgpp::optimization::VectorFunctionGradient

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
 Evaluation of the function and its gradient. More...
 
const base::DataMatrixgetAlpha () const
 
 InterpolantVectorFunctionGradient (base::Grid &grid, const base::DataMatrix &alpha)
 Constructor. More...
 
void setAlpha (const base::DataMatrix &alpha)
 
 ~InterpolantVectorFunctionGradient () 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

base::DataMatrix alpha
 coefficient matrix More...
 
base::Gridgrid
 sparse grid More...
 
std::unique_ptr
< base::OperationEvalGradient
opEvalGradient
 pointer to evaluation operation 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

Sparse grid interpolant gradient of a vector-valued function.

See Also
InterpolantVectorFunction

Constructor & Destructor Documentation

sgpp::optimization::InterpolantVectorFunctionGradient::InterpolantVectorFunctionGradient ( base::Grid grid,
const base::DataMatrix alpha 
)
inline

Constructor.

Do not destruct the grid before the InterpolantVectorFunctionGradient object!

Parameters
gridsparse grid
alphacoefficient matrix (j-th column contains hierarchical surplusses \(\alpha_{\cdot,j}\) of \(g_j\))

Referenced by clone().

sgpp::optimization::InterpolantVectorFunctionGradient::~InterpolantVectorFunctionGradient ( )
inlineoverride

Destructor.

Member Function Documentation

void sgpp::optimization::InterpolantVectorFunctionGradient::clone ( std::unique_ptr< VectorFunctionGradient > &  clone) const
inlineoverridevirtual
Parameters
[out]clonepointer to cloned object

Implements sgpp::optimization::VectorFunctionGradient.

References alpha, grid, and InterpolantVectorFunctionGradient().

void sgpp::optimization::InterpolantVectorFunctionGradient::eval ( const base::DataVector x,
base::DataVector value,
base::DataMatrix gradient 
)
inlineoverridevirtual

Evaluation of the function and its gradient.

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 alpha, sgpp::optimization::VectorFunctionGradient::d, opEvalGradient, and sgpp::base::DataVector::setAll().

const base::DataMatrix& sgpp::optimization::InterpolantVectorFunctionGradient::getAlpha ( ) const
inline
Returns
coefficient matrix

References alpha.

void sgpp::optimization::InterpolantVectorFunctionGradient::setAlpha ( const base::DataMatrix alpha)
inline
Parameters
alphacoefficient matrix

References alpha.

Member Data Documentation

base::DataMatrix sgpp::optimization::InterpolantVectorFunctionGradient::alpha
protected
std::unique_ptr<base::OperationEvalGradient> sgpp::optimization::InterpolantVectorFunctionGradient::opEvalGradient
protected

pointer to evaluation operation

Referenced by eval().


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