AffineSpaceIterator< T > Class Template Reference

#include <Keccak-fAffineBases.h>

List of all members.

Public Member Functions

 AffineSpaceIterator ()
 AffineSpaceIterator (const vector< vector< T > > &aBase, const vector< T > &aOffset)
 ~AffineSpaceIterator ()
bool isEnd () const
void operator++ ()
const vector< T > & operator* () const
void display (ostream &fout) const
UINT64 getCount () const


Detailed Description

template<class T>
class AffineSpaceIterator< T >

This class implements an iterator over the affine space generated by the given base and offset.

Constructor & Destructor Documentation

template<class T>
AffineSpaceIterator< T >::AffineSpaceIterator (  )  [inline]

This constructor creates an empty iterator.

template<class T>
AffineSpaceIterator< T >::AffineSpaceIterator ( const vector< vector< T > > &  aBase,
const vector< T > &  aOffset 
) [inline]

This constructor initializes the affine space iterator with a given generator base and a given offset.

Parameters:
aBase The generator base, as a reference to the set (vector) of generators. Each generator is a vector of elements of template type T.
aOffset The offset, as a reference to a vector of elements of template type T.

template<class T>
AffineSpaceIterator< T >::~AffineSpaceIterator (  )  [inline]

The destructor.


Member Function Documentation

template<class T>
bool AffineSpaceIterator< T >::isEnd (  )  const [inline]

This method tells whether the last element of the affine space has been reached.

Returns:
True iff the last element of the affine space has been reached.

template<class T>
void AffineSpaceIterator< T >::operator++ (  )  [inline]

This method moves the iterator to the next element in the affine space.

template<class T>
const vector< T > & AffineSpaceIterator< T >::operator* (  )  const [inline]

This method returns a constant reference to the current element in the affine space.

Returns:
The current element in the affine space.

template<class T>
void AffineSpaceIterator< T >::display ( ostream &  fout  )  const [inline]

This method displays the offset and generators.

Parameters:
fout The stream to display to.

template<class T>
UINT64 AffineSpaceIterator< T >::getCount (  )  const [inline]

This method returns the number of elements in the affine space.

Returns:
The number of elements in the affine space.


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

Generated on Thu Jun 17 18:20:42 2010 for KeccakTools by  doxygen 1.5.6