Generic hash table based storage of grid points. More...

#include <HashGridStorage.hpp>

Public Types
typedef HashGridIterator	grid_iterator
	iterator for grid points More...

typedef std::vector< point_pointer >	grid_list
	vector of index_pointers More...

typedef grid_list::const_iterator	grid_list_const_iterator
	const iterator of grid_list More...

typedef grid_list::iterator	grid_list_iterator
	iterator of grid_list More...

typedef std::unordered_map< point_pointer, size_t, HashGridPointPointerHashFunctor, HashGridPointPointerEqualityFunctor >	grid_map
	unordered_map of index_pointers More...

typedef grid_map::const_iterator	grid_map_const_iterator
	const_iterator of grid_map More...

typedef grid_map::iterator	grid_map_iterator
	iterator of grid_map More...

typedef const HashGridPoint *	index_const_pointer
	pointer to constant index_type More...

typedef HashGridPoint *	point_pointer
	pointer to index_type More...

typedef HashGridPoint	point_type
	type of grid points More...

Public Member Functions
grid_map_iterator	begin ()
	set iterator to the first position in the map More...

void	clear ()
	deletes all grid points in the storage More...

point_pointer	create (point_type &index)
	creates a pointer to index from a reference to index by creating a new instance of a index object More...

void	deleteLast ()
	This methods removes the gridpoint added last. More...

std::vector< size_t >	deletePoints (std::list< size_t > &removePoints)
	Remove several point from HashGridStorage. More...

void	destroy (point_pointer index)
	removes an index from gridstorage More...

grid_map_iterator	end ()
	sets the iterator to last position in the map More...

grid_map_iterator	find (point_pointer index)
	sets the iterator to a given index More...

std::vector< size_t >	getAlgorithmicDimensions ()
	returns the algorithmic dimensions (the dimensions in which the Up Down operations should be applied) More...

BoundingBox *	getBoundingBox ()
	get the bounding box of the current grid More...

double	getCoordinate (HashGridPoint point, size_t d) const
	Calculates the coordinate of a given grid point in specific dimension. More...

void	getCoordinateArrays (DataMatrix &coordinates)
	Converts this storage from AOS (array of structures) to SOA (structure of array) to speed up operations on the position of the grid points. More...

void	getCoordinates (const HashGridPoint &point, DataVector &coordinates) const
	Calculates the coordinates of a given grid point. More...

DataVector	getCoordinates (const HashGridPoint &point) const
	Calculates the coordinates of a given grid point. More...

size_t	getDimension () const
	gets the dimension of the grid More...

void	getLevelForIntegral (DataMatrix &level)
	Converts this storage from AOS (array of structures) to SOA (structure of array) with modification to speed up iterative Laplace Calculations: the level won't contain the levels, it contains 2 to the neagative power of the level. More...

void	getLevelIndexArraysForEval (DataMatrix &level, DataMatrix &index)
	Converts this storage from AOS (array of structures) to SOA (structure of array) with modification to speed up iterative function evaluation. More...

void	getLevelIndexArraysForEval (DataMatrixSP &level, DataMatrixSP &index)
	Converts this storage from AOS (array of structures) to SOA (structure of array) with modification to speed up iterative function evaluation. More...

void	getLevelIndexMaskArraysForModEval (DataMatrix &level, DataMatrix &index, DataMatrix &mask, DataMatrix &offset)
	Converts this storage from AOS (array of structures) to SOA (structure of array) with modification to speed up iterative function evaluation. More...

void	getLevelIndexMaskArraysForModEval (DataMatrixSP &level, DataMatrixSP &index, DataMatrixSP &mask, DataMatrixSP &offset)
	Converts this storage from AOS (array of structures) to SOA (structure of array) with modification to speed up iterative function evaluation. More...

size_t	getMaxLevel () const
	returns the max. More...

size_t	getNumberOfInnerPoints () const
	gets the number of inner grid points More...

HashGridPoint &	getPoint (size_t seq) const
	gets the index number for given gridpoint by its sequence number More...

size_t	getSequenceNumber (HashGridPoint &index) const
	Gets the seq number for index. More...

size_t	getSize () const
	gets the size of the hashmap More...

Stretching *	getStretching ()
	get the stretching bounding box of the current grid More...

double	getUnitCoordinate (HashGridPoint point, size_t d) const
	Calculates corresponding unit hypercube coordinate of a given point in specific dimension, taking into account the BoundingBox and Stretching. More...

	HashGridStorage (size_t dimension)
	Constructor. More...

	HashGridStorage (BoundingBox &creationBoundingBox)
	Constructor. More...

	HashGridStorage (Stretching &creationStretching)
	Constructor. More...

	HashGridStorage (std::string &istr)
	Constructor that reads the data from a string. More...

	HashGridStorage (std::istream &istream)
	Constructor that reads the data from an input stream. More...

	HashGridStorage (HashGridStorage &copyFrom)
	Copy Constructor. More...

