Abstract base class for one-dimensional numerical evaluation methods. More...

#include <AbstractEvaluator.hpp>

Inheritance diagram for sgpp::combigrid::AbstractEvaluator< V >:

Public Member Functions
virtual std::shared_ptr< AbstractEvaluator< V > >	clone ()=0
	Clones the AbstractEvaluator object. More...

virtual V	eval ()=0
	Evaluates the numerical method on the already set grid points. More...

virtual EvaluatorConfiguration	getConfig ()
	(Currently not used). More...

virtual bool	needsOrderedPoints ()=0

virtual bool	needsParameter ()=0

virtual void	setBasisCoefficientsAtGridPoints (std::vector< double > &newBasisCoefficients)=0
	set the basis coefficients for the linear combination. More...

virtual void	setConfig (EvaluatorConfiguration newEvalConfig)

virtual void	setGridPoints (std::vector< double > const &xValues)=0
	Sets the grid points for evaluation. More...

void	setLevel (size_t level)
	This is used to set the level in case an evaluator needs it. More...

virtual void	setParameter (V const &param)=0
	Via this method, the parameter can be set. More...

virtual	~AbstractEvaluator ()

Protected Attributes
EvaluatorConfiguration	evalConfig

size_t	level = 0

Detailed Description

template<typename V>
class sgpp::combigrid::AbstractEvaluator< V >

Abstract base class for one-dimensional numerical evaluation methods.

Currently, only its derived class AbstractLinearEvaluator is used.

The template parameter is used for switching between single-evaluation and multi-evaluation, see FloatArrayVector.

Constructor & Destructor Documentation

◆ ~AbstractEvaluator()

template<typename V>

virtual sgpp::combigrid::AbstractEvaluator< V >::~AbstractEvaluator ( )

inlinevirtual

Member Function Documentation

◆ clone()

template<typename V>

virtual std::shared_ptr<AbstractEvaluator<V> > sgpp::combigrid::AbstractEvaluator< V >::clone ( )

pure virtual

Clones the AbstractEvaluator object.

Implemented in sgpp::combigrid::AbstractLinearEvaluator< V >, sgpp::combigrid::AbstractLinearEvaluator< FloatArrayVector >, sgpp::combigrid::AbstractLinearEvaluator< FloatScalarVector >, and sgpp::combigrid::AbstractLinearEvaluator< FloatTensorVector >.

Referenced by sgpp::combigrid::AbstractEvaluator< FloatTensorVector >::setLevel().

◆ eval()

template<typename V>

virtual V sgpp::combigrid::AbstractEvaluator< V >::eval ( )

pure virtual

Evaluates the numerical method on the already set grid points.

Implemented in sgpp::combigrid::AbstractLinearEvaluator< V >, sgpp::combigrid::AbstractLinearEvaluator< FloatArrayVector >, sgpp::combigrid::AbstractLinearEvaluator< FloatScalarVector >, and sgpp::combigrid::AbstractLinearEvaluator< FloatTensorVector >.

Referenced by python.uq.analysis.asgc.ASGCAnalysis.ASGCAnalysis::estimateDensity(), and sgpp::combigrid::AbstractEvaluator< FloatTensorVector >::setLevel().

◆ getConfig()

template<typename V>

virtual EvaluatorConfiguration sgpp::combigrid::AbstractEvaluator< V >::getConfig ( )

inlinevirtual

(Currently not used).

Via the template type V, multiple arrays of function values for multiple functions might be specified and a result for each of these functions should be returned. This could be used in an alternative implementation to FullGridTensorEvaluator that would also be able to handle non-linear one-dimensional methods.

Returns: type of the operation

◆ needsOrderedPoints()

template<typename V>

virtual bool sgpp::combigrid::AbstractEvaluator< V >::needsOrderedPoints ( )

pure virtual

Returns: true iff the grid points have to be provided in ascending order (for example for linear interpolation).

Referenced by sgpp::combigrid::AbstractEvaluator< FloatTensorVector >::setLevel().

◆ needsParameter()

template<typename V>

virtual bool sgpp::combigrid::AbstractEvaluator< V >::needsParameter ( )

pure virtual

Returns: true iff this evaluation method needs a parameter (e.g. true for interpolation, false for quadrature).

Referenced by sgpp::combigrid::AbstractEvaluator< FloatTensorVector >::setLevel().

