Lattice Builder
Software Package for Constructing Rank-1 Lattices
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Friends Groups Pages
LatBuilder::CoordSymFigureOfMerit< KERNEL > Class Template Reference

Base base class for coordinate-symmetric figures of merit. More...

#include <CoordSymFigureOfMerit.h>

+ Inheritance diagram for LatBuilder::CoordSymFigureOfMerit< KERNEL >:
+ Collaboration diagram for LatBuilder::CoordSymFigureOfMerit< KERNEL >:

Public Member Functions

 CoordSymFigureOfMerit (std::unique_ptr< LatCommon::Weights > weights, KERNEL kernel=KERNEL())
 
const LatCommon::Weights & weights () const
 Returns the projection-dependent weights \(\gamma_{\mathfrak u}\). More...
 
const KERNEL & kernel () const
 Returns the coordinate-symmetric kernel.
 
bool symmetric () const
 Returns true if the value of the figure of merit is invariant under the transormation \(a_j \mapsto n - a_j\) for any \(j=1,\dots,s\), where \(n\) and \(s\) are, respectively, the number of points and the dimension of the lattice and \(a_j\) is the \(j\)-th component of the generating vector \(\boldsymbol a = (a_1, \dots, a_s)\). More...
 
std::string name () const
 
Real normType () const
 

Static Public Member Functions

static constexpr Compress suggestedCompression ()
 

Protected Member Functions

std::ostream & format (std::ostream &os) const
 

Detailed Description

template<class KERNEL>
class LatBuilder::CoordSymFigureOfMerit< KERNEL >

Base base class for coordinate-symmetric figures of merit.

Examples:
tutorial/FilteredCBC.cc, tutorial/FilteredRCBC.cc, tutorial/MeritSeqCoordSym.cc, tutorial/MeritSeqFastCBC.cc, and tutorial/MeritSeqNonCBC.cc.

Member Function Documentation

template<class KERNEL>
bool LatBuilder::CoordSymFigureOfMerit< KERNEL >::symmetric ( ) const
inlinevirtual

Returns true if the value of the figure of merit is invariant under the transormation \(a_j \mapsto n - a_j\) for any \(j=1,\dots,s\), where \(n\) and \(s\) are, respectively, the number of points and the dimension of the lattice and \(a_j\) is the \(j\)-th component of the generating vector \(\boldsymbol a = (a_1, \dots, a_s)\).

Returns true if the kernel is symmetric.

Implements LatBuilder::FigureOfMerit.

References LatBuilder::CoordSymFigureOfMerit< KERNEL >::kernel().

template<class KERNEL>
const LatCommon::Weights& LatBuilder::CoordSymFigureOfMerit< KERNEL >::weights ( ) const
inlinevirtual

Returns the projection-dependent weights \(\gamma_{\mathfrak u}\).

Implements LatBuilder::FigureOfMerit.


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