CluE  1.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
CluE::SubsetIterator< T > Class Template Reference

Iterates over all subsets of a given superset. More...

#include <subsetiterator.h>

Inheritance diagram for CluE::SubsetIterator< T >:
Inheritance graph
Collaboration diagram for CluE::SubsetIterator< T >:
Collaboration graph

Public Member Functions

 SubsetIterator (std::set< T * > superset)
 Provide the superset as a set. More...
 
 SubsetIterator (std::vector< T * > superset)
 Provide the superset as a vector. More...
 
virtual size_t size () const
 Size of the current subset. More...
 
virtual void next ()
 Generates the next subset. More...
 
virtual bool hasMore () const
 Returns if the Graycode sequence is incomplete yet or not. More...
 
virtual std::set< T * > set () const
 Returns the current subset as a set. More...
 
virtual std::vector< T * > vector () const
 Returns the current subset as a vector. More...
 

Private Attributes

GraycodeSequence gcs
 
std::vector< T * > supersetVector
 
size_t supersetVectorSize
 
std::set< T * > currentSubset
 
size_t currentSize
 

Detailed Description

template<class T>
class CluE::SubsetIterator< T >

Iterates over all subsets of a given superset.

Generates all subsets of a given superset. The superset's size is not limited by the number of bits of the largest integral data type.

Definition at line 19 of file subsetiterator.h.

Constructor & Destructor Documentation

template<class T >
CluE::SubsetIterator< T >::SubsetIterator ( std::set< T * >  superset)

Provide the superset as a set.

Definition at line 68 of file subsetiterator.h.

template<class T >
CluE::SubsetIterator< T >::SubsetIterator ( std::vector< T * >  superset)

Provide the superset as a vector.

Definition at line 75 of file subsetiterator.h.

Member Function Documentation

template<class T >
size_t CluE::SubsetIterator< T >::size ( ) const
virtual

Size of the current subset.

Remarks
Use this method instead of set().size() when you do not need the set itself!

Implements CluE::SetIterator< T >.

Definition at line 82 of file subsetiterator.h.

template<class T >
void CluE::SubsetIterator< T >::next ( )
virtual

Generates the next subset.

Exceptions
std::out_of_rangeNo remaining subsets.

Implements CluE::SetIterator< T >.

Definition at line 87 of file subsetiterator.h.

template<class T >
bool CluE::SubsetIterator< T >::hasMore ( ) const
virtual

Returns if the Graycode sequence is incomplete yet or not.

Implements CluE::SetIterator< T >.

Definition at line 110 of file subsetiterator.h.

template<class T >
std::set< T * > CluE::SubsetIterator< T >::set ( ) const
virtual

Returns the current subset as a set.

Implements CluE::SetIterator< T >.

Definition at line 118 of file subsetiterator.h.

template<class T >
std::vector< T * > CluE::SubsetIterator< T >::vector ( ) const
virtual

Returns the current subset as a vector.

Remarks
set() is more efficient.

Implements CluE::SetIterator< T >.

Definition at line 123 of file subsetiterator.h.

Member Data Documentation

template<class T >
GraycodeSequence CluE::SubsetIterator< T >::gcs
private

Definition at line 61 of file subsetiterator.h.

template<class T >
std::vector<T*> CluE::SubsetIterator< T >::supersetVector
private

Definition at line 62 of file subsetiterator.h.

template<class T >
size_t CluE::SubsetIterator< T >::supersetVectorSize
private

Definition at line 63 of file subsetiterator.h.

template<class T >
std::set<T*> CluE::SubsetIterator< T >::currentSubset
private

Definition at line 64 of file subsetiterator.h.

template<class T >
size_t CluE::SubsetIterator< T >::currentSize
private

Definition at line 65 of file subsetiterator.h.


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