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