util/mt19937ar.c

   1 /*
   2    A C-program for MT19937, with initialization improved 2002/1/26.
   3    Coded by Takuji Nishimura and Makoto Matsumoto.
   4
   5    Before using, initialize the state by using nlopt_init_genrand(seed)
   6    or nlopt_init_by_array(init_key, key_length).
   7
   8    Copyright (C) 1997 - 2002, Makoto Matsumoto and Takuji Nishimura,
   9    All rights reserved.
  10
  11    Modified 2007 by Steven G. Johnson for use with NLopt (to avoid
  12    namespace pollution, use uint32_t instead of unsigned long,
  13    and add the urand function).  Modified 2009 to add normal-distributed
  14    random numbers.
  15
  16    Redistribution and use in source and binary forms, with or without
  17    modification, are permitted provided that the following conditions
  18    are met:
  19
  20      1. Redistributions of source code must retain the above copyright
  21         notice, this list of conditions and the following disclaimer.
  22
  23      2. Redistributions in binary form must reproduce the above copyright
  24         notice, this list of conditions and the following disclaimer in the
  25         documentation and/or other materials provided with the distribution.
  26
  27      3. The names of its contributors may not be used to endorse or promote
  28         products derived from this software without specific prior written
  29         permission.
  30
  31    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  32    "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  33    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  34    FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
  35    COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  36    INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  37    (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  38    SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  39    HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  40    STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  41    ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
  42    OF THE POSSIBILITY OF SUCH DAMAGE.
  43
  44
  45    Any feedback is very welcome.
  46    http://www.math.sci.hiroshima-u.ac.jp/~m-mat/MT/emt.html
  47    email: m-mat @ math.sci.hiroshima-u.ac.jp (remove space)
  48 */
  49
  50 #include "nlopt-util.h"
  51
  52 #if defined(HAVE_STDINT_H)
  53 #  include <stdint.h>
  54 #endif
  55
  56 #ifndef HAVE_UINT32_T
  57 #  if SIZEOF_UNSIGNED_LONG == 4
  58       typedef unsigned long uint32_t;
  59 #  elif SIZEOF_UNSIGNED_INT == 4
  60       typedef unsigned int uint32_t;
  61 #  else
  62 #    error No 32-bit unsigned integer type
  63 #  endif
  64 #endif
  65
  66 /* Period parameters */
  67 #define N 624
  68 #define M 397
  69 #define MATRIX_A 0x9908b0dfUL   /* constant vector a */
  70 #define UPPER_MASK 0x80000000UL /* most significant w-r bits */
  71 #define LOWER_MASK 0x7fffffffUL /* least significant r bits */
  72
  73 /* SGJ 2010: make RNG thread-safe by declaring the RNG state as thread-local
  74    storage, at least for GCC, MSVC, and Intel C++ */
  75
  76 static THREADLOCAL uint32_t mt[N]; /* the array for the state vector  */
  77 static THREADLOCAL int mti=N+1; /* mti==N+1 means mt[N] is not initialized */
  78
  79 /* initializes mt[N] with a seed */
  80 void nlopt_init_genrand(unsigned long s)
  81 {
  82     mt[0]= s & 0xffffffffUL;
  83     for (mti=1; mti<N; mti++) {
  84         mt[mti] =
  85             (1812433253UL * (mt[mti-1] ^ (mt[mti-1] >> 30)) + mti);
  86         /* See Knuth TAOCP Vol2. 3rd Ed. P.106 for multiplier. */
  87         /* In the previous versions, MSBs of the seed affect   */
  88         /* only MSBs of the array mt[].                        */
  89         /* 2002/01/09 modified by Makoto Matsumoto             */
  90         mt[mti] &= 0xffffffffUL;
  91         /* for >32 bit machines */
  92     }
  93 }
  94
  95 /* generates a random number on [0,0xffffffff]-interval */
  96 static uint32_t nlopt_genrand_int32(void)
  97 {
  98     uint32_t y;
  99     static uint32_t mag01[2]={0x0UL, MATRIX_A};
 100     /* mag01[x] = x * MATRIX_A  for x=0,1 */
 101
 102     if (mti >= N) { /* generate N words at one time */
 103         int kk;
 104
 105         if (mti == N+1)   /* if init_genrand() has not been called, */
 106             nlopt_init_genrand(5489UL); /* a default initial seed is used */
 107
 108         for (kk=0;kk<N-M;kk++) {
 109             y = (mt[kk]&UPPER_MASK)|(mt[kk+1]&LOWER_MASK);
 110             mt[kk] = mt[kk+M] ^ (y >> 1) ^ mag01[y & 0x1UL];
 111         }
 112         for (;kk<N-1;kk++) {
 113             y = (mt[kk]&UPPER_MASK)|(mt[kk+1]&LOWER_MASK);
 114             mt[kk] = mt[kk+(M-N)] ^ (y >> 1) ^ mag01[y & 0x1UL];
 115         }
 116         y = (mt[N-1]&UPPER_MASK)|(mt[0]&LOWER_MASK);
 117         mt[N-1] = mt[M-1] ^ (y >> 1) ^ mag01[y & 0x1UL];
 118
 119         mti = 0;
 120     }
 121
 122     y = mt[mti++];
 123
 124     /* Tempering */
 125     y ^= (y >> 11);
 126     y ^= (y << 7) & 0x9d2c5680UL;
 127     y ^= (y << 15) & 0xefc60000UL;
 128     y ^= (y >> 18);
 129
 130     return y;
 131 }
 132
 133 #if 0 /* not used in NLopt */
 134
 135 /* initialize by an array with array-length */
 136 /* init_key is the array for initializing keys */
 137 /* key_length is its length */
 138 /* slight change for C++, 2004/2/26 */
 139 static void nlopt_init_by_array(uint32_t init_key[], int key_length)
 140 {
 141     int i, j, k;
 142     nlopt_init_genrand(19650218UL);
 143     i=1; j=0;
 144     k = (N>key_length ? N : key_length);
 145     for (; k; k--) {
 146         mt[i] = (mt[i] ^ ((mt[i-1] ^ (mt[i-1] >> 30)) * 1664525UL))
 147           + init_key[j] + j; /* non linear */
 148         mt[i] &= 0xffffffffUL; /* for WORDSIZE > 32 machines */
 149         i++; j++;
 150         if (i>=N) { mt[0] = mt[N-1]; i=1; }
 151         if (j>=key_length) j=0;
 152     }
 153     for (k=N-1; k; k--) {
 154         mt[i] = (mt[i] ^ ((mt[i-1] ^ (mt[i-1] >> 30)) * 1566083941UL))
 155           - i; /* non linear */
 156         mt[i] &= 0xffffffffUL; /* for WORDSIZE > 32 machines */
 157         i++;
 158         if (i>=N) { mt[0] = mt[N-1]; i=1; }
 159     }
 160
 161     mt[0] = 0x80000000UL; /* MSB is 1; assuring non-zero initial array */
 162 }
 163
 164 /* generates a random number on [0,0x7fffffff]-interval */
 165 static long nlopt_genrand_int31(void)
 166 {
 167     return (long)(nlopt_genrand_int32()>>1);
 168 }
 169
 170 /* generates a random number on [0,1]-real-interval */
 171 static double nlopt_genrand_real1(void)
 172 {
 173     return nlopt_genrand_int32()*(1.0/4294967295.0);
 174     /* divided by 2^32-1 */
 175 }
 176
 177 /* generates a random number on [0,1)-real-interval */
 178 static double nlopt_genrand_real2(void)
 179 {
 180     return nlopt_genrand_int32()*(1.0/4294967296.0);
 181     /* divided by 2^32 */
 182 }
 183
 184 /* generates a random number on (0,1)-real-interval */
 185 static double nlopt_genrand_real3(void)
 186 {
 187     return (((double)nlopt_genrand_int32()) + 0.5)*(1.0/4294967296.0);
 188     /* divided by 2^32 */
 189 }
 190
 191 #endif
 192
 193 /* generates a random number on [0,1) with 53-bit resolution*/
 194 static double nlopt_genrand_res53(void)
 195 {
 196     uint32_t a=nlopt_genrand_int32()>>5, b=nlopt_genrand_int32()>>6;
 197     return(a*67108864.0+b)*(1.0/9007199254740992.0);
 198 }
 199 /* These real versions are due to Isaku Wada, 2002/01/09 added */
 200
 201 /* generate uniform random number in [a,b) with 53-bit resolution,
 202    added by SGJ */
 203 double nlopt_urand(double a, double b)
 204 {
 205      return(a + (b - a) * nlopt_genrand_res53());
 206 }
 207
 208 /* generate a uniform random number in [0,n), added by SGJ */
 209 int nlopt_iurand(int n)
 210 {
 211      return(nlopt_genrand_int32() % n);
 212 }
 213
 214 /* normal-distributed random numbers with the given mean and std. deviation,
 215    added by SGJ */
 216 double nlopt_nrand(double mean, double stddev)
 217 {
 218   /* Box-Muller algorithm to generate Gaussian from uniform
 219      see Knuth vol II algorithm P, sec. 3.4.1 */
 220   double v1, v2, s;
 221   do {
 222     v1 = nlopt_urand(-1, 1);
 223     v2 = nlopt_urand(-1, 1);
 224     s = v1*v1 + v2*v2;
 225   } while (s >= 1.0);
 226   if (s == 0) {
 227     return mean;
 228   }
 229   else {
 230     return mean + v1 * sqrt(-2 * log(s) / s) * stddev;
 231   }
 232 }