root/core/mt19937ar.c

/* [<][>][^][v][top][bottom][index][help] */

DEFINITIONS

This source file includes following definitions.
  1. init_genrand
  2. init_by_array
  3. next_state
  4. potion_rand_int
  5. potion_rand_double
  6. potion_srand
  7. potion_rand
  8. potion_num_rand

/**\file mt19937ar.c
   random numbers (mersenne twister). As Lobby (global long) or PNInteger (0-1.0)

   A C-program for MT19937, with initialization improved 2002/2/10.
   Coded by Takuji Nishimura and Makoto Matsumoto.
   This is a faster version by taking Shawn Cokus's optimization,
   Matthe Bellew's simplification, Isaku Wada's real version.

   Before using, initialize the state by using init_genrand(seed) 
   or init_by_array(init_key, key_length).

   Copyright (C) 1997 - 2002, Makoto Matsumoto and Takuji Nishimura,
   All rights reserved.              

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

   1. Redistributions of source code must retain the above copyright
    notice, this list of conditions and the following disclaimer.

   2. 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.

   3. The names of its contributors may not 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.


   Any feedback is very welcome.
   http://www.math.sci.hiroshima-u.ac.jp/~m-mat/MT/emt.html
   email: m-mat @ math.sci.hiroshima-u.ac.jp (remove space)
*/

#include <stdio.h>
#include "potion.h"

/* Period parameters */  
#define N 624
#define M 397
#define MATRIX_A 0x9908b0dfUL   /* constant vector a */
#define UMASK 0x80000000UL /* most significant w-r bits */
#define LMASK 0x7fffffffUL /* least significant r bits */
#define MIXBITS(u,v) ( ((u) & UMASK) | ((v) & LMASK) )
#define TWIST(u,v) ((MIXBITS(u,v) >> 1) ^ ((v)&1UL ? MATRIX_A : 0UL))

static unsigned long state[N]; /* the array for the state vector  */
static int left = 1;
static int initf = 0;
static unsigned long *next;

/* initializes state[N] with a seed */
void init_genrand(unsigned long s) {
  int j;
  state[0]= s & 0xffffffffUL;
  for (j=1; j<N; j++) {
    state[j] = (1812433253UL * (state[j-1] ^ (state[j-1] >> 30)) + j); 
    /* See Knuth TAOCP Vol2. 3rd Ed. P.106 for multiplier. */
    /* In the previous versions, MSBs of the seed affect   */
    /* only MSBs of the array state[].            */
    /* 2002/01/09 modified by Makoto Matsumoto       */
    state[j] &= 0xffffffffUL;  /* for >32 bit machines */
  }
  left = 1; initf = 1;
}

/* initialize by an array with array-length */
/* init_key is the array for initializing keys */
/* key_length is its length */
/* slight change for C++, 2004/2/26 */
void init_by_array(unsigned long init_key[], int key_length) {
  int i, j, k;
  init_genrand(19650218UL);
  i=1; j=0;
  k = (N>key_length ? N : key_length);
  for (; k; k--) {
    state[i] = (state[i] ^ ((state[i-1] ^ (state[i-1] >> 30)) * 1664525UL))
      + init_key[j] + j; /* non linear */
    state[i] &= 0xffffffffUL; /* for WORDSIZE > 32 machines */
    i++; j++;
    if (i>=N) { state[0] = state[N-1]; i=1; }
    if (j>=key_length) j=0;
  }
  for (k=N-1; k; k--) {
    state[i] = (state[i] ^ ((state[i-1] ^ (state[i-1] >> 30)) * 1566083941UL))
      - i; /* non linear */
    state[i] &= 0xffffffffUL; /* for WORDSIZE > 32 machines */
    i++;
    if (i>=N) { state[0] = state[N-1]; i=1; }
  }

  state[0] = 0x80000000UL; /* MSB is 1; assuring non-zero initial array */ 
  left = 1; initf = 1;
}

static void next_state(void) {
  unsigned long *p=state;
  int j;

  /* if init_genrand() has not been called, */
  /* a default initial seed is used     */
  if (initf==0) init_genrand(5489UL);

  left = N;
  next = state;
  
  for (j=N-M+1; --j; p++) {
    /*@ assert Value: mem_access: \valid_read(p+1); */
    /*@ assert Value: mem_access: \valid_read(p+397); */
    *p = p[M] ^ TWIST(p[0], p[1]);
  }

  for (j=M; --j; p++) {
    /*@ assert Value: mem_access: \valid_read(p+1); */
    /*@ assert Value: mem_access: \valid_read(p+(int)(397-624)); */
    *p = p[M-N] ^ TWIST(p[0], p[1]);
  }

  /*@ assert Value: mem_access: \valid(p); */
  /*@ assert Value: mem_access: \valid_read(p+(int)(397-624)); */
  *p = p[M-N] ^ TWIST(p[0], state[0]);
}

/** generates a random number on [0,0xffffffff]-interval */
unsigned long potion_rand_int(void) {
  unsigned long y;

  if (--left == 0) next_state();
  y = *next++;

  /* Tempering */
  y ^= (y >> 11);
  y ^= (y << 7) & 0x9d2c5680UL;
  y ^= (y << 15) & 0xefc60000UL;
  y ^= (y >> 18);

  return y;
}

/** generates a random number on [0,1) with 53-bit resolution*/
double potion_rand_double(void) {
  unsigned long a=potion_rand_int()>>5, b=potion_rand_int()>>6; 
  return(a*67108864.0+b)*(1.0/9007199254740992.0); 
} 
/**\memberof Lobby
  "srand" initialize random seed
 \param seed PNInteger
 \return Lobby (usually unused)
 \sa potion_rand. */
PN potion_srand(Potion *P, PN cl, PN self, PN seed) {
  init_genrand(PN_INT(seed));
  return self;
}

/**\memberof Lobby
  "rand" generate random ulong number
  \code rand #=> xxxxxx \endcode
 \return PNDouble in [0,0xffffffff]-interval
 \sa potion_num_rand for double, potion_srand. */
PN potion_rand(Potion *P, PN cl, PN self) {
  return PN_NUM(potion_rand_int());
}

/**\memberof PNInteger
  "rand" generate random float number
  \code 1 rand #=> 0.xxxxxx \endcode
 \return PNDouble in [0.0,0.1]-interval
 \sa potion_rand for long, potion_srand. */
PN potion_num_rand(Potion *P, PN cl, PN self) {
  return PN_NUM(potion_rand_double());
}

/* [<][>][^][v][top][bottom][index][help] */