size_t	insert (const point_type &index)
	insert a new index into map More...

void	insert (point_type &index, std::vector< size_t > &insertedPoints)
	insert a new index into map including all its ancestors. More...

bool	isContaining (HashGridPoint &index) const
	Tests if index is in the storage. More...

bool	isInvalidSequenceNumber (size_t s)
	Tests if seq number does not point to a valid grid point. More...

void	operator= (const HashGridStorage &other)
	Assignment operator. More...

HashGridPoint &	operator[] (size_t seq)
	gets the index number for given gridpoint by its sequence number More...

const HashGridPoint &	operator[] (size_t seq) const
	gets the index number for given gridpoint by its sequence number More...

void	recalcLeafProperty ()
	Recalculates the leaf-property of every grid point. More...

std::string	serialize (int version=SERIALIZATION_VERSION) const
	serialize the gridstorage into a string More...

void	serialize (std::ostream &ostream, int version=SERIALIZATION_VERSION) const
	serialize the gridstorage into a stream More...

void	setAlgorithmicDimensions (std::vector< size_t > newAlgoDims)
	sets the algorithmic dimensions (the dimensions in which the Up Down operations should be applied) More...

void	setBoundingBox (BoundingBox &boundingBox)
	sets the bounding box of the current grid More...

void	setStretching (Stretching &stretching)
	sets the stretching bounding box of the current grid More...

unsigned int	store (point_pointer index)
	stores a given index in the hashmap More...

std::string	toString () const
	serialize the gridstorage's gridpoints into a stream More...

void	toString (std::ostream &stream) const
	serialize the gridstorage's gridpoints into a stream More...

void	unserializeNoAlgoDims (std::string &istr)
	unserializes the grid from a string, algorithmic dimensions are not reseted More...

void	update (point_type &index, size_t pos)
	updates an already stored index More...

	~HashGridStorage ()
	Destructor. More...

Detailed Description

Generic hash table based storage of grid points.

Member Typedef Documentation

◆ grid_iterator

typedef HashGridIterator sgpp::base::HashGridStorage::grid_iterator

iterator for grid points

◆ grid_list

typedef std::vector<point_pointer> sgpp::base::HashGridStorage::grid_list

vector of index_pointers

◆ grid_list_const_iterator

typedef grid_list::const_iterator sgpp::base::HashGridStorage::grid_list_const_iterator

const iterator of grid_list

◆ grid_list_iterator

typedef grid_list::iterator sgpp::base::HashGridStorage::grid_list_iterator

iterator of grid_list

◆ grid_map

typedef std::unordered_map<point_pointer, size_t, HashGridPointPointerHashFunctor, HashGridPointPointerEqualityFunctor> sgpp::base::HashGridStorage::grid_map

unordered_map of index_pointers

◆ grid_map_const_iterator

typedef grid_map::const_iterator sgpp::base::HashGridStorage::grid_map_const_iterator

const_iterator of grid_map

◆ grid_map_iterator

typedef grid_map::iterator sgpp::base::HashGridStorage::grid_map_iterator

iterator of grid_map

◆ index_const_pointer

typedef const HashGridPoint* sgpp::base::HashGridStorage::index_const_pointer

pointer to constant index_type

◆ point_pointer

typedef HashGridPoint* sgpp::base::HashGridStorage::point_pointer

pointer to index_type

◆ point_type

typedef HashGridPoint sgpp::base::HashGridStorage::point_type

type of grid points

Constructor & Destructor Documentation

◆ HashGridStorage() [1/6]

sgpp::base::HashGridStorage::HashGridStorage ( size_t dimension )

explicit

Constructor.

initializes the boundingBox with a trivial cube

Parameters

dimension the dimension of the sparse grid

References python.statsfileInfo::i.

◆ HashGridStorage() [2/6]

sgpp::base::HashGridStorage::HashGridStorage ( BoundingBox & creationBoundingBox )

explicit

Constructor.

initializes the boundingBox with a reference to another boundingbox

Parameters

creationBoundingBox reference to bounding box object that describes the grid boundaries

References python.statsfileInfo::i.

◆ HashGridStorage() [3/6]

sgpp::base::HashGridStorage::HashGridStorage ( Stretching & creationStretching )

explicit

Constructor.

initializes the stretching with a reference to another stretching

Parameters

creationStretching reference to stretching object that describes the grid boundaries and the stretching

References python.statsfileInfo::i.

◆ HashGridStorage() [4/6]

sgpp::base::HashGridStorage::HashGridStorage ( std::string & istr )

explicit

Constructor that reads the data from a string.

Parameters

