Intel(R) Threading Building Blocks Doxygen Documentation  version 4.2.3
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 130 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 152 of file tbb_misc.h.

152 { init(uintptr_t(unique_ptr)); }

◆ FastRandom() [2/3]

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

Definition at line 153 of file tbb_misc.h.

153 { init(seed); }

◆ FastRandom() [3/3]

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

Definition at line 154 of file tbb_misc.h.

154 { init(seed); }

Member Function Documentation

◆ get() [1/2]

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

Get a random number.

Definition at line 141 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().

141  {
142  return get(x);
143  }
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 145 of file tbb_misc.h.

References __TBB_ASSERT.

145  {
146  unsigned short r = (unsigned short)(seed>>16);
147  __TBB_ASSERT(c&1, "c must be odd for big rng period");
148  seed = seed*a+c;
149  return r;
150  }
static const unsigned a
Definition: tbb_misc.h:137
#define __TBB_ASSERT(predicate, comment)
No-op version of __TBB_ASSERT.
Definition: tbb_stddef.h:165

◆ init() [1/3]

template<typename T >
void tbb::internal::FastRandom::init ( seed)
inline

Definition at line 156 of file tbb_misc.h.

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

◆ init() [2/3]

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

Definition at line 159 of file tbb_misc.h.

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

◆ init() [3/3]

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

Definition at line 162 of file tbb_misc.h.

References tbb::internal::GetPrime().

162  {
163 #if __TBB_OLD_PRIMES_RNG
164  x = seed;
165  a = GetPrime( seed );
166 #else
167  // threads use different seeds for unique sequences
168  c = (seed|1)*0xba5703f5; // c must be odd, shuffle by a prime number
169  x = c^(seed>>1); // also shuffle x for the first get() invocation
170 #endif
171  }
static const unsigned a
Definition: tbb_misc.h:137
unsigned GetPrime(unsigned seed)
Here is the call graph for this function:

Member Data Documentation

◆ a

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

Definition at line 137 of file tbb_misc.h.

◆ c

unsigned tbb::internal::FastRandom::c
private

Definition at line 136 of file tbb_misc.h.

◆ x

unsigned tbb::internal::FastRandom::x
private

Definition at line 136 of file tbb_misc.h.


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

Copyright © 2005-2019 Intel Corporation. All Rights Reserved.

Intel, Pentium, Intel Xeon, Itanium, Intel XScale and VTune are registered trademarks or trademarks of Intel Corporation or its subsidiaries in the United States and other countries.

* Other names and brands may be claimed as the property of others.