SIMD oriented Fast Mersenne Twister(SFMT) More...

#include <string.h>
#include <assert.h>
#include "SFMT.h"
#include "SFMT-params.h"
#include "SFMT-common.h"

Macros
#define	UNUSED_VARIABLE(x) (void)(x)

Functions
static int	idxof (int i)
	This function simulate a 64-bit index of LITTLE ENDIAN in BIG ENDIAN machine. More...

static void	gen_rand_array (sfmt_t sfmt, w128_t array, int size)
	This function fills the user-specified array with pseudorandom integers. More...

static uint32_t	func1 (uint32_t x)
	This function represents a function used in the initialization by init_by_array. More...

static uint32_t	func2 (uint32_t x)
	This function represents a function used in the initialization by init_by_array. More...

static void	period_certification (sfmt_t *sfmt)
	This function certificate the period of 2^{MEXP}. More...

const char *	sfmt_get_idstring (sfmt_t *sfmt)
	This function returns the identification string. More...

int	sfmt_get_min_array_size32 (sfmt_t *sfmt)
	This function returns the minimum size of array used for fill_array32() function. More...

int	sfmt_get_min_array_size64 (sfmt_t *sfmt)
	This function returns the minimum size of array used for fill_array64() function. More...

void	sfmt_gen_rand_all (sfmt_t *sfmt)
	This function fills the internal state array with pseudorandom integers. More...

void	sfmt_fill_array32 (sfmt_t sfmt, uint32_t array, int size)
	This function generates pseudorandom 32-bit integers in the specified array[] by one call. More...

void	sfmt_fill_array64 (sfmt_t sfmt, uint64_t array, int size)
	This function generates pseudorandom 64-bit integers in the specified array[] by one call. More...

void	sfmt_init_gen_rand (sfmt_t *sfmt, uint32_t seed)
	This function initializes the internal state array with a 32-bit integer seed. More...

void	sfmt_init_by_array (sfmt_t sfmt, uint32_t init_key, int key_length)
	This function initializes the internal state array, with an array of 32-bit integers used as the seeds. More...

Detailed Description

SIMD oriented Fast Mersenne Twister(SFMT)

Author: Mutsuo Saito (Hiroshima University); Makoto Matsumoto (Hiroshima University)

Copyright (C) 2006, 2007 Mutsuo Saito, Makoto Matsumoto and Hiroshima University. Copyright (C) 2012 Mutsuo Saito, Makoto Matsumoto, Hiroshima University and The University of Tokyo. Copyright (C) 2013 Mutsuo Saito, Makoto Matsumoto and Hiroshima University. All rights reserved.

The 3-clause BSD License is applied to this software, see LICENSE.txt

Macro Definition Documentation

◆ UNUSED_VARIABLE

#define UNUSED_VARIABLE ( x ) (void)(x)

Referenced by sfmt_get_idstring(), sfmt_get_min_array_size32(), and sfmt_get_min_array_size64().

Function Documentation

◆ func1()

static uint32_t func1 ( uint32_t x )

inlinestatic

This function represents a function used in the initialization by init_by_array.

Parameters

x	32-bit integer

Returns: 32-bit integer

Referenced by sfmt_init_by_array().

◆ func2()

static uint32_t func2 ( uint32_t x )

inlinestatic

This function represents a function used in the initialization by init_by_array.

Parameters

x	32-bit integer

Returns: 32-bit integer

Referenced by sfmt_init_by_array().

◆ gen_rand_array()

static void gen_rand_array	(	sfmt_t *	sfmt,
		w128_t *	array,
		int	size
	)

inlinestatic

This function fills the user-specified array with pseudorandom integers.

Parameters

sfmt	SFMT internal state
array	an 128-bit array to be filled by pseudorandom numbers.
size	number of 128-bit pseudorandom numbers to be generated.

References SFMT_T::state, and W128_T::u.

Referenced by sfmt_fill_array32(), and sfmt_fill_array64().

◆ idxof()

static int idxof ( int i )

inlinestatic

This function simulate a 64-bit index of LITTLE ENDIAN in BIG ENDIAN machine.

Referenced by period_certification(), sfmt_init_by_array(), and sfmt_init_gen_rand().

◆ period_certification()

static void period_certification ( sfmt_t * sfmt )

static

This function certificate the period of 2^{MEXP}.

Parameters

sfmt	SFMT internal state

References idxof(), SFMT_T::state, and W128_T::u.

Referenced by sfmt_init_by_array(), and sfmt_init_gen_rand().

◆ sfmt_fill_array32()

void sfmt_fill_array32	(	sfmt_t *	sfmt,
		uint32_t *	array,
		int	size
	)

This function generates pseudorandom 32-bit integers in the specified array[] by one call.

