randlib: Fixed bug #8560
[scilab.git] / scilab / modules / randlib / src / c / mt.c
1 /*
2  * 
3  * Copyright (C) 2010 - DIGITEO - Michael Baudin
4  * Copyright (C) 2005 - Bruno Pincon
5  * Copyright (C) 2002 - Bruno Pincon
6  * Copyright (C) 1997, 1999 - Makoto Matsumoto and Takuji Nishimura
7  * 
8  A C-program for MT19937: Integer version (1999/10/28)          
9 */
10 /*  genrand() generates one pseudorandom unsigned int (32bit) */
11 /* which is uniformly distributed among 0 to 2^32-1  for each     */
12 /* call. sgenrand(seed) sets initial values to the working area   */
13 /* of 624 words. Before genrand(), sgenrand(seed) must be         */
14 /* called once. (seed is any 32-bit integer.)                     */
15 /*   Coded by Takuji Nishimura, considering the suggestions by    */
16 /* Topher Cooper and Marc Rieffel in July-Aug. 1997.              */
17
18 /* This library is free software under the Artistic license:       */
19 /* see the file COPYING distributed together with this code.       */
20 /* For the verification of the code, its output sequence file      */
21 /* mt19937int.out is attached (2001/4/2)                           */
22
23 /* Any feedback is very welcome. For any question, comments,       */
24 /* see http://www.math.keio.ac.jp/matumoto/emt.html or email       */
25 /* matumoto@math.keio.ac.jp                                        */
26
27 /* REFERENCE                                                       */
28 /* M. Matsumoto and T. Nishimura,                                  */
29 /* "Mersenne Twister: A 623-Dimensionally Equidistributed Uniform  */
30 /* Pseudo-Random Number Generator",                                */
31 /* ACM Transactions on Modeling and Computer Simulation,           */
32 /* Vol. 8, No. 1, January 1998, pp 3--30.                          */
33
34
35 /*   
36  *  NOTES
37  *    slightly modified par Bruno Pincon for inclusion in scilab 
38  *      - names have changed (for uniformity with the others genators)
39  *      - add get state routine
40  *      - add a little verif when the state is changed with the simple
41  *        procedure
42  *
43  *     furthers modifications on May 25 2002 :
44  *
45  *     1/ corrections of the followings : 
46  *        
47  *        bug 1 : the complete state was returned at the scilab level
48  *                without the index mti. Now the complete state is a 
49  *                vector of dim 625 with mti as the first component
50  *        bug 2 : the set_state doesn't work if the generator was not
51  *                initialised => add a is_init var and returned
52  *                the state given with the default initialisation.
53  *
54  *     2/ Following the modif in the new version of this generator I have
55  *       changed the simple initialisation (but not put the init via array)
56  *
57  *     Sept 2005 : fix for bug 1568
58  */
59
60 #include <math.h>
61 #include "grand.h"            /* to check prototypes */
62 #include "sciprint.h"
63 #include "others_generators.h"
64 #include "localization.h"
65
66 /* Period parameters */  
67 #define N 624
68 #define M 397
69 #define MATRIX_A 0x9908b0df   /* constant vector a */
70 #define UPPER_MASK 0x80000000 /* most significant w-r bits */
71 #define LOWER_MASK 0x7fffffff /* least significant r bits */
72
73 /* Tempering parameters */   
74 #define TEMPERING_MASK_B 0x9d2c5680
75 #define TEMPERING_MASK_C 0xefc60000
76 #define TEMPERING_SHIFT_U(y)  (y >> 11)
77 #define TEMPERING_SHIFT_S(y)  (y << 7)
78 #define TEMPERING_SHIFT_T(y)  (y << 15)
79 #define TEMPERING_SHIFT_L(y)  (y >> 18)
80
81 static unsigned int mt[N]; /* the array for the state vector  */
82 static int mti=N;
83 static int is_init=0;  
84 static double DEFAULT_SEED=5489.0;
85
86 unsigned int randmt()
87 {
88     unsigned int y;
89     static unsigned int mag01[2]={0x0, MATRIX_A};
90     /* mag01[x] = x * MATRIX_A  for x=0,1 */
91
92     if (mti >= N) { /* generate N words at one time */
93         int kk;
94
95         if ( ! is_init )
96             set_state_mt_simple(DEFAULT_SEED);
97
98         for (kk=0;kk<N-M;kk++) {
99             y = (mt[kk]&UPPER_MASK)|(mt[kk+1]&LOWER_MASK);
100             mt[kk] = mt[kk+M] ^ (y >> 1) ^ mag01[y & 0x1];
101         }
102         for (;kk<N-1;kk++) {
103             y = (mt[kk]&UPPER_MASK)|(mt[kk+1]&LOWER_MASK);
104             mt[kk] = mt[kk+(M-N)] ^ (y >> 1) ^ mag01[y & 0x1];
105         }
106         y = (mt[N-1]&UPPER_MASK)|(mt[0]&LOWER_MASK);
107         mt[N-1] = mt[M-1] ^ (y >> 1) ^ mag01[y & 0x1];
108
109         mti = 0;
110     }
111
112     y = mt[mti++];
113     y ^= TEMPERING_SHIFT_U(y);
114     y ^= TEMPERING_SHIFT_S(y) & TEMPERING_MASK_B;
115     y ^= TEMPERING_SHIFT_T(y) & TEMPERING_MASK_C;
116     y ^= TEMPERING_SHIFT_L(y);
117
118     return ( y );
119 }
120
121
122 int set_state_mt_simple(double s)
123 {
124     /*   set the initial state with the simple procedure  */
125     unsigned int seed;
126
127     if ( s == floor(s) && 0.0 <= s && s <= 4294967295.0)
128     {
129         seed = (unsigned int) s;
130         mt[0]= seed & 0xffffffff;
131         for (mti=1; mti<N; mti++)
132         {
133             mt[mti] =  (1812433253UL * (mt[mti-1] ^ (mt[mti-1] >> 30)) + mti); 
134             /* See Knuth TAOCP Vol2. 3rd Ed. P.106 for multiplier. */
135             /* In the previous versions, MSBs of the seed affect   */
136             /* only MSBs of the array mt[].                        */
137             /* 2002/01/09 modified by Makoto Matsumoto             */
138             mt[mti] &= 0xffffffffUL;   /* for >32 bit machines */
139         }
140         is_init = 1;
141         return ( 1 );
142     }
143     else
144     {
145         sciprint(_("Bad seed for mt, must be an int in [0, 2^32-1]\n"));
146         return ( 0 );
147     }
148 }
149
150
151 /* 
152 *  Initialization by "set_state_simple_mt()" is an example. Theoretically,
153 *  there are 2^19937-1 possible states as an intial state.           
154 *   This function allows to choose any of 2^19937-1 ones.            
155 *   Essential bits in "seed_array[]" is following 19937 bits:        
156 *      (seed_array[0]&UPPER_MASK), seed_array[1], ..., seed_array[N-1].
157 *      (seed_array[0]&LOWER_MASK) is discarded.                         
158 *
159 *   Theoretically,                                                   
160 *      (seed_array[0]&UPPER_MASK), seed_array[1], ..., seed_array[N-1] 
161 *   can take any values except all zeros.                            
162 */
163
164 int set_state_mt(double seed_array[])
165
166 {
167     int i, mti_try;
168
169     mti_try = (int) seed_array[0];
170     if (mti_try < 1  ||  mti_try > 624)
171     {
172         sciprint(_("The first component of the mt state mt, must be an int in [1, 624]\n"));
173         return ( 0 );
174     }
175     is_init = 1;
176     mti = mti_try;
177     for (i=0;i<N;i++) 
178         mt[i] = ((unsigned int) seed_array[i+1]) & 0xffffffff;
179     return ( 1 );
180 }
181
182
183 /*  To return the state at the scilab level  */
184 void get_state_mt(double state[])
185 {
186     int i;
187
188     if ( ! is_init )
189         set_state_mt_simple(DEFAULT_SEED);
190
191     state[0] = (double) mti;
192     for (i=0;i<N;i++) 
193         state[i+1] = (double) mt[i];
194 }