LatMRG::MeritList< Lat > Class Template Reference

This class stores a certain number of FigureOfMerit objects. More...

#include <latmrg/FigureOfMerit.h>

Public Member Functions
	MeritList (unsigned long maxLength, bool best)
	Creates a MeritList that will hold at most maxLength FigureOfMerit. More...
void	add (FigureOfMerit< Lat > test)
	Adds test in m_tests if there is space left or if test as a higher (lower) merit. More...
std::list< FigureOfMerit< Lat > > &	getList ()
Dbl	getMerit ()
unsigned long	getSize ()

Private Types
typedef Lat::Float	Dbl

Private Member Functions
void	posInsert (FigureOfMerit< Lat > &test)
	Finds the right position in the vector and inserts the new test. More...

Private Attributes
bool	m_best
	Indicates wether or not this object keeps best or worst lattices. More...
unsigned long	m_max
	The maximal number of tests this object will store. More...
Dbl	m_merit
	The minimum merit stored in this object. More...
std::list< FigureOfMerit< Lat > >	m_tests
	The tests stored in this object. More...

Detailed Description

template<typename Lat>
class LatMRG::MeritList< Lat >

This class stores a certain number of FigureOfMerit objects.

New elements are only added if the list is not full or if they have a better merit than what is on the list.

Member Typedef Documentation

Dbl

template<typename Lat >

typedef Lat::Float LatMRG::MeritList< Lat >::Dbl

private

Constructor & Destructor Documentation

MeritList()

template<typename Lat >

LatMRG::MeritList< Lat >::MeritList ( unsigned long  maxLength, bool  best  )

inline

Creates a MeritList that will hold at most maxLength FigureOfMerit.

Member Function Documentation

add()

template<typename Lat >

void LatMRG::MeritList< Lat >::add ( FigureOfMerit< Lat >  test )

inline

Adds test in m_tests if there is space left or if test as a higher (lower) merit.

getList()

template<typename Lat >

std::list<FigureOfMerit<Lat> >& LatMRG::MeritList< Lat >::getList ( )

inline

getMerit()

template<typename Lat >

Dbl LatMRG::MeritList< Lat >::getMerit ( )

inline

getSize()

template<typename Lat >

unsigned long LatMRG::MeritList< Lat >::getSize ( )

inline

posInsert()

template<typename Lat >

void LatMRG::MeritList< Lat >::posInsert ( FigureOfMerit< Lat > &  test )

inlineprivate

Finds the right position in the vector and inserts the new test.

Member Data Documentation

m_best

template<typename Lat >

bool LatMRG::MeritList< Lat >::m_best

private

Indicates wether or not this object keeps best or worst lattices.

m_max

template<typename Lat >

unsigned long LatMRG::MeritList< Lat >::m_max

private

The maximal number of tests this object will store.

m_merit

template<typename Lat >

Dbl LatMRG::MeritList< Lat >::m_merit

private

The minimum merit stored in this object.

m_tests

template<typename Lat >

std::list<FigureOfMerit<Lat> > LatMRG::MeritList< Lat >::m_tests

private

The tests stored in this object.

---

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

• include/latmrg/FigureOfMerit.h