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