moose::RNG< T > Class Template Reference

#include <RNG.h>

Inheritance diagram for moose::RNG< T >:

Collaboration diagram for moose::RNG< T >:

Public Member Functions
T	getSeed (void)
	RNG ()
void	setRandomSeed ()
void	setSeed (const unsigned long seed)
	If seed if 0 then set seed to a random number else set seed to the given number. More...
T	uniform (const T a, const T b)
	Generate a uniformly distributed random number between a and b. More...
T	uniform (void)
	Return a uniformly distributed random number between 0 and 1 (exclusive). More...
	~RNG ()

Private Attributes
moose::MOOSE_UNIFORM_DISTRIBUTION < double >	dist_
T	res_
moose::MOOSE_RNG_DEFAULT_ENGINE	rng_
T	seed_

Detailed Description

template<typename T>
class moose::RNG< T >

Definition at line 42 of file RNG.h.

Constructor & Destructor Documentation

template<typename T>

moose::RNG< T >::RNG ( )

inline

Definition at line 45 of file RNG.h.

        {
            // Setup a random seed if possible.
            setRandomSeed( );
        }

template<typename T>

moose::RNG< T >::~RNG ( )

inline

Definition at line 51 of file RNG.h.

        { ; }

Member Function Documentation

template<typename T>

T moose::RNG< T >::getSeed ( void  )

inline

Definition at line 61 of file RNG.h.

        {
            return seed_;
        }

template<typename T>

void moose::RNG< T >::setRandomSeed ( )

inline

Definition at line 54 of file RNG.h.

        {
            MOOSE_RANDOM_DEVICE rd_;
            setSeed( rd_() );
        }

template<typename T>

void moose::RNG< T >::setSeed ( const unsigned long  seed )

inline

If seed if 0 then set seed to a random number else set seed to the given number.

Parameters

seed

Definition at line 73 of file RNG.h.

Referenced by moose::mtseed(), GssaVoxelPools::reinit(), and ZombieCompartment::vReinit().

        {
            seed_ = seed;
            if( seed == 0 )
            {
                MOOSE_RANDOM_DEVICE rd_;
                seed_ = rd_();
            }
            rng_.seed( seed_ );
        }

Here is the caller graph for this function:

template<typename T>

T moose::RNG< T >::uniform ( const T  a, const T  b  )

inline

Generate a uniformly distributed random number between a and b.

Parameters

a	Lower limit (inclusive)
b	Upper limit (inclusive).

Definition at line 90 of file RNG.h.

Referenced by GssaVoxelPools::advance(), moose::mtrand(), ZombieCompartment::mtrand(), GssaVoxelPools::pickReac(), GssaVoxelPools::recalcTime(), GssaVoxelPools::reinit(), and GssaVoxelPools::xferIn().

        {
            return ( b - a ) * dist_( rng_ ) + a;
        }

Here is the caller graph for this function:

template<typename T>

T moose::RNG< T >::uniform ( void  )

inline

Return a uniformly distributed random number between 0 and 1 (exclusive).

Returns

randum number.

Definition at line 101 of file RNG.h.

        {
            return dist_( rng_ );
        }

Member Data Documentation

template<typename T>

moose::MOOSE_UNIFORM_DISTRIBUTION<double> moose::RNG< T >::dist_

private

Definition at line 113 of file RNG.h.

template<typename T>

T moose::RNG< T >::res_

private

Definition at line 109 of file RNG.h.

template<typename T>

moose::MOOSE_RNG_DEFAULT_ENGINE moose::RNG< T >::rng_

private

Definition at line 112 of file RNG.h.

template<typename T>

T moose::RNG< T >::seed_

private

Definition at line 110 of file RNG.h.

---

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

• moose-core/randnum/RNG.h