LatticeTester::CoordinateSets::AddCoordinate< BASE > Class Template Reference

This template class wraps any implementation of a CoordinateSets and adds a specific coordinate to each coordinate sets. More...

#include <latticetester/CoordinateSets.h>

Classes
class	const_iterator
	An iterator class used internally by the AddCoordinate class. More...

Public Member Functions
	AddCoordinate (const BASE &base, Coordinates::value_type coord)
	Constructs a sequence of coordinate sets by adding the coordinate coord to each element in the base sequence base.
const BASE &	base () const
	Returns the base object used to produce the subsets.
const Coordinates::value_type &	coord () const
	Returns the coordinate this object adds.
const_iterator	begin () const
	Returns an iterator pointing to the first element in the seq.
const_iterator	end () const
	Returns an iterator pointing past the last element in the seq.

Detailed Description

template<typename BASE>
class LatticeTester::CoordinateSets::AddCoordinate< BASE >

This template class wraps any implementation of a CoordinateSets and adds a specific coordinate to each coordinate sets.

When iterating through the subsets of this class, they will not be ordered by cardinality because the sets are generated on the fly and the coordinate is added if it is not already contained.

BASE is a type of coordinate sets that serves as a base. This should be one of the classes defined in the CoordinateSets namespace.

Todo

This class needs to be benchmarked to see how much slower it is (because it will be).

Constructor & Destructor Documentation

AddCoordinate()

template<typename BASE >

LatticeTester::CoordinateSets::AddCoordinate< BASE >::AddCoordinate ( const BASE & base, Coordinates::value_type coord )

inline

Constructs a sequence of coordinate sets by adding the coordinate coord to each element in the base sequence base.

Member Function Documentation

base()

template<typename BASE >

const BASE & LatticeTester::CoordinateSets::AddCoordinate< BASE >::base ( ) const

inline

Returns the base object used to produce the subsets.

begin()

template<typename BASE >

const_iterator LatticeTester::CoordinateSets::AddCoordinate< BASE >::begin ( ) const

inline

Returns an iterator pointing to the first element in the seq.

coord()

template<typename BASE >

const Coordinates::value_type & LatticeTester::CoordinateSets::AddCoordinate< BASE >::coord ( ) const

inline

Returns the coordinate this object adds.

end()

template<typename BASE >

const_iterator LatticeTester::CoordinateSets::AddCoordinate< BASE >::end ( ) const

inline

Returns an iterator pointing past the last element in the seq.

---

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

• include/latticetester/CoordinateSets.h