NetBuilder::DigitalNetConstruction< NC > Class Template Reference

Derived class of DigitalNet designed to implement specific construction methods. More...

#include <DigitalNet.h>

Inherits NetBuilder::DigitalNet.

Public Types
typedef NetConstructionTraits< NC >	ConstructionMethod
typedef ConstructionMethod::GenValue	GenValue
	Type of the generating values of the method.
typedef ConstructionMethod::SizeParameter	SizeParameter
	Type of the size parameter of the method.

Public Member Functions
	DigitalNetConstruction (Dimension dimension, SizeParameter sizeParameter, std::vector< GenValue > genValues)
	Constructor. More...
	DigitalNetConstruction (Dimension dimension=0, SizeParameter sizeParameter=SizeParameter())
	Constructor for placeholder nets. More...
	~DigitalNetConstruction ()=default
	Default destructor.
std::unique_ptr< DigitalNetConstruction< NC > >	extendDimension (const GenValue &newGenValue) const
	Instantiates a digital net with a dimension increased by one using the generating value newGenValue. More...
virtual std::string	format (OutputFormat outputFormat=OutputFormat::HUMAN, unsigned int interlacingFactor=1) const
	Formats the net for output. Parameters outputFormat Format of output. interlacingFactor Interlacing factor of the net.
virtual bool	isSequenceViewable () const
	Returns a bool indicating whether the net can be viewed as a digital sequence.
SizeParameter	sizeParameter () const
Public Member Functions inherited from NetBuilder::DigitalNet
	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 GeneratingMatrix &	generatingMatrix (Dimension coord) const
	Returns the generating matrix corresponding to coordinate coord. More...

Additional Inherited Members
Protected Member Functions inherited from NetBuilder::DigitalNet
	DigitalNet (Dimension dimension, unsigned int nRows, unsigned int nCols, std::vector< std::shared_ptr< GeneratingMatrix >> genMatrices)
	Most general constructor. More...
Protected Attributes inherited from NetBuilder::DigitalNet
Dimension	m_dimension
unsigned int	m_nRows
unsigned int	m_nCols
std::vector< std::shared_ptr< GeneratingMatrix > >	m_generatingMatrices

Detailed Description

template<NetConstruction NC>
class NetBuilder::DigitalNetConstruction< NC >

Derived class of DigitalNet designed to implement specific construction methods.

The available construction methods are described by the NetConstruction enumeration which is a non-type template parameter of the DigitalNetConstruction class. Construction methods are based on two parameters: a size parameter which is shared by all coordinates and a sequence of generating values, each of them being associated to one coordinate.

See also

NetBuilder::NetConstructionTraits

Examples:

tutorial/NetQuantiles.cc.

Constructor & Destructor Documentation

DigitalNetConstruction() [1/2]

template<NetConstruction NC>

NetBuilder::DigitalNetConstruction< NC >::DigitalNetConstruction ( Dimension  dimension, SizeParameter  sizeParameter, std::vector< GenValue >  genValues  )

inline

Constructor.

Parameters

dimension	Dimension of the net.
sizeParameter	Size parameter of the net.
genValues	Sequence of generating values to create the net.

DigitalNetConstruction() [2/2]

template<NetConstruction NC>

NetBuilder::DigitalNetConstruction< NC >::DigitalNetConstruction ( Dimension  dimension = 0, SizeParameter  sizeParameter = SizeParameter()  )

inline

Constructor for placeholder nets.

Parameters

dimension	Dimension of the net.
sizeParameter	Size parameter of the net.

Member Function Documentation

extendDimension()

template<NetConstruction NC>

std::unique_ptr<DigitalNetConstruction<NC> > NetBuilder::DigitalNetConstruction< NC >::extendDimension ( const GenValue &  newGenValue ) const

inline

Instantiates a digital net with a dimension increased by one using the generating value newGenValue.

Note that the resources (generating matrices, generatins values and computation data) for the lower dimensions are not copied. The net on which this method is called and the new net share these resources.

Parameters

newGenValue

Generating value used to extend the net.

Returns

A std::unique_ptr to the instantiated net.

---

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

• include/netbuilder/DigitalNet.h