istr	the string that contains the data

References python.statsfileInfo::i.

◆ HashGridStorage() [5/6]

sgpp::base::HashGridStorage::HashGridStorage ( std::istream & istream )

explicit

Constructor that reads the data from an input stream.

Parameters

istream the inputstream that contains the data

References python.statsfileInfo::i.

◆ HashGridStorage() [6/6]

sgpp::base::HashGridStorage::HashGridStorage ( HashGridStorage & copyFrom )

explicit

Copy Constructor.

References getSize(), python.statsfileInfo::i, and insert().

◆ ~HashGridStorage()

sgpp::base::HashGridStorage::~HashGridStorage ( )

Destructor.

Member Function Documentation

◆ begin()

HashGridStorage::grid_map_iterator sgpp::base::HashGridStorage::begin ( )

inline

set iterator to the first position in the map

Returns: iterator pointing to the beginning of the map

◆ clear()

void sgpp::base::HashGridStorage::clear ( )

deletes all grid points in the storage

Referenced by sgpp::base::PrewaveletGridGenerator::getNumberOfRefinablePoints(), operator=(), and sgpp::optimization::file_io::readGrid().

◆ create()

HashGridStorage::point_pointer sgpp::base::HashGridStorage::create ( point_type & index )

inline

creates a pointer to index from a reference to index by creating a new instance of a index object

Parameters

index address of index object

Returns: pointer to new index object

References insert().

Referenced by getPoint().

◆ deleteLast()

void sgpp::base::HashGridStorage::deleteLast ( )

This methods removes the gridpoint added last.

Use with coution, only needed for expanding the grid because of the shadow-storage of prewavelets. Please refer to the Prewavelet grid for further description of the shadow storage.

Referenced by getPoint(), sgpp::base::OperationHierarchisationPrewavelet::shrinkGrid(), and sgpp::pde::UpDownOneOpDimWithShadow::shrinkGrid().

◆ deletePoints()

std::vector< size_t > sgpp::base::HashGridStorage::deletePoints ( std::list< size_t > & removePoints )

Remove several point from HashGridStorage.

The points to removed are stored in a list. This function returns a vector of remaining points given by their

Parameters

removePoints vector containing the indices of the points that should be removed

Returns: a vector containing the indices of remaining points given by their "old" index

References python.statsfileInfo::i, and recalcLeafProperty().

Referenced by sgpp::base::HashCoarsening::free_coarsen_NFirstOnly(), sgpp::optimization::IterativeGridGenerator::undoRefinement(), and sgpp::datadriven::RefinementHandler::updateClassVariablesAfterRefinement().

◆ destroy()

void sgpp::base::HashGridStorage::destroy ( point_pointer index )

inline

removes an index from gridstorage

Parameters

index pointer to index that should be removed

Referenced by getPoint().

◆ end()

HashGridStorage::grid_map_iterator sgpp::base::HashGridStorage::end ( )

inline

sets the iterator to last position in the map

Returns: iterator pointing to the end of the map

◆ find()

HashGridStorage::grid_map_iterator sgpp::base::HashGridStorage::find ( point_pointer index )

inline

sets the iterator to a given index

Parameters

index the index to which the cursor should be moved

Returns: iterator pointing to the index

Referenced by sgpp::base::HashRefinementInteraction::collectRefinablePoints(), sgpp::base::SubspaceRefinement::collectRefinablePoints(), sgpp::base::HashRefinement::collectRefinablePoints(), sgpp::base::HashRefinementBoundaries::collectRefinablePoints(), sgpp::base::HashRefinementBoundaries::createGridpointLevelZeroConsistency(), sgpp::base::AbstractRefinement::createGridpointSubroutine(), sgpp::pde::OperationParabolicPDESolverSystemDirichlet::generateRHS(), sgpp::base::ImpurityRefinement::getIndicator(), sgpp::base::ForwardSelectorRefinement::getIndicator(), sgpp::base::PredictiveRefinement::getIndicator(), sgpp::base::HashRefinementBoundaries::getNumberOfRefinablePoints(), sgpp::base::HashRefinement::getNumberOfRefinablePoints(), sgpp::base::PrewaveletGridGenerator::getNumberOfRefinablePoints(), sgpp::base::HashRefinementBoundariesMaxLevel::getNumberOfRefinablePointsToMaxLevel(), getPoint(), sgpp::base::AbstractRefinement::isRefinable(), sgpp::solver::StepsizeControl::maxNorm(), sgpp::base::PrewaveletGridGenerator::refine(), and sgpp::base::HashRefinementBoundariesMaxLevel::refineToMaxLevel().

◆ getAlgorithmicDimensions()

std::vector< size_t > sgpp::base::HashGridStorage::getAlgorithmicDimensions ( )

inline

