Lattice Tester Online Documentation unknown
Software Package For Testing The Uniformity Of Integral Lattices In The Real Space
Loading...
Searching...
No Matches
LatticeTester::WeightsProduct Class Reference

Defines product weights, for which the weight of a projection is equal to the product of the weights of the individual coordinates. More...

+ Inheritance diagram for LatticeTester::WeightsProduct:

Public Member Functions

 WeightsProduct (Weight defaultWeight=0.0)
 Constructs product weights with a default weight.
 
virtual ~WeightsProduct ()
 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 uint64_t interlacingFactor () const
 Returns the interlacing factor of the weights.
 

Protected Member Functions

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

Protected Attributes

Weight m_defaultWeight
 
std::vector< Weightm_weights
 

Additional Inherited Members

Detailed Description

Defines product weights, for which the weight of a projection is equal to the product of the weights of the individual coordinates.

Constructor & Destructor Documentation

◆ WeightsProduct()

LatticeTester::WeightsProduct::WeightsProduct ( Weight defaultWeight = 0.0)
explicit

Constructs product weights with a default weight.

◆ ~WeightsProduct()

virtual LatticeTester::WeightsProduct::~WeightsProduct ( )
inlinevirtual

Destructor.

Member Function Documentation

◆ getWeight()

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

Returns the weight of the projection specified by projection.

Implements LatticeTester::Weights.

◆ getWeightForCoordinate()

virtual Weight LatticeTester::WeightsProduct::getWeightForCoordinate ( Coordinates::size_type coordinate) const
inlinevirtual

Returns the weight associated to the given coordinate.

◆ setWeightForCoordinate()

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

Sets the weight for the coordinate specified by coordinate.

◆ setDefaultWeight()

virtual void LatticeTester::WeightsProduct::setDefaultWeight ( Weight weight)
inlinevirtual

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

◆ getWeights()

virtual const std::vector< Weight > & LatticeTester::WeightsProduct::getWeights ( ) const
inlinevirtual

◆ getDefaultWeight()

virtual Weight LatticeTester::WeightsProduct::getDefaultWeight ( ) const
inlinevirtual

◆ multiplyWeights()

void LatticeTester::WeightsProduct::multiplyWeights ( Weight c)
inline

Multiply each weight by a constant.

◆ format()

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

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.

Member Data Documentation

◆ m_defaultWeight

Weight LatticeTester::WeightsProduct::m_defaultWeight
protected

◆ m_weights

std::vector<Weight> LatticeTester::WeightsProduct::m_weights
protected

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