LatticeTester::WeightsOrderDependent Class Reference

Defines order-dependent weights. More...

#include <latticetester/WeightsOrderDependent.h>

Inheritance diagram for LatticeTester::WeightsOrderDependent:

Public Member Functions
	WeightsOrderDependent (Weight defaultWeight=0.0)
	Constructs order-dependent weights with default weight.
virtual	~WeightsOrderDependent ()
	Destructor.
virtual Weight	getWeight (const Coordinates &projection) const
	Returns the weight of the projection specified by projection.
virtual Weight	getWeightForOrder (Coordinates::size_type order) const
	Returns the weight associated to the given order.
virtual void	setWeightForOrder (Coordinates::size_type order, Weight weight)
	Sets the weight for the order specified by order.
virtual void	setDefaultWeight (Weight weight)
	Sets the default weight of all orders for which a weight has not been set explicitly set using setWeightForOrder().
virtual Weight	getDefaultWeight () const
virtual uint64_t	getSize () 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 WeightsOrderDependent object by parsing XML data.
Protected Member Functions inherited from LatticeTester::Weights

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

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 order-dependent weights.

The weight of a projection depends only on the order (cardinality) of the projection.

Constructor & Destructor Documentation

WeightsOrderDependent()

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

explicit

Constructs order-dependent weights with default weight.

Parameters

defaultWeight

Default weight.

~WeightsOrderDependent()

virtual LatticeTester::WeightsOrderDependent::~WeightsOrderDependent ( )

inlinevirtual

Destructor.

Member Function Documentation

format()

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

protectedvirtual

Static factory method; create a WeightsOrderDependent 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.

getDefaultWeight()

virtual Weight LatticeTester::WeightsOrderDependent::getDefaultWeight ( ) const

inlinevirtual

getSize()

virtual uint64_t LatticeTester::WeightsOrderDependent::getSize ( ) const

inlinevirtual

getWeight()

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

virtual

Returns the weight of the projection specified by projection.

Implements LatticeTester::Weights.

getWeightForOrder()

virtual Weight LatticeTester::WeightsOrderDependent::getWeightForOrder ( Coordinates::size_type order ) const

inlinevirtual

Returns the weight associated to the given order.

setDefaultWeight()

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

inlinevirtual

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

setWeightForOrder()

void LatticeTester::WeightsOrderDependent::setWeightForOrder ( Coordinates::size_type order, Weight weight )

virtual

Sets the weight for the order specified by order.

Member Data Documentation

m_defaultWeight

Weight LatticeTester::WeightsOrderDependent::m_defaultWeight

protected

m_weights

std::vector<Weight> LatticeTester::WeightsOrderDependent::m_weights

protected

---

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

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