returns the algorithmic dimensions (the dimensions in which the Up Down operations should be applied)

Returns: the algorithmic dimensions

Referenced by sgpp::pde::HeatEquationParabolicPDESolverSystemParallelOMP::applyLOperatorComplete(), sgpp::pde::HeatEquationParabolicPDESolverSystemParallelOMP::applyLOperatorInner(), sgpp::base::Grid::getAlgorithmicDimensions(), and getPoint().

◆ getBoundingBox()

BoundingBox * sgpp::base::HashGridStorage::getBoundingBox ( )

get the bounding box of the current grid

Returns: returns a pointer to HashGridStorage's bounding box

◆ getCoordinate()

double sgpp::base::HashGridStorage::getCoordinate	(	HashGridPoint	point,
		size_t	d
	)		const

inline

Calculates the coordinate of a given grid point in specific dimension.

In contrast to HashGridPoint::getStandardCoordinate, this takes the BoundingBox and Stretching into account.

Parameters

point	grid point
d	dimension

Returns: coordinate of the point in dimension d

References sgpp::base::HashGridPoint::get(), sgpp::base::Stretching::getCoordinate(), sgpp::base::BoundingBox::getIntervalOffset(), sgpp::base::BoundingBox::getIntervalWidth(), sgpp::base::HashGridPoint::getStandardCoordinate(), and level.

Referenced by sgpp::optimization::IterativeGridGenerator::evalFunction(), sgpp::optimization::HierarchisationSLE::evalNakBsplineBoundaryCombigridFunctionAtGridPoint(), getCoordinates(), getUnitCoordinate(), and sgpp::optimization::file_io::writeGrid().

◆ getCoordinateArrays()

void sgpp::base::HashGridStorage::getCoordinateArrays ( DataMatrix & coordinates )

Converts this storage from AOS (array of structures) to SOA (structure of array) to speed up operations on the position of the grid points.

Parameters

coordinates DataMatrix to store the coordinates of the grid points

References getCoordinates(), python.statsfileInfo::i, sgpp::base::DataMatrix::resize(), and sgpp::base::DataMatrix::setRow().

Referenced by sgpp::base::OperationArbitraryBoundaryHierarchisation::doDehierarchisation(), sgpp::base::OperationArbitraryBoundaryHierarchisation::doHierarchisation(), and getPoint().

◆ getCoordinates() [1/2]

void sgpp::base::HashGridStorage::getCoordinates	(	const HashGridPoint &	point,
		DataVector &	coordinates
	)		const

Calculates the coordinates of a given grid point.

In contrast to HashGridPoint::getStandardCoordinates, this takes the BoundingBox and Stretching into account.

Parameters

	point	grid point
[out]	coordinates	vector of coordinates

References getCoordinate().

◆ getCoordinates() [2/2]

DataVector sgpp::base::HashGridStorage::getCoordinates ( const HashGridPoint & point ) const

Calculates the coordinates of a given grid point.

In contrast to HashGridPoint::getStandardCoordinates, this takes the BoundingBox and Stretching into account.

Parameters

point grid point

Returns: vector of coordinates

References getCoordinate().

◆ getDimension()

size_t sgpp::base::HashGridStorage::getDimension ( ) const

gets the dimension of the grid

Returns: the dimension of the grid stored in this HashGridStorage object

◆ getLevelForIntegral()

void sgpp::base::HashGridStorage::getLevelForIntegral ( DataMatrix & level )

Converts this storage from AOS (array of structures) to SOA (structure of array) with modification to speed up iterative Laplace Calculations: the level won't contain the levels, it contains 2 to the neagative power of the level.

Parameters

level DataMatrix to store the grid's modified level

References python.statsfileInfo::i, sgpp::combigrid::pow(), and sgpp::base::DataMatrix::set().

Referenced by getPoint().

◆ getLevelIndexArraysForEval() [1/2]

void sgpp::base::HashGridStorage::getLevelIndexArraysForEval	(	DataMatrix &	level,
		DataMatrix &	index
	)

Converts this storage from AOS (array of structures) to SOA (structure of array) with modification to speed up iterative function evaluation.

The Level array won't contain the levels, it contains the level to the power of two

Parameters

level	DataMatrix to store the grid's level to the power of two
index	DataMatrix to store the grid's indices

References python.statsfileInfo::i, and sgpp::base::DataMatrix::set().

◆ getLevelIndexArraysForEval() [2/2]

void sgpp::base::HashGridStorage::getLevelIndexArraysForEval	(	DataMatrixSP &	level,
		DataMatrixSP &	index
	)

Converts this storage from AOS (array of structures) to SOA (structure of array) with modification to speed up iterative function evaluation.

The Level array won't contain the levels, it contains the level to the power of two

Parameters

