Sobol Class Reference

#include <sobol.hpp>

Inheritance diagram for Sobol:

Collaboration diagram for Sobol:

Public Member Functions
	Sobol (BasicInt nbits, BasicInt dim, bool in_parallel=false)
	Sobol (BasicInt nbits, std::vector< BasicInt > const &degrees_of_irrpolys)
	Sobol (BasicInt nbits, std::initializer_list< BasicInt > const &degrees_of_irrpolys)
	Sobol (BasicInt nbits, std::vector< std::vector< uintmax_t > > const &irrpolys_coeffs)
	Sobol (BasicInt nbits, std::initializer_list< std::vector< uintmax_t > > const &irrpolys_coeffs)
GenNum	inversed_generating_numbers (BasicInt dim) const
GenMat	inversed_generating_matrix (BasicInt dim) const
Public Member Functions inherited from Niederreiter
	Niederreiter (BasicInt nbits, BasicInt dim, bool in_parallel=false)
	Niederreiter (BasicInt nbits, std::vector< BasicInt > const &degrees_of_irrpolys)
	Niederreiter (BasicInt nbits, std::initializer_list< BasicInt > const &degrees_of_irrpolys)
	Niederreiter (BasicInt nbits, std::vector< std::vector< uintmax_t > > const &irrpolys_coeffs)
	Niederreiter (BasicInt nbits, std::initializer_list< std::vector< uintmax_t > > const &irrpolys_coeffs)
BasicInt	t_estimate (void) const
	Retutns t-value of a corresponding digital (t, s)-sequence.
Public Member Functions inherited from DigitalNet
	DigitalNet (DigitalNet const &)=default
	DigitalNet (DigitalNet &&)=default
DigitalNet &	operator= (DigitalNet const &)=default
DigitalNet &	operator= (DigitalNet &&)=default
	DigitalNet (void)
	Creates empty object.
	DigitalNet (std::vector< GenNum > const &generating_numbers)
	Creates digital net with given generating numbers.
	DigitalNet (std::vector< GenMat > const &generating_matrices)
	Creates digital net with given generating matrices.
BasicInt	m (void) const
	Returns \(m\) parameter of the net.
BasicInt	s (void) const
	Returns \(s\) parameter of the net.
GenNum	generating_numbers (BasicInt dim) const
GenMat	generating_matrix (BasicInt dim) const
Point	generate_point_classical (CountInt pos) const
Point	generate_point (CountInt pos) const
IntPoint	generate_int_point (CountInt pos) const
void	for_each_point (std::function< void(Point const &, CountInt)> handler, CountInt amount, CountInt pos=0) const
void	for_each_int_point (std::function< void(IntPoint const &, CountInt)> handler, CountInt amount, CountInt pos=0) const
Point	cast_int_point_to_real (IntPoint const &int_point) const

Protected Member Functions
void	initialize_generating_numbers (void) override
Protected Member Functions inherited from Niederreiter
	Niederreiter (BasicInt nbits, BasicInt dim, std::vector< GenNum > const &generating_numbers, Real recip, std::vector< Polynomial > const &irrpolys, void(Niederreiter::*ptr_check)(void const *), void const *ptr_arg)
void	check_init1 (void const *ptr_arg)
void	check_init2 (void const *ptr_arg)
void	check_init3 (void const *ptr_arg)
Protected Member Functions inherited from DigitalNet
	DigitalNet (BasicInt nbits, BasicInt dim, std::vector< GenNum > const &generating_numbers)
void	store_int_point (IntPoint &point, CountInt pos) const
void	store_next_int_point (IntPoint &point, CountInt pos, IntPoint const &prev_point) const

Additional Inherited Members
Protected Attributes inherited from Niederreiter
std::vector< Polynomial >	m_irrpolys
	Vector of s initial irreducible polynomials of a (t,m,s)-net.
Protected Attributes inherited from DigitalNet
BasicInt	m_nbits
	\(m\) parameter of the digital net
BasicInt	m_dim
	\(s\) parameter of the digital net
Real	m_recip
	Coefficient equal to \(2^{-m}\).
std::vector< GenNum >	m_generating_numbers
	Vector of a generating numbers of the digital net.

Detailed Description

Represents digital Sobol (t, m, s)-net in base 2

Constructor & Destructor Documentation

Sobol() [1/4]

Sobol	(	BasicInt	nbits,
		std::vector< BasicInt > const &	degrees_of_irrpolys
	)

Constructs the generator of (t,m,s)-net with specified m, s degrees of initial irreducible polynomials, and (optional, for advanced users) initial values of ALL recursive sequences, defining the generation matrices.

Parameters

[in]	nbits	- m parameter of the net
[in]	degrees_of_irrpolys	- vector of the s degrees of initial irreducible polynomials

Sobol() [2/4]

Sobol	(	BasicInt	nbits,
		std::initializer_list< BasicInt > const &	degrees_of_irrpolys
	)

Constructs the generator of (t,m,s)-net with specified m, s degrees of initial irreducible polynomials, and (optional, for advanced users) initial values of ALL recursive sequences, defining the generation matrices.

Parameters

[in]	nbits	- m parameter of the net
[in]	degrees_of_irrpolys	- vector of the s degrees of initial irreducible polynomials

Sobol() [3/4]

Sobol	(	BasicInt	nbits,
		std::vector< std::vector< uintmax_t > > const &	irrpolys_coeffs
	)

Constructs the generator of (t,m,s)-net with specified m, s initial irreducible polynomials, and (optional, for advanced users) initial values of ALL recursive sequences, defining the generation matrices.

Parameters

[in]	nbits	- m parameter of the net
[in]	irrpolys_coeffs	- initializer list of the s initial irreducible polynomials coefficients

Sobol() [4/4]

Sobol	(	BasicInt	nbits,
		std::initializer_list< std::vector< uintmax_t > > const &	irrpolys_coeffs
	)

Constructs the generator of (t,m,s)-net with specified m, s initial irreducible polynomials, and (optional, for advanced users) initial values of ALL recursive sequences, defining the generation matrices.

Parameters

[in]	nbits	- m parameter of the net
[in]	irrpolys_coeffs	- initializer list of the s initial irreducible polynomials coefficients

Member Function Documentation

initialize_generating_numbers()

void initialize_generating_numbers ( void  )

overrideprotectedvirtual

Initializes (t,m,s)-net direction numbers.

Reimplemented from Niederreiter.