LatticeTester::ProductWeights Class Reference

Product weights. More...

#include <latticetester/ProductWeights.h>

Inherits LatticeTester::Weights.

Public Member Functions
	ProductWeights (Weight defaultWeight=0.0)
	Constructs projection-dependent weights with a default weight. More...
virtual	~ProductWeights ()
	Destructor. More...
virtual Weight	getWeight (const Coordinates &projection) const
	Returns the weight of the projection specified by projection. More...
virtual Weight	getWeightForCoordinate (Coordinates::size_type coordinate) const
	Returns the weight associated to the given coordinate. More...
virtual void	setWeightForCoordinate (Coordinates::size_type coordinate, Weight weight)
	Sets the weight for the coordinate specified by coordinate. More...
virtual void	setDefaultWeight (Weight weight)
	Sets the default weight of all coordinates for which a weight has not been set explicitly set using setWeightForCoordinate(). More...
void	multiplyWeights (Weight c)
	Multiply each weight by a constant. More...
Public Member Functions inherited from LatticeTester::Weights
virtual	~Weights ()
	Destructor. More...
virtual unsigned int	interlacingFactor () const
	Returns the interlacing factor of the weights. More...

Protected Member Functions
virtual void	format (std::ostream &os) const
	Static factory method; create a ProductWeights object by parsing XML data. More...

Additional Inherited Members
Related Functions inherited from LatticeTester::Weights
typedef double	Weight
std::ostream &	operator<< (std::ostream &os, const Weights &o)

Detailed Description

Product weights.

The weight of a projection is equal to the product of the individual weights of each coordinate involved.

Constructor & Destructor Documentation

ProductWeights()

LatticeTester::ProductWeights::ProductWeights ( Weight  defaultWeight = 0.0 )

explicit

Constructs projection-dependent weights with a default weight.

Parameters

defaultWeight

Default weight.

~ProductWeights()

virtual LatticeTester::ProductWeights::~ProductWeights ( )

inlinevirtual

Destructor.

Member Function Documentation

format()

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

protectedvirtual

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

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

Remarks

Deriving classes should identify themselves in the output.

Implements LatticeTester::Weights.

getWeight()

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

virtual

Returns the weight of the projection specified by projection.

Implements LatticeTester::Weights.

getWeightForCoordinate()

virtual Weight LatticeTester::ProductWeights::getWeightForCoordinate ( Coordinates::size_type  coordinate ) const

inlinevirtual

Returns the weight associated to the given coordinate.

multiplyWeights()

void LatticeTester::ProductWeights::multiplyWeights ( Weight  c )

inline

Multiply each weight by a constant.

setDefaultWeight()

virtual void LatticeTester::ProductWeights::setDefaultWeight ( Weight  weight )

inlinevirtual

Sets the default weight of all coordinates for which a weight has not been set explicitly set using setWeightForCoordinate().

setWeightForCoordinate()

void LatticeTester::ProductWeights::setWeightForCoordinate ( Coordinates::size_type  coordinate, Weight  weight  )

virtual

Sets the weight for the coordinate specified by coordinate.

---

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

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