level	DataMatrix to store the grid's level to the power of two
index	DataMatrix to store the grid's indices

References python.statsfileInfo::i, and sgpp::base::DataMatrixSP::set().

◆ getLevelIndexMaskArraysForModEval() [1/2]

void sgpp::base::HashGridStorage::getLevelIndexMaskArraysForModEval	(	DataMatrix &	level,
		DataMatrix &	index,
		DataMatrix &	mask,
		DataMatrix &	offset
	)

Converts this storage from AOS (array of structures) to SOA (structure of array) with modification to speed up iterative function evaluation.

The Level array won't contain the levels, it contains the level to the power of two.

The returned format is only useful for a multi-evaluation of modlinear grids

Parameters

level	DataMatrix to store the grid's level to the power of two
index	DataMatrix to store the grid's indices
mask	DataMatrix to store masks of operations
offset	DataMatrix to store offset for operations

References python.statsfileInfo::i, and sgpp::base::DataMatrix::set().

Referenced by getPoint().

◆ getLevelIndexMaskArraysForModEval() [2/2]

void sgpp::base::HashGridStorage::getLevelIndexMaskArraysForModEval	(	DataMatrixSP &	level,
		DataMatrixSP &	index,
		DataMatrixSP &	mask,
		DataMatrixSP &	offset
	)

Converts this storage from AOS (array of structures) to SOA (structure of array) with modification to speed up iterative function evaluation.

The Level array won't contain the levels, it contains the level to the power of two.

The returned format is only useful for a multi-evaluation of modlinear grids

Parameters

level	DataMatrixSP to store the grid's level to the power of two
index	DataMatrixSP to store the grid's indices
mask	DataMatrixSP to store masks of operations
offset	DataMatrixSP to store offset for operations

References sgpp::base::BoundingBox1D::bDirichletLeft, sgpp::base::BoundingBox1D::bDirichletRight, python.statsfileInfo::f, python.statsfileInfo::i, sgpp::base::BoundingBox1D::leftBoundary, recalcLeafProperty(), sgpp::base::BoundingBox1D::rightBoundary, SERIALIZATION_VERSION, sgpp::base::DataMatrixSP::set(), sgpp::base::BoundingBox::setBoundary(), sgpp::base::BoundingBox::unserialize(), and sgpp::base::Stretching::unserialize().

◆ getMaxLevel()

size_t sgpp::base::HashGridStorage::getMaxLevel ( ) const

returns the max.

depth in all dimension of the grid

References python.statsfileInfo::i.

Referenced by getPoint(), sgpp::datadriven::OperationMakePositive::initialize(), sgpp::datadriven::OperationMakePositiveFindIntersectionCandidates::nextCandidates(), sgpp::datadriven::OperationMakePositiveLoadFullGridCandidates::nextCandidates(), and sgpp::datadriven::OperationMakePositiveHybridFindIntersectionCandidates::nextCandidates().

◆ getNumberOfInnerPoints()

size_t sgpp::base::HashGridStorage::getNumberOfInnerPoints ( ) const

gets the number of inner grid points

Returns: the number of inner grid points

References friedman::p.

Referenced by sgpp::base::DirichletGridConverter::buildInnerGridWithCoefs(), sgpp::pde::PDESolver::getNumberInnerGridPoints(), and sgpp::base::DirichletGridConverter::rebuildInnerGridWithCoefs().

◆ getPoint()

HashGridPoint& sgpp::base::HashGridStorage::getPoint ( size_t seq ) const

inline

gets the index number for given gridpoint by its sequence number

Parameters

seq	the sequence number of the index

Returns: gridpoint object (pointer)

References begin(), create(), deleteLast(), destroy(), end(), find(), getAlgorithmicDimensions(), getBoundingBox(), getCoordinateArrays(), getLevelForIntegral(), getLevelIndexArraysForEval(), getLevelIndexMaskArraysForModEval(), getMaxLevel(), getSequenceNumber(), getStretching(), insert(), isContaining(), isInvalidSequenceNumber(), level, recalcLeafProperty(), create_scripts::s, setAlgorithmicDimensions(), setBoundingBox(), setStretching(), store(), and update().

◆ getSequenceNumber()

size_t sgpp::base::HashGridStorage::getSequenceNumber ( HashGridPoint & index ) const

inline

Gets the seq number for index.

Parameters

index pointer to index which sequence number should be determined

Returns: the seq number for index

◆ getSize()

size_t sgpp::base::HashGridStorage::getSize ( ) const

gets the size of the hashmap

Returns: returns the size of the hashmap

◆ getStretching()

Stretching * sgpp::base::HashGridStorage::getStretching ( )

get the stretching bounding box of the current grid

Returns: returns a pointer to HashGridStorage's bounding box

