Abstract class that defines an interface to specify Weights given to projections in figures of merit. More...

#include <latticetester/Weights.h>

Inheritance diagram for LatticeTester::Weights:

Public Member Functions
virtual	~Weights ()
	Destructor.

virtual Weight	getWeight (const Coordinates &projection) const =0
	Returns the weight of the projection (subset of coordinates) specified by `projection`.

virtual uint64_t	interlacingFactor () const
	Returns the interlacing factor of the weights.

Protected Member Functions
virtual void	format (std::ostream &os) const =0
	Identifies the type of weights, formats them and outputs them on `os`.

Friends
std::ostream &	operator<< (std::ostream &out, const Weights &o)

Related Symbols
(Note that these are not member symbols.)
std::ostream &	operator<< (std::ostream &os, const Weights &o)
	Identifies the type of weights, formats them and outputs them on `os`.

Detailed Description

Abstract class that defines an interface to specify Weights given to projections in figures of merit.

This class and its subclasses are not used directly by LatticeTester since LatticeTester does not implement figures of merit. For examples of usages, one may look at LatNetBuilder and LatMRG.

Constructor & Destructor Documentation

◆ ~Weights()

virtual LatticeTester::Weights::~Weights ( )

inlinevirtual

Destructor.

Member Function Documentation

◆ format()

virtual void LatticeTester::Weights::format ( std::ostream & os ) const

protectedpure virtual

Identifies the type of weights, formats them and outputs them on os.

Subclasses that implement Weights should identify themselves in the output.

Implemented in LatticeTester::WeightsOrderDependent, LatticeTester::WeightsPOD, LatticeTester::WeightsProduct, LatticeTester::WeightsProjectionDependent, and LatticeTester::WeightsUniform.

◆ getWeight()

virtual Weight LatticeTester::Weights::getWeight ( const Coordinates & projection ) const

pure virtual

Returns the weight of the projection (subset of coordinates) specified by projection.

Implemented in LatticeTester::WeightsOrderDependent, LatticeTester::WeightsPOD, LatticeTester::WeightsProduct, LatticeTester::WeightsProjectionDependent, and LatticeTester::WeightsUniform.

◆ interlacingFactor()

virtual uint64_t LatticeTester::Weights::interlacingFactor ( ) const

inlinevirtual

Returns the interlacing factor of the weights.

This is used in LatNet Builder to parameterize the figures of merit for interlaced digital nets.

Friends And Related Symbol Documentation

◆ operator<<() [1/2]

std::ostream & operator<<	(	std::ostream &	os,
		const Weights &	o )

◆ operator<< [2/2]

std::ostream & operator<<	(	std::ostream &	out,
		const Weights &	o )

friend

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

include/latticetester/Weights.h

Public Member Functions

Protected Member Functions

Friends

Related Symbols