LatticeTester::CoordinateSets::Subsets Class Reference

This class implements a CoordinateSets object that will build all the subsets of a Coordinates object that are of a cardinality in a certain range. More...

#include <latticetester/CoordinateSets.h>

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

Public Member Functions
	Subsets (const Coordinates &coords, Coordinates::size_type minOrder, Coordinates::size_type maxOrder)
	Constructs a set of all subsets of coords with minimum and maximum cardinality specified by minOrder and maxOrder.
const Coordinates &	coords () const
	Returns the coordinates, as passed to the constructor.
Coordinates::size_type	minOrder () const
	Returns minOrder, as passed to the constructor.
Coordinates::size_type	maxOrder () const
	Returns maxOrder, as passed to the constructor.
const_iterator	begin () const
	Returns an iterator pointing to the first element of *this.
const_iterator	end () const
	Returns an iterator pointing past the last element of *this.

Detailed Description

This class implements a CoordinateSets object that will build all the subsets of a Coordinates object that are of a cardinality in a certain range.

This is a less flexible class than FromRanges but, in the example Subsets.cc it has been slightly faster in our tests.

Remarks

it is somewhat hard to build an object of this class, maybe this could be done in a better way.

Constructor & Destructor Documentation

Subsets()

LatticeTester::CoordinateSets::Subsets::Subsets	(	const Coordinates &	coords,
		Coordinates::size_type	minOrder,
		Coordinates::size_type	maxOrder )

Constructs a set of all subsets of coords with minimum and maximum cardinality specified by minOrder and maxOrder.

For example, to select all 1, 2, and 3-tuples over coordinates 2, 4, 6, one may use the declaration Subsets tousens(ens, 1, 3), where set ens is {2,4,6}; this gives the sets tousens = {{2}, {4}, {6}, {2, 4}, {2, 6}, {4, 6}, {2, 4, 6}}.

Member Function Documentation

begin()

const_iterator LatticeTester::CoordinateSets::Subsets::begin ( ) const

inline

Returns an iterator pointing to the first element of *this.

coords()

const Coordinates & LatticeTester::CoordinateSets::Subsets::coords ( ) const

inline

Returns the coordinates, as passed to the constructor.

end()

const_iterator LatticeTester::CoordinateSets::Subsets::end ( ) const

inline

Returns an iterator pointing past the last element of *this.

maxOrder()

Coordinates::size_type LatticeTester::CoordinateSets::Subsets::maxOrder ( ) const

inline

Returns maxOrder, as passed to the constructor.

minOrder()

Coordinates::size_type LatticeTester::CoordinateSets::Subsets::minOrder ( ) const

inline

Returns minOrder, as passed to the constructor.

---

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

• include/latticetester/CoordinateSets.h
• src/CoordinateSets.cc