◆ setBasisCoefficientsAtGridPoints()

template<typename V>

virtual void sgpp::combigrid::AbstractEvaluator< V >::setBasisCoefficientsAtGridPoints ( std::vector< double > & newBasisCoefficients )

pure virtual

set the basis coefficients for the linear combination.

In case of linear or polynomial interpolation these basis coefficients are function evaluations

Parameters

newBasisCoefficients the new coefficients

Referenced by sgpp::combigrid::AbstractEvaluator< FloatTensorVector >::setLevel().

◆ setConfig()

template<typename V>

virtual void sgpp::combigrid::AbstractEvaluator< V >::setConfig ( EvaluatorConfiguration newEvalConfig )

inlinevirtual

◆ setGridPoints()

template<typename V>

virtual void sgpp::combigrid::AbstractEvaluator< V >::setGridPoints ( std::vector< double > const & xValues )

pure virtual

Sets the grid points for evaluation.

The evaluation method should allow for arbitrary grid points to achieve maximal modularity.

Referenced by sgpp::combigrid::AbstractEvaluator< FloatTensorVector >::setLevel().

◆ setLevel()

template<typename V>

void sgpp::combigrid::AbstractEvaluator< V >::setLevel ( size_t level )

inline

This is used to set the level in case an evaluator needs it.

◆ setParameter()

template<typename V>

virtual void sgpp::combigrid::AbstractEvaluator< V >::setParameter ( V const & param )

pure virtual

Via this method, the parameter can be set.

Referenced by sgpp::combigrid::AbstractEvaluator< FloatTensorVector >::setLevel().

Member Data Documentation

◆ evalConfig

template<typename V>

EvaluatorConfiguration sgpp::combigrid::AbstractEvaluator< V >::evalConfig

protected

Referenced by sgpp::combigrid::AbstractEvaluator< FloatTensorVector >::getConfig().

◆ level

template<typename V>

size_t sgpp::combigrid::AbstractEvaluator< V >::level = 0

protected

Referenced by python.uq.operations.forcePositivity.localFullGridSearch.LocalFullGrid::__eq__(), python.learner.folding.FoldingPolicy.FoldingPolicy::__next__(), python.uq.operations.forcePositivity.localFullGridSearch.LocalFullGrid::contains(), python.uq.operations.forcePositivity.localFullGridSearch.LocalFullGrid::containsDimx(), python.uq.learner.builder.GridDescriptor.GridDescriptor::createGrid(), python.uq.estimators.MarginalIntegralStrategy.MarginalIntegralStrategy::estimate(), python.uq.learner.builder.GridDescriptor.GridDescriptor::fromGrid(), python.uq.operations.forcePositivity.localFullGridSearch.LocalFullGrid::getLevelIndex(), python.uq.operations.forcePositivity.localFullGridSearch.LocalFullGrid::getMaxLevel(), python.uq.operations.forcePositivity.localFullGridSearch.LocalFullGrid::overlap(), python.uq.operations.forcePositivity.localFullGridSearch.LocalFullGrid::overlapDimx(), sgpp::combigrid::AbstractEvaluator< FloatTensorVector >::setLevel(), python.uq.operations.forcePositivity.localFullGridSearch.LocalFullGrid::transformToReferenceGrid(), python.uq.manager.ASGCStatistics.ASGCStatistics::updateResults(), python.uq.learner.SimulationLearner.SimulationLearner::updateResults(), python.uq.learner.builder.GridDescriptor.GridDescriptor::withLevel(), and python.uq.learner.builder.RegressorSpecificationDescriptor.FoldingDescriptor::withLevel().

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

combigrid/src/sgpp/combigrid/operation/onedim/AbstractEvaluator.hpp

Public Member Functions

Protected Attributes

Detailed Description

template<typename V> class sgpp::combigrid::AbstractEvaluator< V >

Constructor & Destructor Documentation

◆ ~AbstractEvaluator()

Member Function Documentation

◆ clone()

◆ eval()

◆ getConfig()

◆ needsOrderedPoints()

◆ needsParameter()

◆ setBasisCoefficientsAtGridPoints()

◆ setConfig()

◆ setGridPoints()

◆ setLevel()

◆ setParameter()

Member Data Documentation

◆ evalConfig

◆ level

template<typename V>
class sgpp::combigrid::AbstractEvaluator< V >