The number of pseudorandom integers is specified by the argument size, which must be at least 624 and a multiple of four. The generation by this function is much faster than the following gen_rand function.

For initialization, init_gen_rand or init_by_array must be called before the first call of this function. This function can not be used after calling gen_rand function, without initialization.

Parameters

sfmt	SFMT internal state
array	an array where pseudorandom 32-bit integers are filled by this function. The pointer to the array must be "aligned" (namely, must be a multiple of 16) in the SIMD version, since it refers to the address of a 128-bit integer. In the standard C version, the pointer is arbitrary.
size	the number of 32-bit pseudorandom integers to be generated. size must be a multiple of 4, and greater than or equal to (MEXP / 128 + 1) * 4.

Note: memalign or posix_memalign is available to get aligned memory. Mac OSX doesn't have these functions, but malloc of OSX returns the pointer to the aligned memory block.

References gen_rand_array(), and SFMT_T::idx.

◆ sfmt_fill_array64()

void sfmt_fill_array64	(	sfmt_t *	sfmt,
		uint64_t *	array,
		int	size
	)

This function generates pseudorandom 64-bit integers in the specified array[] by one call.

The number of pseudorandom integers is specified by the argument size, which must be at least 312 and a multiple of two. The generation by this function is much faster than the following gen_rand function.

Parameters

sfmt	SFMT internal state For initialization, init_gen_rand or init_by_array must be called before the first call of this function. This function can not be used after calling gen_rand function, without initialization.
array	an array where pseudorandom 64-bit integers are filled by this function. The pointer to the array must be "aligned" (namely, must be a multiple of 16) in the SIMD version, since it refers to the address of a 128-bit integer. In the standard C version, the pointer is arbitrary.
size	the number of 64-bit pseudorandom integers to be generated. size must be a multiple of 2, and greater than or equal to (MEXP / 128 + 1) * 2

Note: memalign or posix_memalign is available to get aligned memory. Mac OSX doesn't have these functions, but malloc of OSX returns the pointer to the aligned memory block.

References gen_rand_array(), and SFMT_T::idx.

◆ sfmt_gen_rand_all()

void sfmt_gen_rand_all ( sfmt_t * sfmt )

This function fills the internal state array with pseudorandom integers.

Parameters

sfmt	SFMT internal state

References SFMT_T::state.

Referenced by sfmt_genrand_uint32(), and sfmt_genrand_uint64().

◆ sfmt_get_idstring()

const char* sfmt_get_idstring ( sfmt_t * sfmt )

This function returns the identification string.

The string shows the word size, the Mersenne exponent, and all parameters of this generator.

Parameters

sfmt	SFMT internal state

References UNUSED_VARIABLE.

◆ sfmt_get_min_array_size32()

int sfmt_get_min_array_size32 ( sfmt_t * sfmt )

This function returns the minimum size of array used for fill_array32() function.

Parameters

sfmt	SFMT internal state

Returns: minimum size of array used for fill_array32() function.

References UNUSED_VARIABLE.

◆ sfmt_get_min_array_size64()

int sfmt_get_min_array_size64 ( sfmt_t * sfmt )

This function returns the minimum size of array used for fill_array64() function.

Parameters

sfmt	SFMT internal state

Returns: minimum size of array used for fill_array64() function.

References UNUSED_VARIABLE.

◆ sfmt_init_by_array()

void sfmt_init_by_array	(	sfmt_t *	sfmt,
		uint32_t *	init_key,
		int	key_length
	)

This function initializes the internal state array, with an array of 32-bit integers used as the seeds.

Parameters

sfmt	SFMT internal state
init_key	the array of 32-bit integers, used as a seed.
key_length	the length of init_key.

References func1(), func2(), SFMT_T::idx, idxof(), period_certification(), SFMT_T::state, and W128_T::u.

◆ sfmt_init_gen_rand()

void sfmt_init_gen_rand	(	sfmt_t *	sfmt,
		uint32_t	seed
	)

This function initializes the internal state array with a 32-bit integer seed.

Parameters

sfmt	SFMT internal state
seed	a 32-bit integer used as the seed.

References SFMT_T::idx, idxof(), period_certification(), SFMT_T::state, and W128_T::u.

Macros

Functions

Detailed Description

Macro Definition Documentation

◆ UNUSED_VARIABLE

Function Documentation

◆ func1()

◆ func2()

◆ gen_rand_array()

◆ idxof()

◆ period_certification()

◆ sfmt_fill_array32()

◆ sfmt_fill_array64()

◆ sfmt_gen_rand_all()

◆ sfmt_get_idstring()

◆ sfmt_get_min_array_size32()

◆ sfmt_get_min_array_size64()

◆ sfmt_init_by_array()

◆ sfmt_init_gen_rand()