SG++-Doxygen-Documentation
Public Types | Public Member Functions | List of all members
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

◆ value_type

typedef double sgpp::base::RefinementFunctor::value_type

Constructor & Destructor Documentation

◆ RefinementFunctor()

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

Constructor.

◆ ~RefinementFunctor()

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

Destructor.

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

Member Function Documentation

◆ getRefinementsNum()

virtual size_t sgpp::base::RefinementFunctor::getRefinementsNum ( ) const
inlinevirtual

Returns the maximal number of points that should be refined.

The maximal number of points to refine is set in the constructor of the implementing class.

Returns
number of points that should refined. Default value: 1.

Reimplemented in sgpp::base::PredictiveRefinementIndicator, sgpp::base::ImpurityRefinementIndicator, sgpp::base::ForwardSelectorRefinementIndicator, sgpp::datadriven::DataBasedRefinementFunctor, sgpp::datadriven::ZeroCrossingRefinementFunctor, sgpp::datadriven::GridPointBasedRefinementFunctor, sgpp::datadriven::MultiSurplusRefinementFunctor, sgpp::base::SurplusVolumeRefinementFunctor, and sgpp::base::SurplusRefinementFunctor.

References getRefinementThreshold().

Referenced by sgpp::base::HashRefinementInteraction::collectRefinablePoints(), sgpp::base::MultipleClassRefinement::collectRefinablePoints(), sgpp::base::SubspaceRefinement::collectRefinablePoints(), sgpp::base::ImpurityRefinement::collectRefinablePoints(), sgpp::base::ForwardSelectorRefinement::collectRefinablePoints(), sgpp::base::HashRefinement::collectRefinablePoints(), sgpp::base::HashRefinementBoundaries::collectRefinablePoints(), sgpp::base::PredictiveRefinement::collectRefinablePoints(), sgpp::optimization::HashRefinementMultiple::collectRefinablePoints(), and sgpp::base::HashRefinementBoundariesMaxLevel::refineToMaxLevel().

◆ getRefinementThreshold()

virtual double sgpp::base::RefinementFunctor::getRefinementThreshold ( ) const
pure virtual

Returns the threshold for refinement.

Only the grid points with absolute value of refinement criterion (e.g., alpha or error) greater or equal to this threshold will be refined.

Returns
threshold value for refinement. Default value: 0.

Implemented in sgpp::base::PredictiveRefinementIndicator, sgpp::base::ImpurityRefinementIndicator, sgpp::base::ForwardSelectorRefinementIndicator, sgpp::datadriven::DataBasedRefinementFunctor, sgpp::datadriven::ZeroCrossingRefinementFunctor, sgpp::datadriven::GridPointBasedRefinementFunctor, sgpp::datadriven::MultiSurplusRefinementFunctor, sgpp::base::SurplusVolumeRefinementFunctor, and sgpp::base::SurplusRefinementFunctor.

Referenced by getRefinementsNum(), sgpp::base::HashRefinement::refineGridpointsCollection(), sgpp::base::HashRefinementBoundaries::refineGridpointsCollection(), sgpp::base::PredictiveRefinement::refineGridpointsCollection(), and sgpp::base::HashRefinementBoundariesMaxLevel::refineToMaxLevel().

◆ getTotalRefinementValue()

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()().

◆ operator()()

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

This should be returning a refinement value for every grid point.

The point with the highest value will be refined first.

Parameters
storagereference to the grids storage object
seqsequence number in the coefficients array
Returns
refinement value

Implemented in sgpp::base::PredictiveRefinementIndicator, sgpp::base::ImpurityRefinementIndicator, sgpp::base::ForwardSelectorRefinementIndicator, sgpp::datadriven::DataBasedRefinementFunctor, sgpp::datadriven::ZeroCrossingRefinementFunctor, sgpp::datadriven::GridPointBasedRefinementFunctor, sgpp::datadriven::MultipleClassRefinementFunctor, sgpp::datadriven::MultiSurplusRefinementFunctor, sgpp::base::SurplusVolumeRefinementFunctor, and sgpp::base::SurplusRefinementFunctor.

Referenced by getTotalRefinementValue(), and ~RefinementFunctor().

◆ start()

virtual double sgpp::base::RefinementFunctor::start ( ) const
pure virtual

Returns the lower bound of refinement criterion (e.g., alpha or error) (lower bound).

The refinement value of grid points to be refined have to be larger than this value

Returns
lower bound

Implemented in sgpp::base::PredictiveRefinementIndicator, sgpp::base::ImpurityRefinementIndicator, sgpp::base::ForwardSelectorRefinementIndicator, sgpp::datadriven::DataBasedRefinementFunctor, sgpp::datadriven::ZeroCrossingRefinementFunctor, sgpp::datadriven::GridPointBasedRefinementFunctor, sgpp::datadriven::MultiSurplusRefinementFunctor, sgpp::base::SurplusVolumeRefinementFunctor, and sgpp::base::SurplusRefinementFunctor.

Referenced by sgpp::base::PredictiveRefinement::refineGridpointsCollection(), sgpp::base::HashRefinementBoundariesMaxLevel::refineToMaxLevel(), and ~RefinementFunctor().

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