Referenced by getPoint(), sgpp::base::Grid::getStretching(), sgpp::pde::UpdPhidPhiBBIterativeLinearStretchedBoundary::operator()(), sgpp::pde::DowndPhidPhiBBIterativeLinearStretchedBoundary::operator()(), sgpp::pde::DowndPhidPhiBBIterativeLinearStretched::operator()(), and sgpp::base::DehierarchisationLinearStretched::rec().

◆ getUnitCoordinate()

double sgpp::base::HashGridStorage::getUnitCoordinate	(	HashGridPoint	point,
		size_t	d
	)		const

inline

Calculates corresponding unit hypercube coordinate of a given point in specific dimension, taking into account the BoundingBox and Stretching.

References getCoordinate(), getCoordinates(), chess::point, and sgpp::base::BoundingBox::transformPointToUnitCube().

◆ insert() [1/2]

size_t sgpp::base::HashGridStorage::insert ( const point_type & index )

insert a new index into map

Parameters

index reference to the index that should be inserted

Returns

◆ insert() [2/2]

void sgpp::base::HashGridStorage::insert	(	point_type &	index,
		std::vector< size_t > &	insertedPoints
	)

insert a new index into map including all its ancestors.

Boundary points are not added

Parameters

index	reference to the index that should be inserted
insertedPoints	containing the indices of the new points

Returns

References sgpp::base::HashGridPoint::getIndex(), sgpp::base::HashGridPoint::getLevel(), sgpp::base::HashGridPoint::getParent(), python.statsfileInfo::i, insert(), isContaining(), and sgpp::base::HashGridPoint::set().

◆ isContaining()

bool sgpp::base::HashGridStorage::isContaining ( HashGridPoint & index ) const

inline

Tests if index is in the storage.

Parameters

index pointer to index that should be tested

Returns: true if the index is in the storage

Referenced by sgpp::datadriven::OperationMakePositiveInterpolateExp::computeHierarchicalCoefficients(), sgpp::combigrid::convertexpUniformBoundaryCombigridToHierarchicalSparseGrid(), sgpp::base::HashRefinementBoundaries::createGridpointLevelZeroConsistency(), sgpp::base::AbstractRefinement::createGridpointSubroutine(), sgpp::datadriven::OperationDensityConditional::doConditional(), sgpp::datadriven::OperationDensityMarginalize::doMarginalize(), sgpp::datadriven::OperationMakePositiveFindIntersectionCandidates::findIntersections(), sgpp::datadriven::OperationMakePositiveFindIntersectionCandidatesJoin::findIntersections(), sgpp::datadriven::OperationMakePositiveHybridFindIntersectionCandidates::findIntersections(), sgpp::optimization::IterativeGridGeneratorRitterNovak::generate(), getPoint(), sgpp::base::HashGridIterator::hintLeft(), sgpp::base::HashGridIterator::hintRight(), insert(), sgpp::datadriven::OperationMakePositive::makeCurrentNodalValuesPositive(), sgpp::datadriven::MultipleClassRefinementFunctor::operator()(), recalcLeafProperty(), sgpp::base::MultipleClassRefinement::refineGridpoint(), sgpp::base::HashRefinementBoundaries::refineGridpoint1D(), sgpp::base::HashRefinementBoundariesMaxLevel::refineGridpoint1D(), sgpp::base::HashRefinement::refineGridpoint1D(), and sgpp::optimization::HashRefinementMultiple::refineGridpoint1D().

◆ isInvalidSequenceNumber()

bool sgpp::base::HashGridStorage::isInvalidSequenceNumber ( size_t s )

inline

Tests if seq number does not point to a valid grid point.

Parameters

s	sequence number that should be tested

Returns: true if we are not EOF

◆ operator=()

void sgpp::base::HashGridStorage::operator= ( const HashGridStorage & other )

Assignment operator.

References clear(), getSize(), python.statsfileInfo::i, and insert().

◆ operator[]() [1/2]

HashGridPoint& sgpp::base::HashGridStorage::operator[] ( size_t seq )

inline

gets the index number for given gridpoint by its sequence number

Parameters

seq	the sequence number of the index

Returns: gridpoint object (pointer)

◆ operator[]() [2/2]

const HashGridPoint& sgpp::base::HashGridStorage::operator[] ( size_t seq ) const

inline

gets the index number for given gridpoint by its sequence number

Parameters

seq	the sequence number of the index

Returns: gridpoint object (constant pointer)

◆ recalcLeafProperty()

void sgpp::base::HashGridStorage::recalcLeafProperty ( )

Recalculates the leaf-property of every grid point.

This might be useful in case of a grid unserialization

References sgpp::base::HashGridPoint::get(), sgpp::base::HashGridPoint::getLeftChild(), sgpp::base::HashGridPoint::getRightChild(), python.statsfileInfo::i, isContaining(), chess::point, sgpp::base::HashGridPoint::set(), and sgpp::base::HashGridPoint::setLeaf().

