LatBuilder::LatDef< LR, ET > Class Template Reference

Definition of a rank-1 lattice. More...

#include <LatDef.h>

Public Types
typedef LatticeTraits< LR >::GeneratingVector	GeneratingVector

Public Member Functions
	LatDef (SizeParam< LR, ET > sizeParam=SizeParam< LR, ET >(), GeneratingVector gen=GeneratingVector())
	Constructor.
template<EmbeddingType L>
	LatDef (const LatDef< LR, L > &other)
SizeParam< LR, ET > &	sizeParam ()
	Returns the size parameter of the lattice.
const SizeParam< LR, ET > &	sizeParam () const
	Returns the size parameter of the lattice.
GeneratingVector &	gen ()
	Returns the generating vector of the lattice.
const GeneratingVector &	gen () const
	Returns the generating vector of the lattice.
Dimension	dimension () const
	Returns the dimension of the lattice.
bool	operator== (const LatDef &other) const
	Returns true this instance is equal to other.
bool	operator!= (const LatDef &other) const
	Returns true this instance is not equal to other.
bool	operator< (const LatDef &other) const
	Returns true this instance has a smaller size than other, or if it has the same size and a smaller lexicographic rank for its generating vector than other.

Detailed Description

template<LatticeType LR, EmbeddingType ET>
class LatBuilder::LatDef< LR, ET >

Definition of a rank-1 lattice.

Defining parameters:

• lattice size parameter;
• generating vector.

Template Parameters

ET	Type of lattice.

Examples

tutorial/FilteredRCBC.cc, tutorial/LatDef.cc, tutorial/MeritSeqCBCSignals.cc, tutorial/WeightedFigureOfMerit.cc, tutorial/WeightedFigureOfMeritCBC.cc, and tutorial/WeightedFigureOfMeritSignals.cc.

Constructor & Destructor Documentation

LatDef()

template<LatticeType LR, EmbeddingType ET>

LatBuilder::LatDef< LR, ET >::LatDef ( SizeParam< LR, ET > sizeParam = SizeParam<LR, ET>(), GeneratingVector gen = GeneratingVector() )

inline

Constructor.

Parameters

sizeParam	Size parameter of the lattice.
gen	Generating vector.

Member Function Documentation

gen()

template<LatticeType LR, EmbeddingType ET>

const GeneratingVector & LatBuilder::LatDef< LR, ET >::gen ( ) const

inline

Returns the generating vector of the lattice.

sizeParam()

template<LatticeType LR, EmbeddingType ET>

const SizeParam< LR, ET > & LatBuilder::LatDef< LR, ET >::sizeParam ( ) const

inline

Returns the size parameter of the lattice.

---

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

• include/latbuilder/LatDef.h