LatNet Builder Manual 2.1.3-6
Software Package for Constructing Highly Uniform Point Sets
Loading...
Searching...
No Matches
LatBuilder::ProjDepMerit::Spectral< NORM > Class Template Reference

Figure of merit based on the spectral test. More...

#include <Spectral.h>

Inherits LatBuilder::ProjDepMerit::Base< Spectral< NORM > >.

Public Types

typedef NORM Normalizer

Public Member Functions

 Spectral (Real power=1.0)
 Constructor.
bool symmetric () const
Real power () const
 Returns the power parameter.
std::string name () const
template<EmbeddingType ET, Compress COMPRESS, PerLevelOrder PLO = defaultPerLevelOrder<LatticeType::ORDINARY, ET>::Order>
Evaluator< Spectral, LatticeType::ORDINARY, ET, COMPRESS, PLO > evaluator (Storage< LatticeType::ORDINARY, ET, COMPRESS, PLO > storage) const
 Creates an evaluator for the projection-dependent figure of merit.
Public Member Functions inherited from LatBuilder::ProjDepMerit::Base< Spectral< NORM > >
Storage< LR, ET, COMPRESS, PLO >::MeritValue operator() (const Storage< LR, ET, COMPRESS, PLO > &storage, const LatDef< LR, ET > &lat, const LatticeTester::Coordinates &projection) const
 Computes the value of the figure of merit of lattice lat for projection projection.
std::string name () const
 Returns the name of the figure of merit.
bool symmetric () const
 Returns true if the value of the figure of merit is invariant under a reflection of the generating vector \(\boldsymbol a=(a_1, \dots, a_s)\) along any axis such that \(a_j \mapsto n - a_j\), where \(n\) is the number of points in the lattice point set.
Evaluator< Spectral< NORM >, LR, ET, COMPRESS, PLO > evaluator (const Storage< LR, ET, COMPRESS, PLO > &storage) const
 Creates an evaluator for the projection-dependent figure of merit.
Spectral< NORM > & derived ()
Real power () const

Static Public Member Functions

static constexpr Compress suggestedCompression ()
template<EmbeddingType ET, Compress COMPRESS, PerLevelOrder PLO>
static Storage< LatticeType::ORDINARY, ET, COMPRESS > asAcceptableStorage (Storage< LatticeType::ORDINARY, ET, COMPRESS, PLO > storage)

Detailed Description

template<class NORM>
class LatBuilder::ProjDepMerit::Spectral< NORM >

Figure of merit based on the spectral test.

Implements the computation of the inverse length of the shortest dual vector in a lattice.

The value of the figure of merit is the normalized inverse length of the shortest dual vector, raised to a user-specified power.

Template Parameters
NORMNormalizer type.
Examples
tutorial/MeritSeqCBC.cc, tutorial/MeritSeqCBCSignals.cc, tutorial/WeightedFigureOfMerit.cc, tutorial/WeightedFigureOfMeritCBC.cc, and tutorial/WeightedFigureOfMeritSignals.cc.

Constructor & Destructor Documentation

◆ Spectral()

template<class NORM>
LatBuilder::ProjDepMerit::Spectral< NORM >::Spectral ( Real power = 1.0)
inline

Constructor.

Parameters
powerExponent to which the contribution for each contribution is raised.

References power(), and Spectral().

Referenced by Spectral().


The documentation for this class was generated from the following file:
  • include/latbuilder/ProjDepMerit/Spectral.h