Referenced by sgpp::combigrid::convertCombigridToHierarchicalSparseGrid(), sgpp::combigrid::convertexpUniformBoundaryCombigridToHierarchicalSparseGrid(), deletePoints(), sgpp::datadriven::OperationDensityConditional::doConditional(), sgpp::datadriven::OperationDensityMarginalize::doMarginalize(), getLevelIndexMaskArraysForModEval(), getPoint(), sgpp::datadriven::OperationMakePositive::makeCurrentNodalValuesPositive(), sgpp::datadriven::MultipleClassRefinementFunctor::operator()(), and sgpp::datadriven::RefinementHandler::updateClassVariablesAfterRefinement().

◆ serialize() [1/2]

std::string sgpp::base::HashGridStorage::serialize ( int version = SERIALIZATION_VERSION ) const

serialize the gridstorage into a string

Parameters

version the serialization version of the file

Returns: a string that contains all gridstorage information

Referenced by sgpp::base::Grid::serialize(), python.utils.GzipSerializer.GzipSerializer::serializeToFile(), python.learner.formatter.LearnerFormatter.LearnerFormatter::serializeToFile(), python.learner.formatter.LearnedKnowledgeFormatter.LearnedKnowledgeFormatter::serializeToFile(), python.learner.formatter.GridFormatter.GridFormatter::serializeToFile(), python.uq.analysis.asgc.ASGCKnowledgeFormatter.ASGCKnowledgeFormatter::serializeToFile(), python.uq.sampler.asgc.ASGCSamplerFormatter.ASGCSamplerFormatter::serializeToFile(), and python.uq.uq_setting.UQSettingFormatter.UQSettingFormatter::serializeToFile().

◆ serialize() [2/2]

void sgpp::base::HashGridStorage::serialize	(	std::ostream &	ostream,
		int	version = `SERIALIZATION_VERSION`
	)		const

serialize the gridstorage into a stream

Parameters

ostream	reference to a stream into that all gridstorage information is written
version	the serialization version of the file

References sgpp::base::Stretching::getStretchingMode(), sgpp::base::BoundingBox::serialize(), and sgpp::base::Stretching::serialize().

Referenced by python.utils.GzipSerializer.GzipSerializer::serializeToFile(), python.learner.formatter.LearnerFormatter.LearnerFormatter::serializeToFile(), python.learner.formatter.LearnedKnowledgeFormatter.LearnedKnowledgeFormatter::serializeToFile(), python.learner.formatter.GridFormatter.GridFormatter::serializeToFile(), python.uq.analysis.asgc.ASGCKnowledgeFormatter.ASGCKnowledgeFormatter::serializeToFile(), python.uq.sampler.asgc.ASGCSamplerFormatter.ASGCSamplerFormatter::serializeToFile(), and python.uq.uq_setting.UQSettingFormatter.UQSettingFormatter::serializeToFile().

◆ setAlgorithmicDimensions()

void sgpp::base::HashGridStorage::setAlgorithmicDimensions ( std::vector< size_t > newAlgoDims )

sets the algorithmic dimensions (the dimensions in which the Up Down operations should be applied)

Parameters

newAlgoDims std::vector containing the algorithmic dimensions

References python.statsfileInfo::i.

Referenced by getPoint(), and sgpp::base::Grid::setAlgorithmicDimensions().

◆ setBoundingBox()

void sgpp::base::HashGridStorage::setBoundingBox ( BoundingBox & boundingBox )

sets the bounding box of the current grid

Parameters

boundingBox bounding box to which the HashGridStorage's pointer is set

Referenced by getPoint(), and sgpp::base::Grid::setBoundingBox().

◆ setStretching()

void sgpp::base::HashGridStorage::setStretching ( Stretching & stretching )

sets the stretching bounding box of the current grid

Parameters

stretching stretching to which the HashGridStorage's pointer is set

Referenced by sgpp::base::BsplineClenshawCurtisGrid::BsplineClenshawCurtisGrid(), getPoint(), sgpp::base::LinearClenshawCurtisBoundaryGrid::LinearClenshawCurtisBoundaryGrid(), sgpp::base::LinearClenshawCurtisGrid::LinearClenshawCurtisGrid(), sgpp::base::ModBsplineClenshawCurtisGrid::ModBsplineClenshawCurtisGrid(), sgpp::base::ModLinearClenshawCurtisGrid::ModLinearClenshawCurtisGrid(), sgpp::base::ModPolyClenshawCurtisGrid::ModPolyClenshawCurtisGrid(), sgpp::base::PolyClenshawCurtisBoundaryGrid::PolyClenshawCurtisBoundaryGrid(), sgpp::base::PolyClenshawCurtisGrid::PolyClenshawCurtisGrid(), and sgpp::base::Grid::setStretching().

