SFMT Documentation

1.3.3

This is SIMD oriented Fast Mersenne Twister pseudorandom number generator(SFMT). This Project provides pseudorandom number generators of various Mersenne Prime Period: from 2⁶⁰⁷-1 to 2²¹⁶⁰⁹¹-1.

Please check endianness in source codes carefully, if you are using BIG ENDIAN.

• void init_gen_rand() initializes the generator with a 32-bit integer seed.
• void init_by_array() initializes the generator with an array of 32-bit integers as the seeds.
• uint32_t gen_rand32() generates and returns a pseudorandom 32-bit unsigned integer.
• uint32_t gen_rand64() generates and returns a pseudorandom 64-bit unsigned integer.
• void fill_array32() fills the user-specified array with 32-bit pseudorandom integers.
• void fill_array64() fills the user-specified array with 64-bit pseudorandom integers.
• inline static double to_real1(uint32_t v) convert v to double on [0,1]-real-interval.
• inline static double genrand_real1() generates a random number on [0,1]-real-interval.
• inline static double to_real2(uint32_t v) convert v to double on [0,1)-real-interval.
• inline static double genrand_real2() generates a random number on [0,1)-real-interval.
• inline static double to_real3(uint32_t v) convert v to double on (0,1)-real-interval.
• inline static double genrand_real3() generates a random number on (0,1)-real-interval.
• inline static double to_res53(uint64_t v) convert v to double on [0,1) with 53-bit resolution
• inline static double genrand_res53() generates a random number on [0,1) with 53-bit resolution
• inline static double to_res53_mix(uint32_t x, uint32_t y) convert v to double on [0,1) with 53-bit resolution from two 32bit integers.
• inline static double genrand_res53_mix() generates a random number on [0,1) with 53-bit resolution using 32bit generation.

Each SFMT.xxx.out.txt file contains 1000 outputs of gen_rand32() initialized by init_genrand(1234), and 1000 outputs of gen_rand32() initialized by init_by_array with an array of {0x1234, 0x5678, 0x9abc, 0xdef0}.

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

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:

2007-10-3

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

The new BSD License is applied to this software.

Copyright (c) 2006,2007 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.

---