sgpp::base::InterpolantScalarFunctionGradient Class Reference

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

#include <InterpolantScalarFunctionGradient.hpp>

Inheritance diagram for sgpp::base::InterpolantScalarFunctionGradient:

Public Member Functions
void	clone (std::unique_ptr< ScalarFunctionGradient > &clone) const override
double	eval (const DataVector &x, DataVector &gradient) override
	Evaluation of the function and its gradient.
const DataVector &	getAlpha () const
	InterpolantScalarFunctionGradient (Grid &grid, const DataVector &alpha)
	Constructor.
void	setAlpha (const DataVector &alpha)
	~InterpolantScalarFunctionGradient () override
	Destructor.
Public Member Functions inherited from sgpp::base::ScalarFunctionGradient
virtual void	eval (const DataMatrix &x, DataVector &value, DataMatrix &gradient)
	Convenience method for calculating \(f(\vec{x})\) together with \(\nabla f(\vec{x})\) for multiple \(\vec{x}\).
size_t	getNumberOfParameters () const
	ScalarFunctionGradient (size_t d)
	Constructor.
virtual	~ScalarFunctionGradient ()
	Destructor.

Protected Attributes
DataVector	alpha
	coefficient vector
Grid &	grid
	sparse grid
std::unique_ptr< OperationEvalGradient >	opEvalGradient
	pointer to evaluation operation
Protected Attributes inherited from sgpp::base::ScalarFunctionGradient
size_t	d
	dimension of the domain

Detailed Description

Sparse grid interpolant gradient of a scalar-valued function.

See also

InterpolantScalarFunction

Constructor & Destructor Documentation

InterpolantScalarFunctionGradient()

sgpp::base::InterpolantScalarFunctionGradient::InterpolantScalarFunctionGradient ( Grid &  grid, const DataVector &  alpha  )

inline

Constructor.

Do not destruct the grid before the InterpolantScalarFunctionGradient object!

Parameters

grid	sparse grid
alpha	coefficient vector

~InterpolantScalarFunctionGradient()

sgpp::base::InterpolantScalarFunctionGradient::~InterpolantScalarFunctionGradient ( )

inlineoverride

Destructor.

Member Function Documentation

clone()

void sgpp::base::InterpolantScalarFunctionGradient::clone ( std::unique_ptr< ScalarFunctionGradient > &  clone ) const

inlineoverridevirtual

Parameters

[out]

clone

pointer to cloned object

Implements sgpp::base::ScalarFunctionGradient.

References alpha, clone(), and grid.

Referenced by clone().

eval()

double sgpp::base::InterpolantScalarFunctionGradient::eval ( const DataVector &  x, DataVector &  gradient  )

inlineoverridevirtual

Evaluation of the function and its gradient.

Parameters

	x	evaluation point \(\vec{x} \in [0, 1]^d\)
[out]	gradient	gradient \(\nabla f(\vec{x}) \in \mathbb{R}^d\)

Returns

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

Implements sgpp::base::ScalarFunctionGradient.

References alpha, sgpp::base::ScalarFunctionGradient::d, and opEvalGradient.

Referenced by python.uq.analysis.asgc.ASGCAnalysis.ASGCAnalysis::estimateDensity().

getAlpha()

const DataVector & sgpp::base::InterpolantScalarFunctionGradient::getAlpha ( ) const

inline

Returns

coefficient vector

References alpha.

Referenced by python.uq.analysis.asgc.ASGCKnowledge.ASGCKnowledge::getSparseGridFunction().

setAlpha()

void sgpp::base::InterpolantScalarFunctionGradient::setAlpha ( const DataVector &  alpha )

inline

Parameters

alpha

coefficient vector

References alpha.

Member Data Documentation

alpha

DataVector sgpp::base::InterpolantScalarFunctionGradient::alpha

protected

coefficient vector

Referenced by clone(), python.learner.Learner.Learner::doLearningIteration(), eval(), getAlpha(), python.learner.Learner.Learner::learnData(), python.learner.Learner.Learner::learnDataWithTest(), python.uq.learner.Interpolant.Interpolant::learnDataWithTest(), python.uq.dists.SGDEdist.SGDEdist::pdf(), setAlpha(), and python.uq.dists.SGDEdist.SGDEdist::toJson().

grid

Grid& sgpp::base::InterpolantScalarFunctionGradient::grid

protected

sparse grid

Referenced by python.uq.dists.SGDEdist.SGDEdist::__str__(), python.learner.Learner.Learner::applyData(), python.tools.Matrix::ApplyMatrix(), python.uq.dists.SGDEdist.SGDEdist::cdf(), clone(), python.uq.learner.Interpolant.Interpolant::doLearningIteration(), python.learner.Learner.Learner::doLearningIteration(), python.learner.Classifier.Classifier::evalError(), python.uq.learner.Interpolant.Interpolant::evalError(), python.tools.Matrix::generateb(), python.controller.CheckpointController.CheckpointController::generateFoldValidationJob(), python.uq.learner.SimulationLearner.SimulationLearner::getCollocationNodes(), python.uq.learner.SimulationLearner.SimulationLearner::getGrid(), python.uq.learner.SimulationLearner.SimulationLearner::getLearner(), python.learner.Learner.Learner::learnData(), python.learner.Learner.Learner::learnDataWithFolding(), python.uq.learner.Regressor.Regressor::learnDataWithFolding(), python.learner.Learner.Learner::learnDataWithTest(), python.uq.learner.Regressor.Regressor::learnDataWithTest(), python.controller.CheckpointController.CheckpointController::loadAll(), python.uq.operations.forcePositivity.operationMakePositive.OperationMakePositive::makePositive(), python.uq.operations.forcePositivity.operationMakePositiveFast.OperationMakePositiveFast::makePositive(), python.uq.dists.SGDEdist.SGDEdist::mean(), python.uq.dists.SGDEdist.SGDEdist::pdf(), python.uq.dists.SGDEdist.SGDEdist::ppf(), python.learner.Classifier.Classifier::refineGrid(), python.learner.Regressor.Regressor::refineGrid(), python.uq.learner.Regressor.Regressor::refineGrid(), python.uq.learner.SimulationLearner.SimulationLearner::refineGrid(), python.controller.CheckpointController.CheckpointController::saveGrid(), python.controller.CheckpointController.CheckpointController::setGrid(), python.learner.Learner.Learner::setGrid(), python.uq.learner.Learner.Learner::setGrid(), python.uq.operations.forcePositivity.localFullGridSearch.LocalFullGrid::split(), python.uq.dists.SGDEdist.SGDEdist::toJson(), and python.uq.dists.SGDEdist.SGDEdist::var().

opEvalGradient

std::unique_ptr<OperationEvalGradient> sgpp::base::InterpolantScalarFunctionGradient::opEvalGradient

protected

pointer to evaluation operation

Referenced by eval().

---

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

• base/src/sgpp/base/function/scalar/InterpolantScalarFunctionGradient.hpp