◆ store()

unsigned int sgpp::base::HashGridStorage::store ( point_pointer index )

inline

stores a given index in the hashmap

Parameters

index pointer to index that should be stored

Returns: sequence number

Referenced by getPoint().

◆ toString() [1/2]

std::string sgpp::base::HashGridStorage::toString ( ) const

serialize the gridstorage's gridpoints into a stream

Returns: returns the string that contains all gridpoint information

Referenced by python.controller.LearnerEventController.LearnerEventController::__repr__(), python.controller.SolverEventController.SolverEventController::__repr__(), python.uq.learner.Learner.Learner::createMemento(), python.learner.Learner.Learner::createMemento(), and python.learner.formatter.GridFormatter.GridFormatter::serialize().

◆ toString() [2/2]

void sgpp::base::HashGridStorage::toString ( std::ostream & stream ) const

serialize the gridstorage's gridpoints into a stream

Parameters

stream reference to a stream into that all gridpoint information is written

References python.statsfileInfo::i.

Referenced by python.controller.LearnerEventController.LearnerEventController::__repr__(), python.controller.SolverEventController.SolverEventController::__repr__(), python.uq.learner.Learner.Learner::createMemento(), python.learner.Learner.Learner::createMemento(), and python.learner.formatter.GridFormatter.GridFormatter::serialize().

◆ unserializeNoAlgoDims()

void sgpp::base::HashGridStorage::unserializeNoAlgoDims ( std::string & istr )

unserializes the grid from a string, algorithmic dimensions are not reseted

Parameters

istr	the string that contains the data

◆ update()

void sgpp::base::HashGridStorage::update	(	point_type &	index,
		size_t	pos
	)

updates an already stored index

Parameters

index	reference to the index that should be updated
pos	position where the index should be stored

References insert().

Referenced by sgpp::base::HashGenerator::cliques_iter(), sgpp::base::HashGenerator::createFullGridIterative(), sgpp::base::HashGenerator::createFullGridTruncatedIterative(), getPoint(), python.uq.refinement.RefinementStrategy.Ranking::rank(), sgpp::base::HashGenerator::regular_boundary_truncated_iter(), sgpp::base::HashGenerator::regular_inter_iter(), sgpp::base::HashGenerator::regular_iter(), sgpp::base::HashGenerator::regular_periodic_boundary_iter(), and python.learner.LearnedKnowledge.LearnedKnowledge::setMemento().

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

base/src/sgpp/base/grid/storage/hashmap/HashGridStorage.hpp
base/src/sgpp/base/grid/storage/hashmap/HashGridStorage.cpp

Public Types

Public Member Functions

Detailed Description

Member Typedef Documentation

◆ grid_iterator

◆ grid_list

◆ grid_list_const_iterator

◆ grid_list_iterator

◆ grid_map

◆ grid_map_const_iterator

◆ grid_map_iterator

◆ index_const_pointer

◆ point_pointer

◆ point_type

Constructor & Destructor Documentation

◆ HashGridStorage() [1/6]

◆ HashGridStorage() [2/6]

◆ HashGridStorage() [3/6]

◆ HashGridStorage() [4/6]

◆ HashGridStorage() [5/6]

◆ HashGridStorage() [6/6]

◆ ~HashGridStorage()

Member Function Documentation

◆ begin()

◆ clear()

◆ create()

◆ deleteLast()

◆ deletePoints()

◆ destroy()

◆ end()

◆ find()

◆ getAlgorithmicDimensions()

◆ getBoundingBox()

◆ getCoordinate()

◆ getCoordinateArrays()

◆ getCoordinates() [1/2]

◆ getCoordinates() [2/2]

◆ getDimension()

◆ getLevelForIntegral()

◆ getLevelIndexArraysForEval() [1/2]

◆ getLevelIndexArraysForEval() [2/2]

◆ getLevelIndexMaskArraysForModEval() [1/2]

◆ getLevelIndexMaskArraysForModEval() [2/2]

◆ getMaxLevel()

◆ getNumberOfInnerPoints()

◆ getPoint()

◆ getSequenceNumber()

◆ getSize()

◆ getStretching()

◆ getUnitCoordinate()

◆ insert() [1/2]

◆ insert() [2/2]

◆ isContaining()

◆ isInvalidSequenceNumber()

◆ operator=()

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ recalcLeafProperty()

◆ serialize() [1/2]

◆ serialize() [2/2]

◆ setAlgorithmicDimensions()

◆ setBoundingBox()

◆ setStretching()

◆ store()

◆ toString() [1/2]

◆ toString() [2/2]

◆ unserializeNoAlgoDims()

◆ update()