LatticeTester::ProjectionDependentWeights Class Reference

Projection-dependent weights. More...

#include <ProjectionDependentWeights.h>

Inherits LatticeTester::Weights.

Inherited by LatBuilder::Interlaced::IPDWeights< KERNEL >.

Public Member Functions
	ProjectionDependentWeights ()
	Constructs projection-dependent weights.
virtual	~ProjectionDependentWeights ()
	Destructor.
	ProjectionDependentWeights (const ProjectionDependentWeights &)
	Copy constructor.
virtual Weight	getWeight (const Coordinates &projection) const
	Returns the weight of the projection specified by projection.
virtual unsigned int	getSize () const
virtual const WeightsMap &	getWeightsForLargestIndex (Coordinates::value_type largestIndex) const
	Returns a map of weights for all projections whose largest index is largestIndex.
virtual void	setWeight (const Coordinates &projection, Weight weight)
	Static factory method; create a ProjectionDependentWeights object by parsing XML data.
Public Member Functions inherited from LatticeTester::Weights
virtual	~Weights ()
	Destructor.
virtual unsigned int	interlacingFactor () const
	Returns the interlacing factor of the weights.

Protected Types
typedef std::map< Coordinates, Weight >	WeightsMap

Protected Member Functions
virtual void	format (std::ostream &os) const
	Identifies the type of weights, formats them and outputs them on os.

Protected Attributes
std::vector< WeightsMap >	m_weights
	Per-projection weights, regrouped by largest coordinate index.

Static Protected Attributes
static const WeightsMap	m_emptyWeights
	Used only to return an empty map.

Friends
std::istream &	operator>> (std::istream &, ProjectionDependentWeights &)

Related Symbols
(Note that these are not member symbols.)
std::istream &	operator>> (std::istream &is, ProjectionDependentWeights &weights)
	Reads formatted projection-dependent weights into the object weights.
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

Projection-dependent weights.

The weight for a given projection can be set with setWeight().

Internally, the weights are regrouped by largest coordinate index in different std::map objects. This is useful for use with CBC.

Member Function Documentation

format()

virtual void LatticeTester::ProjectionDependentWeights::format ( std::ostream & os ) const

protectedvirtual

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

Remarks

Deriving classes should identify themselves in the output.

Implements LatticeTester::Weights.

Reimplemented in LatBuilder::Interlaced::IPDWeights< KERNEL >.

References ProjectionDependentWeights().

getWeight()

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

virtual

Returns the weight of the projection specified by projection.

Implements LatticeTester::Weights.

References m_weights.

setWeight()

virtual void LatticeTester::ProjectionDependentWeights::setWeight ( const Coordinates & projection, Weight weight )

virtual

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

Sets the weight of the projection specified by projection.

Reimplemented in LatBuilder::Interlaced::IPDWeights< KERNEL >.

Friends And Related Symbol Documentation

operator>>()

std::istream & operator>> ( std::istream & is, ProjectionDependentWeights & weights )

related

Reads formatted projection-dependent weights into the object weights.

The input should be a sequence of projection-to-weight mappings, of the format:

<match1>: <weight1>, <match2>: <weight2>, ...

where <weightn> is the weight (a floating point number) associated to the projection-match <matchn>, and <matchn> is one of:

• a set of coordinates, as specified in operator>>(std::istream&, LatticeTester::Coordinates&) to explicitly set the weight for the projection that correspond to these coordinates;
• the string order m to implicitly set the weights of projections of order m;
• the string default to set the default weight for other projections.

Remarks

Comments can be appended to any line after a # character.

The match-weight pairs can be separated by commas and/or whitespace (including newlines).

The colons (:) can be replaced with => or ->.

See also

operator>>(std::istream&, LatticeTester::Coordinates&)

References ProjectionDependentWeights().

---

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

• latticetester/include/latticetester/ProjectionDependentWeights.h