SG++-Doxygen-Documentation
sgpp::combigrid::AbstractPointHierarchy Class Referenceabstract

Contains all the necessary information about a family of one-dimensional grids: More...

#include <AbstractPointHierarchy.hpp>

Inheritance diagram for sgpp::combigrid::AbstractPointHierarchy:
sgpp::combigrid::NestedPointHierarchy sgpp::combigrid::NonNestedPointHierarchy

Public Member Functions

virtual size_t getNumPoints (size_t level)=0
 
virtual double getPoint (size_t level, size_t index)=0
 
virtual std::vector< double > getPoints (size_t level, bool sorted)=0
 
virtual std::shared_ptr< AbstractPermutationIteratorgetSortedPermutationIterator (size_t level)=0
 
virtual bool isNested ()=0
 
virtual ~AbstractPointHierarchy ()
 

Detailed Description

Contains all the necessary information about a family of one-dimensional grids:

  • Point distribution
  • Level-numPoints-mapping
  • Point sorting
  • Hierarchy information

Derived classes of AbstractPointHierarchy also save the grid points, avoiding expensive re-computation.

Constructor & Destructor Documentation

sgpp::combigrid::AbstractPointHierarchy::~AbstractPointHierarchy ( )
virtual

Member Function Documentation

virtual size_t sgpp::combigrid::AbstractPointHierarchy::getNumPoints ( size_t  level)
pure virtual
Returns
Returns the number of points in the given level.

Implemented in sgpp::combigrid::NestedPointHierarchy, and sgpp::combigrid::NonNestedPointHierarchy.

virtual double sgpp::combigrid::AbstractPointHierarchy::getPoint ( size_t  level,
size_t  index 
)
pure virtual
Returns
Returns the grid point for the given level and index. (0 <= index < getNumPoints(level))

Implemented in sgpp::combigrid::NestedPointHierarchy, and sgpp::combigrid::NonNestedPointHierarchy.

virtual std::vector<double> sgpp::combigrid::AbstractPointHierarchy::getPoints ( size_t  level,
bool  sorted 
)
pure virtual
Returns
Returns a vector with all points for the given level. If sorted == true, then the points returned are sorted. Depending on the configured PointOrdering, this might be slower than not sorting the points.

Implemented in sgpp::combigrid::NestedPointHierarchy, and sgpp::combigrid::NonNestedPointHierarchy.

Referenced by python.data.DataContainer.DataContainer::combine(), python.data.DataContainer.DataContainer::getDataSubsetByIndexList(), python.data.DataContainer.DataContainer::getPointsValues(), and python.data.DataContainer.DataContainer::toString().

virtual std::shared_ptr<AbstractPermutationIterator> sgpp::combigrid::AbstractPointHierarchy::getSortedPermutationIterator ( size_t  level)
pure virtual
Returns
Returns a permutation iterator which can be used to traverse the points in their sorted (ascending) order.

Implemented in sgpp::combigrid::NestedPointHierarchy, and sgpp::combigrid::NonNestedPointHierarchy.

virtual bool sgpp::combigrid::AbstractPointHierarchy::isNested ( )
pure virtual
Returns
Returns true if the points of a level are always a subset of the points at the next level. This should also mean that the points that are common to two levels share the same indices.

Implemented in sgpp::combigrid::NestedPointHierarchy, and sgpp::combigrid::NonNestedPointHierarchy.


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