SG++-Doxygen-Documentation
sgpp::combigrid::MultiIndexIterator Class Reference

Iterates over a hypercube of multi-indices. More...

#include <MultiIndexIterator.hpp>

Public Member Functions

MultiIndex getMultiIndex () const
 
size_t indexAt (size_t d) const
 
bool isValid ()
 
int moveToNext ()
 
 MultiIndexIterator (MultiIndex const &multiBounds)
 Precondition: all entries in multiBounds are > 0. More...
 
size_t numDimensions () const
 
void reset ()
 
MultiIndexvalue ()
 

Detailed Description

Iterates over a hypercube of multi-indices.

For example, with multiBounds = (2, 1), the following indices will be generated: (0, 0), (1, 0), (2, 0), (0, 1), (1, 1), (2, 1). Method descriptions can be found at BoundedSumMultiIndexIterator.

Constructor & Destructor Documentation

sgpp::combigrid::MultiIndexIterator::MultiIndexIterator ( MultiIndex const &  multiBounds)
inlineexplicit

Precondition: all entries in multiBounds are > 0.

Member Function Documentation

size_t sgpp::combigrid::MultiIndexIterator::numDimensions ( ) const
inline
void sgpp::combigrid::MultiIndexIterator::reset ( )
inline
MultiIndex& sgpp::combigrid::MultiIndexIterator::value ( )
inline

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