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

Iterates over all fixed-size subsets of a given superset. More...

#include <fixedsizesubsetiterator.h>

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

Public Member Functions

 FixedSizeSubsetIterator (std::set< T * > superset, size_t size)
 Provide the superset as a set. More...
 
 FixedSizeSubsetIterator (std::vector< T * > superset, size_t size)
 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 Member Functions

void buildSubsetIndices (std::vector< size_t > &buildVector)
 

Private Attributes

std::vector< T * > supersetVector
 
std::vector< std::vector
< size_t > > 
subsetIndices
 
size_t fixedSize
 
size_t currentPosition
 

Detailed Description

template<class T>
class CluE::FixedSizeSubsetIterator< T >

Iterates over all fixed-size subsets of a given superset.

Generates all fixed-size 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 20 of file fixedsizesubsetiterator.h.

Constructor & Destructor Documentation

template<class T >
CluE::FixedSizeSubsetIterator< T >::FixedSizeSubsetIterator ( std::set< T * >  superset,
size_t  size 
)

Provide the superset as a set.

Exceptions
InvalidArgumentException[0] Value of size is invalid! size.

Definition at line 72 of file fixedsizesubsetiterator.h.

template<class T >
CluE::FixedSizeSubsetIterator< T >::FixedSizeSubsetIterator ( std::vector< T * >  superset,
size_t  size 
)

Provide the superset as a vector.

Exceptions
InvalidArgumentException[0] Value of size is invalid! size.

Definition at line 84 of file fixedsizesubsetiterator.h.

Member Function Documentation

template<class T >
size_t CluE::FixedSizeSubsetIterator< 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 113 of file fixedsizesubsetiterator.h.

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

Generates the next subset.

Exceptions
std::out_of_rangeNo remaining subsets.

Implements CluE::SetIterator< T >.

Definition at line 118 of file fixedsizesubsetiterator.h.

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

Returns if the Graycode sequence is incomplete yet or not.

Implements CluE::SetIterator< T >.

Definition at line 126 of file fixedsizesubsetiterator.h.

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

Returns the current subset as a set.

Implements CluE::SetIterator< T >.

Definition at line 131 of file fixedsizesubsetiterator.h.

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

Returns the current subset as a vector.

Remarks
set() is more efficient.

Implements CluE::SetIterator< T >.

Definition at line 141 of file fixedsizesubsetiterator.h.

template<class T >
void CluE::FixedSizeSubsetIterator< T >::buildSubsetIndices ( std::vector< size_t > &  buildVector)
private

Definition at line 96 of file fixedsizesubsetiterator.h.

Member Data Documentation

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

Definition at line 66 of file fixedsizesubsetiterator.h.

template<class T>
std::vector<std::vector<size_t> > CluE::FixedSizeSubsetIterator< T >::subsetIndices
private

Definition at line 67 of file fixedsizesubsetiterator.h.

template<class T>
size_t CluE::FixedSizeSubsetIterator< T >::fixedSize
private

Definition at line 68 of file fixedsizesubsetiterator.h.

template<class T>
size_t CluE::FixedSizeSubsetIterator< T >::currentPosition
private

Definition at line 69 of file fixedsizesubsetiterator.h.


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