BGE: bookmark option on controller to make them run before all other controllers.
[blender.git] / source / gameengine / GameLogic / SCA_RandomNumberGenerator.cpp
1 /**
2  * Generate random numbers that can be used by other components. We 
3  * convert to different types/distributions elsewhere. This just 
4  * delivers a clean, random bitvector.
5  *
6  * $Id$
7  */
8
9 /* A C-program for MT19937: Real number version                */
10 /*   genrand() generates one pseudorandom real number (double) */
11 /* which is uniformly distributed on [0,1]-interval, for each  */
12 /* call. sgenrand(seed) set 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 except for 0).     */
15 /* Integer generator is obtained by modifying two lines.       */
16 /*   Coded by Takuji Nishimura, considering the suggestions by */
17 /* Topher Cooper and Marc Rieffel in July-Aug. 1997.           */
18
19 /* This library is free software; you can redistribute it and/or   */
20 /* modify it under the terms of the GNU Library General Public     */
21 /* License as published by the Free Software Foundation; either    */
22 /* version 2 of the License, or (at your option) any later         */
23 /* version.                                                        */
24 /* This library is distributed in the hope that it will be useful, */
25 /* but WITHOUT ANY WARRANTY; without even the implied warranty of  */
26 /* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.            */
27 /* See the GNU Library General Public License for more details.    */
28 /* You should have received a copy of the GNU Library General      */
29 /* Public License along with this library; if not, write to the    */
30 /* Free Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA   */ 
31 /* 02111-1307  USA                                                 */
32
33 /* Copyright (C) 1997 Makoto Matsumoto and Takuji Nishimura.       */
34 /* When you use this, send an email to: matumoto@math.keio.ac.jp   */
35 /* with an appropriate reference to your work.                     */
36
37 #include <limits.h>
38 #include "SCA_RandomNumberGenerator.h"
39
40 #ifdef HAVE_CONFIG_H
41 #include <config.h>
42 #endif
43
44 /* Period parameters */  
45 #define N 624
46 #define M 397
47 #define MATRIX_A 0x9908b0df   /* constant vector a */
48 #define UPPER_MASK 0x80000000 /* most significant w-r bits */
49 #define LOWER_MASK 0x7fffffff /* least significant r bits */
50
51 /* Tempering parameters */   
52 #define TEMPERING_MASK_B 0x9d2c5680
53 #define TEMPERING_MASK_C 0xefc60000
54 #define TEMPERING_SHIFT_U(y)  (y >> 11)
55 #define TEMPERING_SHIFT_S(y)  (y << 7)
56 #define TEMPERING_SHIFT_T(y)  (y << 15)
57 #define TEMPERING_SHIFT_L(y)  (y >> 18)
58
59 SCA_RandomNumberGenerator::SCA_RandomNumberGenerator(long seed) {
60         // int mti = N + 1; /*unused*/
61         m_seed = seed;
62         SetStartVector();
63 }
64
65 SCA_RandomNumberGenerator::~SCA_RandomNumberGenerator() {
66         /* intentionally empty */
67 }
68
69 void SCA_RandomNumberGenerator::SetStartVector(void) {
70         /* setting initial seeds to mt[N] using         */
71     /* the generator Line 25 of Table 1 in          */
72     /* [KNUTH 1981, The Art of Computer Programming */
73     /*    Vol. 2 (2nd Ed.), pp102]                  */
74     mt[0] = m_seed & 0xffffffff;
75     for (mti = 1; mti < N; mti++)
76         mt[mti] = (69069 * mt[mti-1]) & 0xffffffff;
77 }
78
79 long SCA_RandomNumberGenerator::GetSeed() { return m_seed; }
80 void SCA_RandomNumberGenerator::SetSeed(long newseed) 
81
82         m_seed = newseed;
83         SetStartVector();
84 }
85
86 /**
87  * This is the important part: copied verbatim :)
88  */
89 unsigned long SCA_RandomNumberGenerator::Draw() {
90     static unsigned long mag01[2] = { 0x0, MATRIX_A };
91     /* mag01[x] = x * MATRIX_A  for x=0,1 */
92
93     unsigned long y;
94
95     if (mti >= N) { /* generate N words at one time */
96         int kk;
97
98         /* I set this in the constructor, so it is always satisfied ! */
99 //          if (mti == N+1)   /* if sgenrand() has not been called, */
100 //              GEN_srand(4357); /* a default initial seed is used   */
101         
102         for (kk = 0; kk < N - M; kk++) {
103             y = (mt[kk] & UPPER_MASK) | (mt[kk+1] & LOWER_MASK);
104             mt[kk] = mt[kk+M] ^ (y >> 1) ^ mag01[y & 0x1];
105         }
106         for (; kk < N-1; kk++) {
107             y = (mt[kk] & UPPER_MASK) | (mt[kk+1] & LOWER_MASK);
108             mt[kk] = mt[kk+(M-N)] ^ (y >> 1) ^ mag01[y & 0x1];
109         }
110         y = (mt[N-1] & UPPER_MASK) | (mt[0] & LOWER_MASK);
111         mt[N-1] = mt[M-1] ^ (y >> 1) ^ mag01[y & 0x1];
112
113         mti = 0;
114     }
115   
116     y = mt[mti++];
117     y ^= TEMPERING_SHIFT_U(y);
118     y ^= TEMPERING_SHIFT_S(y) & TEMPERING_MASK_B;
119     y ^= TEMPERING_SHIFT_T(y) & TEMPERING_MASK_C;
120     y ^= TEMPERING_SHIFT_L(y);
121
122     return y;
123 }
124
125 float SCA_RandomNumberGenerator::DrawFloat() {
126         return ( (float) Draw()/ (unsigned long) 0xffffffff );
127 }
128
129 /* eof */