LatticeTester::WeightsPOD Class Reference

Defines product and order-dependent (POD) weights. More...

#include <latticetester/WeightsPOD.h>

Inheritance diagram for LatticeTester::WeightsPOD:

Public Member Functions
	WeightsPOD ()
	Constructs POD weights with default weight.
virtual	~WeightsPOD ()
	Destructor.
virtual Weight	getWeight (const Coordinates &projection) const
	Returns the weight of the projection specified by projection.
WeightsOrderDependent &	getOrderDependentWeights ()
	Returns the order-dependent part of the weights.
const WeightsOrderDependent &	getOrderDependentWeights () const
WeightsProduct &	getProductWeights ()
	Returns the product part of the weights.
const WeightsProduct &	getProductWeights () const
double	getWeightForOrder (Coordinates::size_type order) const
double	getWeightForCoordinate (Coordinates::size_type coordinate) const
Public Member Functions inherited from LatticeTester::Weights
virtual	~Weights ()
	Destructor.
virtual uint64_t	interlacingFactor () const
	Returns the interlacing factor of the weights.

Protected Member Functions
virtual void	format (std::ostream &os) const
	Static factory method; create a WeightsPOD object by parsing XML data.
Protected Member Functions inherited from LatticeTester::Weights

Protected Attributes
WeightsOrderDependent	m_orderDependentWeights
WeightsProduct	m_productWeights

Additional Inherited Members
Related Symbols inherited from LatticeTester::Weights
std::ostream &	operator<< (std::ostream &os, const Weights &o)
	Identifies the type of weights, formats them and outputs them on os.

Detailed Description

Defines product and order-dependent (POD) weights.

The weight of a projection is the sum of a product weight and an order-dependent weight.

Constructor & Destructor Documentation

WeightsPOD()

LatticeTester::WeightsPOD::WeightsPOD

(

)

Constructs POD weights with default weight.

~WeightsPOD()

virtual LatticeTester::WeightsPOD::~WeightsPOD ( )

inlinevirtual

Destructor.

Member Function Documentation

format()

void LatticeTester::WeightsPOD::format ( std::ostream & os ) const

protectedvirtual

Static factory method; create a WeightsPOD object by parsing XML data.

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

Subclasses that implement Weights should identify themselves in the output.

Implements LatticeTester::Weights.

getOrderDependentWeights() [1/2]

WeightsOrderDependent & LatticeTester::WeightsPOD::getOrderDependentWeights ( )

inline

Returns the order-dependent part of the weights.

getOrderDependentWeights() [2/2]

const WeightsOrderDependent & LatticeTester::WeightsPOD::getOrderDependentWeights ( ) const

inline

getProductWeights() [1/2]

WeightsProduct & LatticeTester::WeightsPOD::getProductWeights ( )

inline

Returns the product part of the weights.

getProductWeights() [2/2]

const WeightsProduct & LatticeTester::WeightsPOD::getProductWeights ( ) const

inline

getWeight()

Weight LatticeTester::WeightsPOD::getWeight ( const Coordinates & projection ) const

virtual

Returns the weight of the projection specified by projection.

Implements LatticeTester::Weights.

getWeightForCoordinate()

double LatticeTester::WeightsPOD::getWeightForCoordinate ( Coordinates::size_type coordinate ) const

inline

getWeightForOrder()

double LatticeTester::WeightsPOD::getWeightForOrder ( Coordinates::size_type order ) const

inline

Member Data Documentation

m_orderDependentWeights

WeightsOrderDependent LatticeTester::WeightsPOD::m_orderDependentWeights

protected

m_productWeights

WeightsProduct LatticeTester::WeightsPOD::m_productWeights

protected

---

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

• include/latticetester/WeightsPOD.h
• src/WeightsPOD.cc