SG++
sgpp::base::RefinementFunctor Class Referenceabstract

Abstract class that defines the interface that refinement functors have to provide. More...

#include <RefinementFunctor.hpp>

Inheritance diagram for sgpp::base::RefinementFunctor:
sgpp::base::ForwardSelectorRefinementIndicator sgpp::base::ImpurityRefinementIndicator sgpp::base::PredictiveRefinementIndicator sgpp::base::SurplusRefinementFunctor sgpp::base::SurplusVolumeRefinementFunctor sgpp::datadriven::MultiGridRefinementFunctor sgpp::datadriven::DataBasedRefinementFunctor sgpp::datadriven::GridPointBasedRefinementFunctor sgpp::datadriven::MultiSurplusRefinementFunctor sgpp::datadriven::ZeroCrossingRefinementFunctor sgpp::datadriven::MultipleClassRefinementFunctor

Public Types

typedef double value_type
 

Public Member Functions

virtual size_t getRefinementsNum () const
 Returns the maximal number of points that should be refined. More...
 
virtual double getRefinementThreshold () const =0
 Returns the threshold for refinement. More...
 
virtual double getTotalRefinementValue (GridStorage &storage) const
 Returns the total sum of local (error) indicators used for refinement. More...
 
virtual double operator() (GridStorage &storage, size_t seq) const =0
 This should be returning a refinement value for every grid point. More...
 
 RefinementFunctor ()
 Constructor. More...
 
virtual double start () const =0
 Returns the lower bound of refinement criterion (e.g., alpha or error) (lower bound). More...
 
virtual ~RefinementFunctor ()
 Destructor. More...
 

Detailed Description

Abstract class that defines the interface that refinement functors have to provide.

Member Typedef Documentation

Constructor & Destructor Documentation

sgpp::base::RefinementFunctor::RefinementFunctor ( )
inline

Constructor.

virtual sgpp::base::RefinementFunctor::~RefinementFunctor ( )
inlinevirtual

Destructor.

References operator()(), and start().

Member Function Documentation

virtual double sgpp::base::RefinementFunctor::getTotalRefinementValue ( GridStorage storage) const
inlinevirtual

Returns the total sum of local (error) indicators used for refinement.

Parameters
storagepointer to the grids storage object
Returns
total sum of local (error) indicators used for refinement

References sgpp::base::HashGridStorage::begin(), sgpp::base::HashGridStorage::end(), and operator()().

virtual double sgpp::base::RefinementFunctor::operator() ( GridStorage storage,
size_t  seq 
) const
pure virtual

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