tbb::internal::FastRandom Class Reference

A fast random number generator. More...

#include <tbb_misc.h>

Collaboration diagram for tbb::internal::FastRandom:

Public Member Functions
unsigned short	get ()
	Get a random number. More...
unsigned short	get (unsigned &seed)
	Get a random number for the given seed; update the seed for next use. More...
	FastRandom (void *unique_ptr)
	Construct a random number generator. More...
	FastRandom (uint32_t seed)
	FastRandom (uint64_t seed)
template<typename T >
void	init (T seed)
void	init (uint64_t seed, int_to_type< 8 >)
void	init (uint32_t seed, int_to_type< 4 >)

Private Attributes
unsigned	x
unsigned	c

Static Private Attributes
static const unsigned	a = 0x9e3779b1

Detailed Description

A fast random number generator.

Uses linear congruential method.

Definition at line 128 of file tbb_misc.h.

Constructor & Destructor Documentation

FastRandom() [1/3]

tbb::internal::FastRandom::FastRandom ( void *  unique_ptr )

inline

Construct a random number generator.

Definition at line 150 of file tbb_misc.h.

{ init(uintptr_t(unique_ptr)); }

FastRandom() [2/3]

tbb::internal::FastRandom::FastRandom ( uint32_t  seed )

inline

Definition at line 151 of file tbb_misc.h.

{ init(seed); }

FastRandom() [3/3]

tbb::internal::FastRandom::FastRandom ( uint64_t  seed )

inline

Definition at line 152 of file tbb_misc.h.

{ init(seed); }

Member Function Documentation

get() [1/2]

unsigned short tbb::internal::FastRandom::get ( )

inline

Get a random number.

Definition at line 139 of file tbb_misc.h.

Referenced by tbb::internal::arena::occupy_free_slot_in_range(), tbb::internal::task_stream< num_priority_levels >::push(), and tbb::internal::generic_scheduler::steal_task().

                         {
        return get(x);
    }

Here is the caller graph for this function:

get() [2/2]

unsigned short tbb::internal::FastRandom::get ( unsigned &  seed )

inline

Get a random number for the given seed; update the seed for next use.

Definition at line 143 of file tbb_misc.h.

References __TBB_ASSERT.

                                         {
        unsigned short r = (unsigned short)(seed>>16);
        __TBB_ASSERT(c&1, "c must be odd for big rng period");
        seed = seed*a+c;
        return r;
    }

init() [1/3]

template<typename T >

void tbb::internal::FastRandom::init ( T  seed )

inline

Definition at line 154 of file tbb_misc.h.

                        {
        init(seed,int_to_type<sizeof(seed)>());
    }

init() [2/3]

void tbb::internal::FastRandom::init ( uint64_t  seed, int_to_type< 8 >    )

inline

Definition at line 157 of file tbb_misc.h.

                                                {
        init(uint32_t((seed>>32)+seed), int_to_type<4>());
    }

init() [3/3]

void tbb::internal::FastRandom::init ( uint32_t  seed, int_to_type< 4 >    )

inline

Definition at line 160 of file tbb_misc.h.

References tbb::internal::GetPrime().

                                               {
#if __TBB_OLD_PRIMES_RNG
        x = seed;
        a = GetPrime( seed );
#else
        // threads use different seeds for unique sequences
        c = (seed|1)*0xba5703f5; // c must be odd, shuffle by a prime number
        x = c^(seed>>1); // also shuffle x for the first get() invocation
#endif
    }

Here is the call graph for this function:

Member Data Documentation

a

const unsigned tbb::internal::FastRandom::a = 0x9e3779b1

staticprivate

Definition at line 135 of file tbb_misc.h.

c

unsigned tbb::internal::FastRandom::c

private

Definition at line 134 of file tbb_misc.h.

x

unsigned tbb::internal::FastRandom::x

private

Definition at line 134 of file tbb_misc.h.

---

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

• tbb_misc.h