RefinementDecorator enhances the behavior of underlying Refinement objects using Decorator design pattern . More...

#include <RefinementDecorator.hpp>

Inheritance diagram for sgpp::base::RefinementDecorator:

Public Member Functions
bool	checkAdmissibility (GridStorage &storage, GridPoint &subspace)

virtual void	free_refine (GridStorage &storage, RefinementFunctor &functor, std::vector< size_t > *addedPoints=0)
	Refines a grid according to a RefinementFunctor provided. More...

virtual size_t	getNumberOfRefinablePoints (GridStorage &storage)
	Computes and returns the number of grid points, which can be refined. More...

virtual void	refineGridpoint1D (GridStorage &storage, GridPoint &point, size_t d)
	Refine one grid point along a single direction. More...

	RefinementDecorator (AbstractRefinement *refinement)
	Constructor. More...

virtual	~RefinementDecorator ()

Public Member Functions inherited from sgpp::base::AbstractRefinement
virtual size_t	getIndexOfMin (RefinementFunctor::value_type *array, size_t length)
	Returns the index of the first occurrence of minimal element in array. More...

bool	isRefinable (GridStorage &storage, GridPoint &point)
	Check if the grid point is refinable. More...

virtual void	refineGridpoint1D (GridStorage &storage, size_t seq, size_t d)
	Refine one grid point along a single direction. More...

virtual	~AbstractRefinement ()
	Destructor. More...

Protected Member Functions
virtual void	collectRefinablePoints (GridStorage &storage, RefinementFunctor &functor, AbstractRefinement::refinement_container_type &collection)
	Examines the grid points and stores the indices those that can be refined and have maximal indicator values. More...

virtual void	createGridpoint (GridStorage &storage, GridPoint &point)
	This method creates a new point on the grid. More...

AbstractRefinement *	get_decorated_refinement ()
	Returns the pointer to decorated Refinement object. More...

virtual AbstractRefinement::refinement_list_type	getIndicator (GridStorage &storage, const GridStorage::grid_map_iterator &iter, const RefinementFunctor &functor) const
	Generates a list with indicator elements. More...

virtual void	refineGridpoint (GridStorage &storage, size_t refine_index)
	This method refines a grid point by generating the children in every dimension of the grid and all their missing ancestors by calling create_gridpoint(). More...

virtual void	refineGridpointsCollection (GridStorage &storage, RefinementFunctor &functor, AbstractRefinement::refinement_container_type &collection)
	Refines the collection of points. More...

void	set_decorated_refiment (AbstractRefinement *refinement)
	Sets the pointer of the decorated Refinement object to the given object. More...

Protected Member Functions inherited from sgpp::base::AbstractRefinement
virtual void	createGridpoint1D (GridPoint &point, size_t d, GridStorage &storage, index_t &source_index, level_t &source_level)
	Creates children grid points along single direction. More...

virtual void	createGridpointSubroutine (GridStorage &storage, GridPoint &point)
	Subroutine for grid point creation. More...

Additional Inherited Members
Public Types inherited from sgpp::base::AbstractRefinement
typedef std::vector< refinement_pair_type >	refinement_container_type
	Container for the collection of the refinement atoms and the corresponding value. More...

