gpmp::core::rndm::LCG Class Reference

Linear Congruential Generator. More...

#include <random.hpp>

Public Types
using	result_type = uint64_t

Public Member Functions
	LCG ()
	LCG (uint64_t seed, uint64_t a=6364136223846793005ULL, uint64_t c=1442695040888963407ULL)
uint64_t	operator() ()
void	seed (uint64_t new_seed)
uint64_t	get_multiplier () const
uint64_t	get_increment () const
uint64_t	get_seed () const

Private Attributes
uint64_t	state
uint64_t	multiplier
uint64_t	increment

Detailed Description

Linear Congruential Generator.

Parameters

m	= modulus : 32-bit int max
a	= multiplier : 6364136223846793005 (from Knuth MMIX)
c	= increment : 1442695040888963407 (from Knuth MMIX)

Returns

generated number

Definition at line 82 of file random.hpp.

Member Typedef Documentation

result_type

using gpmp::core::rndm::LCG::result_type = uint64_t

Definition at line 84 of file random.hpp.

Constructor & Destructor Documentation

LCG() [1/2]

gpmp::core::rndm::LCG::LCG

(

)

Definition at line 39 of file random.cpp.

    : state(1), multiplier(6364136223846793005ULL),
      increment(1442695040888963407ULL) {
}

LCG() [2/2]

gpmp::core::rndm::LCG::LCG	(	uint64_t	seed,
		uint64_t	a = 6364136223846793005ULL,
		uint64_t	c = 1442695040888963407ULL
	)

Definition at line 45 of file random.cpp.

    : state(seed), multiplier(a), increment(c) {
}

Member Function Documentation

get_increment()

uint64_t gpmp::core::rndm::LCG::get_increment

(

)

const

Definition at line 75 of file random.cpp.

                                              {
    return increment;
}

get_multiplier()

uint64_t gpmp::core::rndm::LCG::get_multiplier

(

)

const

Definition at line 71 of file random.cpp.

                                               {
    return multiplier;
}

get_seed()

uint64_t gpmp::core::rndm::LCG::get_seed

(

)

const

Definition at line 79 of file random.cpp.

                                         {
    return state;
}

operator()()

uint64_t gpmp::core::rndm::LCG::operator()

(

)

Definition at line 49 of file random.cpp.

                                     {
    // Ensure the state is non-negative
    state &= 0x7FFFFFFFFFFFFFFFULL;
 
    // Linear Congruential Generator algorithm
    state = multiplier * state + increment;
 
    // Overflow handling
    if (state < increment) {
        // Overflow occurred, adjust the state
        state += increment;
    }
 
    return state;
}

seed()

void gpmp::core::rndm::LCG::seed

(

uint64_t

new_seed

)

Definition at line 66 of file random.cpp.

                                            {
    state = new_seed;
}

Member Data Documentation

increment

uint64_t gpmp::core::rndm::LCG::increment

private

Definition at line 108 of file random.hpp.

multiplier

uint64_t gpmp::core::rndm::LCG::multiplier

private

Definition at line 107 of file random.hpp.

state

uint64_t gpmp::core::rndm::LCG::state

private

Definition at line 106 of file random.hpp.

---

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

• include/openGPMP/nt/random.hpp
• modules/nt/random.cpp