dSFMT Documentation

2.1

This is double precision SIMD oriented Fast Mersenne Twister pseudorandom number generator (dSFMT). This program is based on the IEEE Standard for Binary Floating-Point Arithmetic (ANSI/IEEE Std 754-1985) format.

dSFMT ver. 2.xx is completely different from dSFMT ver. 1.xx. The recursion formula is changed. And the output sequences are changed.

This version uses structure of C language. Don't use different DSFMT_MEXP for compiling dSFMT.c and your program.

This Project provides pseudorandom number generators of various Mersenne Prime Period: from 2⁵²¹-1 to 2²¹⁶⁰⁹¹-1.

To get dSFMT which has the period of 2⁵²¹-1, you have to specify -DMEXP=521 as a compile option. For example,

 gcc -DDSFMT_MEXP=521 -msse2 -DHAVE_SSE2 -c dSFMT.c

will make dSFMT which has the period of 2⁵²¹-1 and is optimized for SSE2.

See How to compile to compile your program with SFMT optimized for SIMD.

void dsfmt_init_gen_rand() initializes the generator with a 32-bit integer seed.
void dsfmt_init_by_array() initializes the generator with an array of 32-bit integers as the seeds.
const char * dsfmt_get_idstring() returns the IDSTRING which identify the generator.
int dsfmt_get_min_array_size() returns the minimum size of array used for fill_array functions.
inline double dsfmt_genrand_close1_open2() generates and returns a double precision pseudorandom number which distributes uniformly in the range [1, 2). This is the primitive and faster than generating numbers in other ranges.
inline double dsfmt_genrand_close_open() generates and returns a double precision pseudorandom number which distributes uniformly in the range [0, 1).
inline double dsfmt_genrand_open_close() generates and returns a double precision pseudorandom number which distributes uniformly in the range (0, 1].
inline double dsfmt_genrand_open_open() generates and returns a double precision pseudorandom number which distributes uniformly in the range (0, 1).
void dsfmt_fill_array_close1_open2() fills the user-specified array with double precision pseudorandom numbers which distribute uniformly in the range [1, 2).
void dsfmt_fill_array_close_open() fills the user-specified array with double precision pseudorandom numbers which distribute uniformly in the range [0, 1).
void dsfmt_fill_array_open_close() fills the user-specified array with double precision pseudorandom numbers which distribute uniformly in the range (0, 1].
void dsfmt_fill_array_open_open() fills the user-specified array with double precision pseudorandom numbers which distribute function uniformly in the range (0, 1).
uinit32_t dsfmt_genrand_uint32() generates and returns a 32 bit unsigned integer. This function is useful for generating a small number of integers among a large number of floating point numbers. This function does not have corresponding fill_array function, because the purpose of fill_array function is to generate a large number of pseudorandom numbers.

Old names init_gen_rand, init_by_array, etc. are also defined unless you define DSFMT_DO_NOT_USE_OLD_NAMES.

Author:: Mutsuo Saito (saito@our-domain) Hiroshima University
Makoto Matsumoto (m-mat@our-domain) Hiroshima University

Please change our-domain to math.sci.hiroshima-u.ac.jp

Date:: 2009-04-18

The new BSD License is applied to this software.

Copyright (c) 2007, 2008 Mutsuo Saito, Makoto Matsumoto and Hiroshima
University.  All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:

    * Redistributions of source code must retain the above copyright
      notice, this list of conditions and the following disclaimer.
    * Redistributions in binary form must reproduce the above
      copyright notice, this list of conditions and the following
      disclaimer in the documentation and/or other materials provided
      with the distribution.
    * Neither the name of the Hiroshima University nor the names of
      its contributors may be used to endorse or promote products
      derived from this software without specific prior written
      permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.