LatticeTester::OrderDependentWeights Class Reference

Order-dependent weights. More...

#include <latticetester/OrderDependentWeights.h>

Inherits LatticeTester::Weights.

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

Order-dependent weights.

This class implements order dependent weights. The weight of a projection depends only on the order of the projection, i.e. the dimension of the projection.

Constructor & Destructor Documentation

OrderDependentWeights()

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

explicit

Constructs order-dependent weights with default weight.

Parameters

defaultWeight

Default weight.

~OrderDependentWeights()

virtual LatticeTester::OrderDependentWeights::~OrderDependentWeights ( )

inlinevirtual

Destructor.

Member Function Documentation

format()

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

protectedvirtual

Static factory method; create a OrderDependentWeights 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::OrderDependentWeights::getWeight ( const Coordinates &  projection ) const

virtual

Returns the weight of the projection specified by projection.

Implements LatticeTester::Weights.

getWeightForOrder()

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

inlinevirtual

Returns the weight associated to the given order.

setDefaultWeight()

virtual void LatticeTester::OrderDependentWeights::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::OrderDependentWeights::setWeightForOrder ( Coordinates::size_type  order, Weight  weight  )

virtual

Sets the weight for the order specified by order.

---

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

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