Bit equidistribution figure. More...

#include <BitEquidistribution.h>

Inherits NetBuilder::FigureOfMerit::CBCFigureOfMerit.

Public Types
typedef std::unique_ptr< LevelCombiner::LevelCombiner >	pCombiner

Public Member Functions
	BitEquidistribution (unsigned int nbBits, Real weight=std::numeric_limits< Real >::infinity(), Real normType=std::numeric_limits< Real >::infinity(), pCombiner combiner=std::make_unique< LevelCombiner::LevelCombiner >())
	Constructor. More...

Real	weight () const
	Returns the weight of the figure of merit.

virtual Accumulator	accumulator (Real initialValue) const override
	Creates a new accumulator. More...

virtual std::unique_ptr< CBCFigureOfMeritEvaluator >	evaluator () override
	Returns a `std::unique_ptr` to an evaluator for the figure of merit.

unsigned int	nbBits () const
	Returns the number of bits taken into account for equidistribution by the figure.

Real	expNorm () const
	Returns the exponent to use when accumulating merits.

Real	combine (std::vector< unsigned int > merits)
	Returns a combined merit from a vector of merits using the combiner of the figure.

virtual std::string	format () const override
	Output information about the figure of merit.

template<>
std::string	format () const
	Template specialization of the output information about the figure of merit in the unilevel case.

template<>
std::string	format () const
	Template specialization of the output information about the figure of merit in the multilevel case.

Public Member Functions inherited from NetBuilder::FigureOfMerit::CBCFigureOfMerit
virtual	~CBCFigureOfMerit ()=default
	Virtual default destructor.

Public Member Functions inherited from NetBuilder::FigureOfMerit::FigureOfMerit
virtual	~FigureOfMerit ()=default
	Virtual default destructor.

std::unique_ptr< FigureOfMeritEvaluator >	evaluator ()
	Returns a `std::unique_ptr` to an evaluator for the figure of merit.

Detailed Description

template<EmbeddingType ET>
class NetBuilder::FigureOfMerit::BitEquidistribution< ET >

Bit equidistribution figure.

Figure of merit which penalizes digital nets for which the first bits are not equidistributed.

Constructor & Destructor Documentation

◆ BitEquidistribution()

template<EmbeddingType ET>

NetBuilder::FigureOfMerit::BitEquidistribution< ET >::BitEquidistribution	(	unsigned int	nbBits,
		Real	weight = `std::numeric_limits<Real>::infinity()`,
		Real	normType = `std::numeric_limits<Real>::infinity()`,
		pCombiner	combiner = `std::make_unique<LevelCombiner::LevelCombiner>()`
	)

inline

Constructor.

Parameters

nbBits	Number of bits taken into account by the figure.
weight	Weight of the figure of merit. Defaults to +inf.
normType	Norm type of the figure of merit. Defaults to sup norm.
combiner	LevelCombiner for the multilevel case. Default to the (non-callable) empty function.

Member Function Documentation

◆ accumulator()

template<EmbeddingType ET>

virtual Accumulator NetBuilder::FigureOfMerit::BitEquidistribution< ET >::accumulator ( Real initialValue ) const

inlineoverridevirtual

Creates a new accumulator.

Parameters

initialValue Initial accumulator value.

Implements NetBuilder::FigureOfMerit::CBCFigureOfMerit.

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

include/netbuilder/FigureOfMerit/BitEquidistribution.h

Public Types