Abstract class representing Weights for figures of merit. More...

#include <Weights.h>

Inherited by LatBuilder::Interlaced::IPODWeights< LatBuilder::Kernel::IAAlpha >, LatBuilder::Interlaced::IPODWeights< LatBuilder::Kernel::IB >, LatBuilder::Interlaced::IPODWeights< LatBuilder::Kernel::ICAlpha >, LatBuilder::CombinedWeights, LatBuilder::Interlaced::IPODWeights< KERNEL >, LatticeTester::OrderDependentWeights, LatticeTester::PODWeights, LatticeTester::ProductWeights, LatticeTester::ProjectionDependentWeights, LatticeTester::UniformWeights, and NetBuilder::JoeKuo::Weights.

Public Member Functions
virtual	~Weights ()
	Destructor.
virtual Weight	getWeight (const Coordinates &projection) const =0
	Returns the weight of the projection specified by projection.
virtual unsigned int	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.)
typedef double	Weight
	Scalar weight type.
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 representing Weights for figures of merit.

Typically, if one wants to analyze a lattice, there are multiple figures of merit available. This class presents an interface to give weights to all those figures of merit so that a global figure of merit can be calculated as a weighted mean of many figures of merit.

This abstract class is the basis for different kinds of weights used to accentuate the importance of some projections when computing figures of merit for lattices or point sets. For more insight on what can be done with weights, look what the subclasses implement. These classes are not used directly by LatticeTester since LatticeTester does not implement calculations of figure of merit for different projections of a point set. For example usages, one should look at the LatNetBuilder and the LatMRG software.

Constructor & Destructor Documentation

◆ ~Weights()

virtual LatticeTester::Weights::~Weights ( )

inlinevirtual

Destructor.

Reimplemented in NetBuilder::JoeKuo::Weights.

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.

Remarks: Deriving classes should identify themselves in the output.

Implemented in LatBuilder::CombinedWeights, LatBuilder::Interlaced::IPDWeights< KERNEL >, LatBuilder::Interlaced::IPODWeights< KERNEL >, LatBuilder::Interlaced::IPODWeights< LatBuilder::Kernel::IAAlpha >, LatBuilder::Interlaced::IPODWeights< LatBuilder::Kernel::IB >, LatBuilder::Interlaced::IPODWeights< LatBuilder::Kernel::ICAlpha >, LatticeTester::OrderDependentWeights, LatticeTester::PODWeights, LatticeTester::ProductWeights, LatticeTester::ProjectionDependentWeights, LatticeTester::UniformWeights, and NetBuilder::JoeKuo::Weights.

Referenced by NetBuilder::FigureOfMerit::CoordUniformFigureOfMerit< KERNEL, ET >::format(), and operator<<().

◆ getWeight()

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

pure virtual

Returns the weight of the projection specified by projection.

Implemented in LatBuilder::CombinedWeights, LatBuilder::Interlaced::IPODWeights< KERNEL >, LatBuilder::Interlaced::IPODWeights< LatBuilder::Kernel::IAAlpha >, LatBuilder::Interlaced::IPODWeights< LatBuilder::Kernel::IB >, LatBuilder::Interlaced::IPODWeights< LatBuilder::Kernel::ICAlpha >, LatticeTester::OrderDependentWeights, LatticeTester::PODWeights, LatticeTester::ProductWeights, LatticeTester::ProjectionDependentWeights, LatticeTester::UniformWeights, and NetBuilder::JoeKuo::Weights.

◆ interlacingFactor()

virtual unsigned int LatticeTester::Weights::interlacingFactor ( ) const

inlinevirtual

Returns the interlacing factor of the weights.

This is used to parametrize figures of merit for interlaced digital nets.

Reimplemented in LatBuilder::CombinedWeights, LatBuilder::Interlaced::IPDWeights< KERNEL >, LatBuilder::Interlaced::IPODWeights< KERNEL >, LatBuilder::Interlaced::IPODWeights< LatBuilder::Kernel::IAAlpha >, LatBuilder::Interlaced::IPODWeights< LatBuilder::Kernel::IB >, and LatBuilder::Interlaced::IPODWeights< LatBuilder::Kernel::ICAlpha >.

◆ Weight

typedef double Weight

Scalar weight type.

Note: We could have used Weight, but it might be wise to leave this typedef in case we decide to use std::int64_t Weight at some point.

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

latticetester/include/latticetester/Weights.h

Public Member Functions

Protected Member Functions

Friends

Related Symbols