sgpp::optimization::WrapperScalarFunction Class Reference

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

#include <WrapperScalarFunction.hpp>

Inheritance diagram for sgpp::optimization::WrapperScalarFunction:

Public Types
typedef std::function< double(const base::DataVector &)>	FunctionEvalType

Public Member Functions
void	clone (std::unique_ptr< ScalarFunction > &clone) const override
double	eval (const base::DataVector &x) override
	WrapperScalarFunction (size_t d, FunctionEvalType f)
	Constructor. More...
	~WrapperScalarFunction () override
	Destructor. More...
Public Member Functions inherited from sgpp::optimization::ScalarFunction
size_t	getNumberOfParameters () const
	ScalarFunction (size_t d)
	Constructor. More...
virtual	~ScalarFunction ()
	Destructor. More...

Protected Attributes
FunctionEvalType	f
	function to be wrapped More...
Protected Attributes inherited from sgpp::optimization::ScalarFunction
size_t	d
	dimension of the domain More...

Detailed Description

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

Member Typedef Documentation

FunctionEvalType

typedef std::function<double(const base::DataVector&)> sgpp::optimization::WrapperScalarFunction::FunctionEvalType

Constructor & Destructor Documentation

WrapperScalarFunction()

sgpp::optimization::WrapperScalarFunction::WrapperScalarFunction ( size_t  d, FunctionEvalType  f  )

inline

Constructor.

Parameters

d	dimension of the domain
f	function to be wrapped

Referenced by clone().

~WrapperScalarFunction()

sgpp::optimization::WrapperScalarFunction::~WrapperScalarFunction ( )

inlineoverride

Destructor.

Member Function Documentation

clone()

void sgpp::optimization::WrapperScalarFunction::clone ( std::unique_ptr< ScalarFunction > &  clone ) const

inlineoverridevirtual

Parameters

[out]

clone

pointer to cloned object

Implements sgpp::optimization::ScalarFunction.

References sgpp::optimization::ScalarFunction::d, f, and WrapperScalarFunction().

eval()

double sgpp::optimization::WrapperScalarFunction::eval ( const base::DataVector &  x )

inlineoverridevirtual

Parameters

x	evaluation point \(\vec{x} \in [0, 1]^d\)

Returns

\(f(\vec{x})\)

Implements sgpp::optimization::ScalarFunction.

References f.

Member Data Documentation

f

FunctionEvalType sgpp::optimization::WrapperScalarFunction::f

protected

function to be wrapped

Referenced by clone(), and eval().

---

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

• optimization/src/sgpp/optimization/function/scalar/WrapperScalarFunction.hpp