LatticeTester::ProductWeights Class Reference

Product weights. More...

#include <ProductWeights.h>

Inherits LatticeTester::Weights.

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

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

Protected Attributes
Weight	m_defaultWeight
std::vector< Weight >	m_weights

Additional Inherited Members
Related Symbols inherited from LatticeTester::Weights
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

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.

Member Function Documentation

format()

virtual 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()

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

virtual

Returns the weight of the projection specified by projection.

Implements LatticeTester::Weights.

---

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

• latticetester/include/latticetester/ProductWeights.h