QUESO::RngBase Class Reference

Class for random number generation (base class for either GSL or Boost RNG). More...

#include <RngBase.h>

Inheritance diagram for QUESO::RngBase:

Public Member Functions
Constructor/Destructor methods
	RngBase ()
	Default Constructor: it should not be used. More...
	RngBase (int seed, int worldRank)
	Constructor with seed. More...
virtual	~RngBase ()
	Virtual destructor. More...
Sampling methods
int	seed () const
	Sets the seed. More...
virtual void	resetSeed (int newSeed)
	Resets the seed with value newSeed. More...
virtual double	uniformSample () const =0
	Samples a value from a uniform distribution. More...
virtual double	gaussianSample (double stdDev) const =0
	Samples a value from a Gaussian distribution with standard deviation given by stdDev. More...
virtual double	betaSample (double alpha, double beta) const =0
	Samples a value from a Beta distribution. More...
virtual double	gammaSample (double a, double b) const =0
	Samples a value from a Gamma distribution. More...

Protected Attributes
int	m_seed
	Seed. More...
int	m_worldRank
	Rank of processor. More...

Private Member Functions
void	privateResetSeed ()
	Reset seed. More...

Detailed Description

Class for random number generation (base class for either GSL or Boost RNG).

This class is a “virtual” class of generic random number generator, in order to accommodate either GSL or Boost RNG.

Definition at line 45 of file RngBase.h.

Constructor & Destructor Documentation

QUESO::RngBase::RngBase

(

)

Default Constructor: it should not be used.

Definition at line 30 of file RngBase.C.

References m_worldRank, and UQ_FATAL_TEST_MACRO.

  :
  m_seed     (0),
  m_worldRank(UQ_UNAVAILABLE_RANK)
{
  UQ_FATAL_TEST_MACRO(true,
                      m_worldRank,
                      "RngBase::constructor(), default",
                      "should not be used by user");
}

QUESO::RngBase::RngBase	(	int	seed,
		int	worldRank
	)

Constructor with seed.

Definition at line 41 of file RngBase.C.

References privateResetSeed().

  :
  m_seed     (seed),
  m_worldRank(worldRank)
{
  privateResetSeed();
}

QUESO::RngBase::~RngBase ( )

virtual

Virtual destructor.

Definition at line 49 of file RngBase.C.

{
}

Member Function Documentation

virtual double QUESO::RngBase::betaSample ( double  alpha, double  beta  ) const

pure virtual

Samples a value from a Beta distribution.

Implemented in QUESO::RngGsl, and QUESO::RngBoost.

Referenced by QUESO::GslVector::cwSetBeta().

virtual double QUESO::RngBase::gammaSample ( double  a, double  b  ) const

pure virtual

Samples a value from a Gamma distribution.

Implemented in QUESO::RngGsl, and QUESO::RngBoost.

Referenced by QUESO::GslVector::cwSetGamma(), and QUESO::GslVector::cwSetInverseGamma().

virtual double QUESO::RngBase::gaussianSample ( double  stdDev ) const

pure virtual

Samples a value from a Gaussian distribution with standard deviation given by stdDev.

Implemented in QUESO::RngGsl, and QUESO::RngBoost.

Referenced by QUESO::GslVector::cwSetGaussian(), QUESO::InfiniteDimensionalGaussian::draw(), and QUESO::MiscGammar().

void QUESO::RngBase::privateResetSeed ( )

private

Reset seed.

Definition at line 68 of file RngBase.C.

References m_seed, and m_worldRank.

Referenced by resetSeed(), and RngBase().

{
  if (m_seed >= 0) {
    // Do nothing
  }
  else if (m_seed < 0) {
    m_seed = (-m_seed+m_worldRank);
  }
  //else {
  //  struct timeval timevalNow;
  //  /*iRC = */gettimeofday(&timevalNow, NULL);
  //  m_seed = (int) timevalNow.tv_usec;
  //}

  return;
}

void QUESO::RngBase::resetSeed ( int  newSeed )

virtual

Resets the seed with value newSeed.

Reimplemented in QUESO::RngGsl, and QUESO::RngBoost.

Definition at line 60 of file RngBase.C.

References m_seed, and privateResetSeed().

Referenced by QUESO::RngGsl::resetSeed(), and QUESO::BaseEnvironment::resetSeed().

{
  m_seed = newSeed;
  privateResetSeed();
  return;
}

int QUESO::RngBase::seed

(

)

const

Sets the seed.

Definition at line 54 of file RngBase.C.

References m_seed.

Referenced by QUESO::BaseEnvironment::seed().

{
  return m_seed;
}

virtual double QUESO::RngBase::uniformSample ( ) const

pure virtual

Samples a value from a uniform distribution.

Implemented in QUESO::RngGsl, and QUESO::RngBoost.

Referenced by QUESO::GslVector::cwSetUniform(), QUESO::MiscGammar(), and QUESO::FiniteDistribution::sample().

Member Data Documentation

int QUESO::RngBase::m_seed

protected

Seed.

Definition at line 85 of file RngBase.h.

Referenced by privateResetSeed(), resetSeed(), QUESO::RngGsl::resetSeed(), QUESO::RngGsl::RngGsl(), and seed().

int QUESO::RngBase::m_worldRank

protected

Rank of processor.

Definition at line 88 of file RngBase.h.

Referenced by privateResetSeed(), QUESO::RngGsl::resetSeed(), RngBase(), QUESO::RngBoost::RngBoost(), and QUESO::RngGsl::RngGsl().

---

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

• src/core/inc/RngBase.h
• src/core/src/RngBase.C