typedef AbstractRefinement_refinement_key	refinement_key_type
	Type of the identifier of the refinement atom (e.g. More...

typedef std::forward_list< AbstractRefinement::refinement_pair_type >	refinement_list_type

typedef std::pair< std::shared_ptr< refinement_key_type >, refinement_value_type >	refinement_pair_type
	Pair for the refinement key and value. More...

typedef double	refinement_value_type
	Type of functor value assigned to each refinement atom. More...

Static Public Member Functions inherited from sgpp::base::AbstractRefinement
static bool	compare_pairs (const refinement_pair_type &lhs, const refinement_pair_type &rhs)
	Comparison of the refinement_pair_type. More...

Detailed Description

RefinementDecorator enhances the behavior of underlying Refinement objects using Decorator design pattern .

Although not abstract, this class is thought to be a base class as it simply delegates the function calls to the decorated object. Subclasses will implement more sophisticated behavior.

Constructor & Destructor Documentation

◆ RefinementDecorator()

sgpp::base::RefinementDecorator::RefinementDecorator ( AbstractRefinement * refinement )

inlineexplicit

Constructor.

Parameters

refinement object implementing the core functionality (e.g. refinement with or without boundaries).

◆ ~RefinementDecorator()

virtual sgpp::base::RefinementDecorator::~RefinementDecorator ( )

inlinevirtual

References checkAdmissibility(), free_refine(), getNumberOfRefinablePoints(), chess::point, and refineGridpoint1D().

Member Function Documentation

◆ checkAdmissibility()

bool sgpp::base::RefinementDecorator::checkAdmissibility	(	GridStorage &	storage,
		GridPoint &	subspace
	)

Referenced by ~RefinementDecorator().

◆ collectRefinablePoints()

void sgpp::base::RefinementDecorator::collectRefinablePoints	(	GridStorage &	storage,
		RefinementFunctor &	functor,
		AbstractRefinement::refinement_container_type &	collection
	)

protectedvirtual

Examines the grid points and stores the indices those that can be refined and have maximal indicator values.

Parameters

storage	hashmap that stores the grid points
functor	a PredictiveRefinementIndicator specifying the refinement criteria
collection	container that contains elements to refine (empty initially)

Implements sgpp::base::AbstractRefinement.

Reimplemented in sgpp::base::PredictiveRefinement, sgpp::base::ForwardSelectorRefinement, sgpp::base::ImpurityRefinement, and sgpp::base::SubspaceRefinement.

References sgpp::base::AbstractRefinement::collectRefinablePoints().

Referenced by set_decorated_refiment().

◆ createGridpoint()

void sgpp::base::RefinementDecorator::createGridpoint	(	GridStorage &	storage,
		GridPoint &	point
	)

protectedvirtual

This method creates a new point on the grid.

It checks if some parents or children are needed in other dimensions.

Parameters

storage	hashmap that stores the gridpoints
point	The point that should be inserted

Implements sgpp::base::AbstractRefinement.

References sgpp::base::AbstractRefinement::createGridpoint().

Referenced by set_decorated_refiment().

◆ free_refine()

void sgpp::base::RefinementDecorator::free_refine	(	GridStorage &	storage,
		RefinementFunctor &	functor,
		std::vector< size_t > *	addedPoints = `0`
	)

virtual

Refines a grid according to a RefinementFunctor provided.

Refines up to RefinementFunctor::getRefinementsNum() grid points if possible, and if their refinement value is larger than RefinementFunctor::start() and their absolute value is larger or equal than RefinementFunctor::getRefinementThreshold()

Parameters

storage	hashmap that stores the grid points
functor	a RefinementFunctor specifying the refinement criteria
addedPoints	pointer to vector to append newly created grid points to

Implements sgpp::base::AbstractRefinement.

Reimplemented in sgpp::base::SubspaceRefinement.

References sgpp::base::AbstractRefinement::free_refine().

Referenced by ~RefinementDecorator().

◆ get_decorated_refinement()

AbstractRefinement* sgpp::base::RefinementDecorator::get_decorated_refinement ( )

inlineprotected

Returns the pointer to decorated Refinement object.

◆ getIndicator()

AbstractRefinement::refinement_list_type sgpp::base::RefinementDecorator::getIndicator	(	GridStorage &	storage,
		const GridStorage::grid_map_iterator &	iter,
		const RefinementFunctor &	functor
	)		const

protectedvirtual

Generates a list with indicator elements.

Parameters

storage	grid storage
iter	iterator
functor	refinement functor

Returns: list with indicator elements

Implements sgpp::base::AbstractRefinement.

Reimplemented in sgpp::base::PredictiveRefinement, sgpp::base::ForwardSelectorRefinement, and sgpp::base::ImpurityRefinement.

References sgpp::base::AbstractRefinement::getIndicator().

Referenced by sgpp::base::SubspaceRefinement::collectRefinablePoints(), and set_decorated_refiment().

◆ getNumberOfRefinablePoints()

size_t sgpp::base::RefinementDecorator::getNumberOfRefinablePoints ( GridStorage & storage )

virtual

Computes and returns the number of grid points, which can be refined.

This is the number of grid points that have at least one child missing.

Parameters

storage hashmap that stores the grid points

Returns: The number of grid points that can be refined

Implements sgpp::base::AbstractRefinement.

References sgpp::base::AbstractRefinement::getNumberOfRefinablePoints().

Referenced by ~RefinementDecorator().

◆ refineGridpoint()

void sgpp::base::RefinementDecorator::refineGridpoint	(	GridStorage &	storage,
		size_t	refine_index
	)

protectedvirtual

This method refines a grid point by generating the children in every dimension of the grid and all their missing ancestors by calling create_gridpoint().

Parameters

storage	hashmap that stores the gridpoints
refine_index	The index in the hashmap of the point that should be refined

Implements sgpp::base::AbstractRefinement.

References sgpp::base::AbstractRefinement::refineGridpoint().

Referenced by sgpp::base::SubspaceRefinement::refineGridpointsCollection(), sgpp::base::ImpurityRefinement::refineGridpointsCollection(), sgpp::base::ForwardSelectorRefinement::refineGridpointsCollection(), and set_decorated_refiment().

◆ refineGridpoint1D()

void sgpp::base::RefinementDecorator::refineGridpoint1D	(	GridStorage &	storage,
		GridPoint &	point,
		size_t	d
	)

virtual

Refine one grid point along a single direction.

Parameters

storage	hashmap that stores the grid points
point	point to refine
d	direction

Implements sgpp::base::AbstractRefinement.

References sgpp::base::AbstractRefinement::refineGridpoint1D().

Referenced by sgpp::base::PredictiveRefinement::refineGridpointsCollection(), and ~RefinementDecorator().

◆ refineGridpointsCollection()

void sgpp::base::RefinementDecorator::refineGridpointsCollection	(	GridStorage &	storage,
		RefinementFunctor &	functor,
		AbstractRefinement::refinement_container_type &	collection
	)

protectedvirtual

Refines the collection of points.

Parameters

storage	hashmap that stores the grid points
functor	a PredictiveRefinementIndicator specifying the refinement criteria
collection	container that contains elements to refine (empty initially)

Implements sgpp::base::AbstractRefinement.

Reimplemented in sgpp::base::PredictiveRefinement, sgpp::base::ForwardSelectorRefinement, sgpp::base::ImpurityRefinement, and sgpp::base::SubspaceRefinement.

References sgpp::base::AbstractRefinement::refineGridpointsCollection().

Referenced by sgpp::base::ForwardSelectorRefinement::ForwardSelectorRefinement(), sgpp::base::ImpurityRefinement::ImpurityRefinement(), set_decorated_refiment(), and sgpp::base::PredictiveRefinement::setAlpha().