LatBuilder::FigureOfMerit Class Reference

Abstract base class for figures of merit. More...

#include <FigureOfMerit.h>

Inherited by LatBuilder::CoordUniformFigureOfMerit< KERNEL >, and LatBuilder::WeightedFigureOfMerit< PROJDEP, ACC >.

Public Member Functions
virtual	~FigureOfMerit ()
	Destructor.
virtual bool	symmetric () const =0
	Returns true if the value of the figure of merit is invariant under the transormation \(a_j \mapsto n - a_j\) for any \(j=1,\dots,s\), where \(n\) and \(s\) are, respectively, the number of points and the dimension of the lattice and \(a_j\) is the \(j\)-th component of the generating vector \(\boldsymbol a = (a_1, \dots, a_s)\).
virtual const LatticeTester::Weights &	weights () const =0
	Returns the projection-dependent weights \(\gamma_{\mathfrak u}\).
virtual std::string	name () const =0
virtual Real	normType () const =0

Protected Member Functions
virtual std::ostream &	format (std::ostream &os) const =0

Friends
std::ostream &	operator<< (std::ostream &os, const FigureOfMerit &merit)
	Formats merit and outputs it on os.

Detailed Description

Abstract base class for figures of merit.

Member Function Documentation

symmetric()

virtual bool LatBuilder::FigureOfMerit::symmetric ( ) const

pure virtual

Returns true if the value of the figure of merit is invariant under the transormation \(a_j \mapsto n - a_j\) for any \(j=1,\dots,s\), where \(n\) and \(s\) are, respectively, the number of points and the dimension of the lattice and \(a_j\) is the \(j\)-th component of the generating vector \(\boldsymbol a = (a_1, \dots, a_s)\).

Implemented in LatBuilder::CoordUniformFigureOfMerit< KERNEL >, and LatBuilder::WeightedFigureOfMerit< PROJDEP, ACC >.

weights()

virtual const LatticeTester::Weights & LatBuilder::FigureOfMerit::weights ( ) const

pure virtual

Returns the projection-dependent weights \(\gamma_{\mathfrak u}\).

Implemented in LatBuilder::CoordUniformFigureOfMerit< KERNEL >, and LatBuilder::WeightedFigureOfMerit< PROJDEP, ACC >.

---

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

• include/latbuilder/FigureOfMerit.h