LatNet Builder Manual  2.0.1-11
Software Package for Constructing Highly Uniform Point Sets
NetBuilder::DigitalNet Class Referenceabstract

Definition of a digital net in base 2. More...

#include <DigitalNet.h>

Inherited by NetBuilder::DigitalNetConstruction< NC >.

Public Member Functions

 DigitalNet (Dimension dimension=0, unsigned int nRows=0, unsigned int nCols=0)
 Default constructor. More...
 
virtual ~DigitalNet ()=default
 Default destructor.
 
unsigned int numColumns () const
 Returns the number of columns of the generating matrices.
 
unsigned int numRows () const
 Returns the number of rows of the generating matrices.
 
uInteger numPoints () const
 Returns the number of points of the net.
 
uInteger size () const
 Returns the number of points of the net.
 
Dimension dimension () const
 Returns the dimension (number of coordinates) of the net.
 
const GeneratingMatrixgeneratingMatrix (Dimension coord) const
 Returns the generating matrix corresponding to coordinate coord. More...
 
virtual std::string format (OutputFormat outputFormat=OutputFormat::HUMAN, unsigned int interlacingFactor=1) const =0
 Formats the net for output. More...
 
virtual bool isSequenceViewable () const =0
 Returns a bool indicating whether the net can be viewed as a digital sequence.
 

Protected Member Functions

 DigitalNet (Dimension dimension, unsigned int nRows, unsigned int nCols, std::vector< std::shared_ptr< GeneratingMatrix >> genMatrices)
 Most general constructor. More...
 

Protected Attributes

Dimension m_dimension
 
unsigned int m_nRows
 
unsigned int m_nCols
 
std::vector< std::shared_ptr< GeneratingMatrix > > m_generatingMatrices
 

Detailed Description

Definition of a digital net in base 2.

A digital net is uniquely defined by its set of generating matrices.

Constructor & Destructor Documentation

◆ DigitalNet() [1/2]

NetBuilder::DigitalNet::DigitalNet ( Dimension  dimension = 0,
unsigned int  nRows = 0,
unsigned int  nCols = 0 
)
inline

Default constructor.

Parameters
dimensionNumber of coordinates in the net.
nRowsNumber of rows of the generating matrices.
nColsNumber of columns of the generating matrices.

◆ DigitalNet() [2/2]

NetBuilder::DigitalNet::DigitalNet ( Dimension  dimension,
unsigned int  nRows,
unsigned int  nCols,
std::vector< std::shared_ptr< GeneratingMatrix >>  genMatrices 
)
inlineprotected

Most general constructor.

Designed to be used by derived classes.

Parameters
dimensionDimension of the net.
nRowsNumber of rows of the generating matrices.
nColsNumber of columns of the generating matrices.
genMatricesVector of shared pointers to the generating matrices.

Member Function Documentation

◆ format()

virtual std::string NetBuilder::DigitalNet::format ( OutputFormat  outputFormat = OutputFormat::HUMAN,
unsigned int  interlacingFactor = 1 
) const
pure virtual

Formats the net for output.

Parameters
outputFormatFormat of output.
interlacingFactorInterlacing factor of the net.

Implemented in NetBuilder::DigitalNetConstruction< NC >.

Referenced by NetBuilder::Task::Eval::outputNet().

◆ generatingMatrix()


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