MCQMCIntegration  0.1
Data Structures | Public Member Functions
MCQMCIntegration::DigitalNet< uint64_t > Class Template Reference

Digital Net class for Quasi Mote-Carlo Method. More...

#include <DigitalNet.h>

Public Member Functions

 DigitalNet (std::istream &is)
 constructor from stream. More...
 
 DigitalNet (DigitalNetID id, uint32_t s, uint32_t m)
 constructor from pre-defined data. More...
 
 ~DigitalNet ()
 destructor. More...
 
uint64_t getBase (int i, int j) const
 get an element of base matrix of generating point set. More...
 
double getPoint (int i) const
 get a component of a point vector. More...
 
const double * getPoint () const
 get a point vector. More...
 
uint32_t getS () const
 get dimension of digital net. More...
 
uint32_t getM () const
 get F2 dimension of element of digital net. More...
 
void showStatus (std::ostream &os)
 show internal status. More...
 
void pointInitialize ()
 (re-)initialize point. More...
 
void nextPoint ()
 state transition to next point. More...
 
void setDigitalShift (bool value)
 
void setSeed (uint64_t seed)
 set seed for random number generator for scramble. More...
 
double getWAFOM ()
 get WAFOM value if exist. More...
 
int64_t getTvalue ()
 get t-value if exist. More...
 

Detailed Description

template<>
class MCQMCIntegration::DigitalNet< uint64_t >

Digital Net class for Quasi Mote-Carlo Method.

Explicit specialization for 64-bit unsigned integer.

Constructor & Destructor Documentation

◆ DigitalNet() [1/2]

MCQMCIntegration::DigitalNet< uint64_t >::DigitalNet ( std::istream &  is)

constructor from stream.

FORMAT:

  • separators are white spaces or newlines.
  • 1st element : 64 fixed.
  • 2nd element : s, dimension of point set.
  • 3rd element : m, F2 dimension of element of point set.
  • 4th - : s * m elements of 64-bit integers.
  • last but one: WAFOM value, optional.
  • last : t-value, optional.
    Exceptions
    runtime_errorwhen can't read from stream.

◆ DigitalNet() [2/2]

MCQMCIntegration::DigitalNet< uint64_t >::DigitalNet ( DigitalNetID  id,
uint32_t  s,
uint32_t  m 
)

constructor from pre-defined data.

DigitalNetID:

  • NXLW : Niederreiter-Xing low WAFOM up to dimension 10.
  • SOBOL: Sobol Point Set up to dimension 21201.
  • SOLW : Sobol low WAFOM up to dimension 10.
    Parameters
    [in]idID of pre-defined digital net.
    [in]sdimension of point set, s should be 4 <= s
    [in]mF2 dimension of element of point set, m should be 10 <= m <= 18.

◆ ~DigitalNet()

destructor.

Member Function Documentation

◆ getBase()

uint64_t MCQMCIntegration::DigitalNet< uint64_t >::getBase ( int  i,
int  j 
) const
inline

get an element of base matrix of generating point set.

Parameters
[in]irow
[in]jcolumn
Returns
an element of base matrix of generating point set.

◆ getM()

uint32_t MCQMCIntegration::DigitalNet< uint64_t >::getM ( ) const
inline

get F2 dimension of element of digital net.

Returns
F2 dimension of element of digital net.

◆ getPoint() [1/2]

double MCQMCIntegration::DigitalNet< uint64_t >::getPoint ( int  i) const
inline

get a component of a point vector.

Parameters
[in]iget i-th component.
Returns
a component of a point vector.

Referenced by MCQMCIntegration::quasi_monte_carlo_integration().

◆ getPoint() [2/2]

const double* MCQMCIntegration::DigitalNet< uint64_t >::getPoint ( ) const
inline

get a point vector.

Returns
a point vector.

◆ getS()

uint32_t MCQMCIntegration::DigitalNet< uint64_t >::getS ( ) const
inline

get dimension of digital net.

Returns
dimension of digital net.

◆ getTvalue()

int64_t MCQMCIntegration::DigitalNet< uint64_t >::getTvalue ( )
inline

get t-value if exist.

Returns
t-value

◆ getWAFOM()

double MCQMCIntegration::DigitalNet< uint64_t >::getWAFOM ( )
inline

get WAFOM value if exist.

Returns
WAFOM value.

◆ nextPoint()

void MCQMCIntegration::DigitalNet< uint64_t >::nextPoint ( )

state transition to next point.

Referenced by MCQMCIntegration::quasi_monte_carlo_integration().

◆ pointInitialize()

void MCQMCIntegration::DigitalNet< uint64_t >::pointInitialize ( )

(re-)initialize point.

Referenced by MCQMCIntegration::quasi_monte_carlo_integration().

◆ setDigitalShift()

void MCQMCIntegration::DigitalNet< uint64_t >::setDigitalShift ( bool  value)
inline

◆ setSeed()

void MCQMCIntegration::DigitalNet< uint64_t >::setSeed ( uint64_t  seed)

set seed for random number generator for scramble.

◆ showStatus()

void MCQMCIntegration::DigitalNet< uint64_t >::showStatus ( std::ostream &  os)

show internal status.

Parameters
[in,out]osoutput stream

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