SG++-Doxygen-Documentation
sgpp::base::IndexInSubspaceGenerator Class Reference

Container for the index_vectors of a subspace. More...

#include <IndexInSubspaceGenerator.hpp>

Classes

class  iterator
 Iterator class compatible with STL forward iterator (no const iterator) More...
 

Public Types

typedef std::shared_ptr< value_typepointer_type
 
typedef std::pair< pointer_type, size_t > queue_value_type
 
typedef std::vector< index_tvalue_type
 

Public Member Functions

iterator begin ()
 returns an iterator to the beginning More...
 
iterator end ()
 returns an iterator to the end; More...
 
 IndexInSubspaceGenerator (const value_type &level_vector)
 Constructor. More...
 
 ~IndexInSubspaceGenerator ()
 Destructor. More...
 

Detailed Description

Container for the index_vectors of a subspace.

The subclass iterator implements the STL forward iterator

The indices are generated on the fly and hence only one iterator instance can be possible (second call to begin() will empty the working queue)

Member Typedef Documentation

◆ pointer_type

◆ queue_value_type

◆ value_type

Constructor & Destructor Documentation

◆ IndexInSubspaceGenerator()

sgpp::base::IndexInSubspaceGenerator::IndexInSubspaceGenerator ( const value_type level_vector)
explicit

Constructor.

Parameters
level_vectorstd::vector<int> with the level vector of the subspace

◆ ~IndexInSubspaceGenerator()

sgpp::base::IndexInSubspaceGenerator::~IndexInSubspaceGenerator ( )
inline

Destructor.

Member Function Documentation

◆ begin()

IndexInSubspaceGenerator::iterator sgpp::base::IndexInSubspaceGenerator::begin ( )

returns an iterator to the beginning

Returns
iterator to the beginning

References python.statsfileInfo::i.

Referenced by sgpp::base::IndexInSubspaceGenerator::iterator::operator!=(), and sgpp::base::SubspaceRefinement::refineGridpointsCollection().

◆ end()

iterator sgpp::base::IndexInSubspaceGenerator::end ( )
inline

returns an iterator to the end;

Returns
iterator to the end

References sgpp::base::IndexInSubspaceGenerator::iterator::iterator().

Referenced by sgpp::base::SubspaceRefinement::refineGridpointsCollection().


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