Cleanup: remove redundant doxygen \file argument
[blender.git] / intern / smoke / intern / MERSENNETWISTER.h
1 /** \file \ingroup smoke
2  */
3 // MersenneTwister.h
4 // Mersenne Twister random number generator -- a C++ class MTRand
5 // Based on code by Makoto Matsumoto, Takuji Nishimura, and Shawn Cokus
6 // Richard J. Wagner  v1.0  15 May 2003  rjwagner@writeme.com
7
8 // The Mersenne Twister is an algorithm for generating random numbers.  It
9 // was designed with consideration of the flaws in various other generators.
10 // The period, 2^19937-1, and the order of equidistribution, 623 dimensions,
11 // are far greater.  The generator is also fast; it avoids multiplication and
12 // division, and it benefits from caches and pipelines.  For more information
13 // see the inventors' web page at http://www.math.keio.ac.jp/~matumoto/emt.html
14
15 // Reference
16 // M. Matsumoto and T. Nishimura, "Mersenne Twister: A 623-Dimensionally
17 // Equidistributed Uniform Pseudo-Random Number Generator", ACM Transactions on
18 // Modeling and Computer Simulation, Vol. 8, No. 1, January 1998, pp 3-30.
19
20 // Copyright (C) 1997 - 2002, Makoto Matsumoto and Takuji Nishimura,
21 // Copyright (C) 2000 - 2003, Richard J. Wagner
22 // All rights reserved.                          
23 //
24 // Redistribution and use in source and binary forms, with or without
25 // modification, are permitted provided that the following conditions
26 // are met:
27 //
28 //   1. Redistributions of source code must retain the above copyright
29 //      notice, this list of conditions and the following disclaimer.
30 //
31 //   2. Redistributions in binary form must reproduce the above copyright
32 //      notice, this list of conditions and the following disclaimer in the
33 //      documentation and/or other materials provided with the distribution.
34 //
35 //   3. The names of its contributors may not be used to endorse or promote 
36 //      products derived from this software without specific prior written 
37 //      permission.
38 //
39 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
40 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
41 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
42 // A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR
43 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
44 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
45 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
46 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
47 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
48 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
49 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
50
51 // The original code included the following notice:
52 //
53 //     When you use this, send an email to: matumoto@math.keio.ac.jp
54 //     with an appropriate reference to your work.
55 //
56 // It would be nice to CC: rjwagner@writeme.com and Cokus@math.washington.edu
57 // when you write.
58
59 #ifndef MERSENNETWISTER_H
60 #define MERSENNETWISTER_H
61
62 // Not thread safe (unless auto-initialization is avoided and each thread has
63 // its own MTRand object)
64
65 #include <iostream>
66 #include <limits.h>
67 #include <stdio.h>
68 #include <time.h>
69 #include <math.h>
70
71 class MTRand {
72 // Data
73 public:
74         typedef unsigned long uint32;  // unsigned integer type, at least 32 bits
75         
76         enum { N = 624 };       // length of state vector
77         enum { SAVE = N + 1 };  // length of array for save()
78
79 protected:
80         enum { M = 397 };  // period parameter
81         
82         uint32 state[N];   // internal state
83         uint32 *pNext;     // next value to get from state
84         int left;          // number of values left before reload needed
85
86
87 //Methods
88 public:
89         MTRand( const uint32& oneSeed );  // initialize with a simple uint32
90         MTRand( uint32 *const bigSeed, uint32 const seedLength = N );  // or an array
91         MTRand();  // auto-initialize with /dev/urandom or time() and clock()
92         
93         // Do NOT use for CRYPTOGRAPHY without securely hashing several returned
94         // values together, otherwise the generator state can be learned after
95         // reading 624 consecutive values.
96         
97         // Access to 32-bit random numbers
98         double rand();                          // real number in [0,1]
99         double rand( const double& n );         // real number in [0,n]
100         double randExc();                       // real number in [0,1)
101         double randExc( const double& n );      // real number in [0,n)
102         double randDblExc();                    // real number in (0,1)
103         double randDblExc( const double& n );   // real number in (0,n)
104         uint32 randInt();                       // integer in [0,2^32-1]
105         uint32 randInt( const uint32& n );      // integer in [0,n] for n < 2^32
106         double operator()() { return rand(); }  // same as rand()
107         
108         // Access to 53-bit random numbers (capacity of IEEE double precision)
109         double rand53();  // real number in [0,1)
110         
111         // Access to nonuniform random number distributions
112         double randNorm( const double& mean = 0.0, const double& variance = 1.0 );
113         
114         // Re-seeding functions with same behavior as initializers
115         void seed( const uint32 oneSeed );
116         void seed( uint32 *const bigSeed, const uint32 seedLength = N );
117         void seed();
118         
119         // Saving and loading generator state
120         void save( uint32* saveArray ) const;  // to array of size SAVE
121         void load( uint32 *const loadArray );  // from such array
122         friend std::ostream& operator<<( std::ostream& os, const MTRand& mtrand );
123         friend std::istream& operator>>( std::istream& is, MTRand& mtrand );
124
125 protected:
126         void initialize( const uint32 oneSeed );
127         void reload();
128         uint32 hiBit( const uint32& u ) const { return u & 0x80000000UL; }
129         uint32 loBit( const uint32& u ) const { return u & 0x00000001UL; }
130         uint32 loBits( const uint32& u ) const { return u & 0x7fffffffUL; }
131         uint32 mixBits( const uint32& u, const uint32& v ) const
132                 { return hiBit(u) | loBits(v); }
133         uint32 twist( const uint32& m, const uint32& s0, const uint32& s1 ) const
134                 { return m ^ (mixBits(s0,s1)>>1) ^ ((~loBit(s1) + 1) & 0x9908b0dfUL); }
135         static uint32 hash( time_t t, clock_t c );
136 };
137
138
139 inline MTRand::MTRand( const uint32& oneSeed )
140         { seed(oneSeed); }
141
142 inline MTRand::MTRand( uint32 *const bigSeed, const uint32 seedLength )
143         { seed(bigSeed,seedLength); }
144
145 inline MTRand::MTRand()
146         { seed(); }
147
148 inline double MTRand::rand()
149         { return double(randInt()) * (1.0/4294967295.0); }
150
151 inline double MTRand::rand( const double& n )
152         { return rand() * n; }
153
154 inline double MTRand::randExc()
155         { return double(randInt()) * (1.0/4294967296.0); }
156
157 inline double MTRand::randExc( const double& n )
158         { return randExc() * n; }
159
160 inline double MTRand::randDblExc()
161         { return ( double(randInt()) + 0.5 ) * (1.0/4294967296.0); }
162
163 inline double MTRand::randDblExc( const double& n )
164         { return randDblExc() * n; }
165
166 inline double MTRand::rand53()
167 {
168         uint32 a = randInt() >> 5, b = randInt() >> 6;
169         return ( a * 67108864.0 + b ) * (1.0/9007199254740992.0);  // by Isaku Wada
170 }
171
172 inline double MTRand::randNorm( const double& mean, const double& variance )
173 {
174         // Return a real number from a normal (Gaussian) distribution with given
175         // mean and variance by Box-Muller method
176         double r = sqrt( -2.0 * log( 1.0-randDblExc()) ) * variance;
177         double phi = 2.0 * 3.14159265358979323846264338328 * randExc();
178         return mean + r * cos(phi);
179 }
180
181 inline MTRand::uint32 MTRand::randInt()
182 {
183         // Pull a 32-bit integer from the generator state
184         // Every other access function simply transforms the numbers extracted here
185         
186         if( left == 0 ) reload();
187         --left;
188                 
189         uint32 s1;
190         s1 = *pNext++;
191         s1 ^= (s1 >> 11);
192         s1 ^= (s1 <<  7) & 0x9d2c5680UL;
193         s1 ^= (s1 << 15) & 0xefc60000UL;
194         return ( s1 ^ (s1 >> 18) );
195 }
196
197 inline MTRand::uint32 MTRand::randInt( const uint32& n )
198 {
199         // Find which bits are used in n
200         // Optimized by Magnus Jonsson (magnus@smartelectronix.com)
201         uint32 used = n;
202         used |= used >> 1;
203         used |= used >> 2;
204         used |= used >> 4;
205         used |= used >> 8;
206         used |= used >> 16;
207         
208         // Draw numbers until one is found in [0,n]
209         uint32 i;
210         do
211                 i = randInt() & used;  // toss unused bits to shorten search
212         while( i > n );
213         return i;
214 }
215
216
217 inline void MTRand::seed( const uint32 oneSeed )
218 {
219         // Seed the generator with a simple uint32
220         initialize(oneSeed);
221         reload();
222 }
223
224
225 inline void MTRand::seed( uint32 *const bigSeed, const uint32 seedLength )
226 {
227         // Seed the generator with an array of uint32's
228         // There are 2^19937-1 possible initial states.  This function allows
229         // all of those to be accessed by providing at least 19937 bits (with a
230         // default seed length of N = 624 uint32's).  Any bits above the lower 32
231         // in each element are discarded.
232         // Just call seed() if you want to get array from /dev/urandom
233         initialize(19650218UL);
234         int i = 1;
235         uint32 j = 0;
236         int k = ( (uint32)N > seedLength ? (uint32)N : seedLength );
237         for( ; k; --k )
238         {
239                 state[i] =
240                         state[i] ^ ( (state[i-1] ^ (state[i-1] >> 30)) * 1664525UL );
241                 state[i] += ( bigSeed[j] & 0xffffffffUL ) + j;
242                 state[i] &= 0xffffffffUL;
243                 ++i;  ++j;
244                 if( i >= N ) { state[0] = state[N-1];  i = 1; }
245                 if( j >= seedLength ) j = 0;
246         }
247         for( k = N - 1; k; --k )
248         {
249                 state[i] =
250                         state[i] ^ ( (state[i-1] ^ (state[i-1] >> 30)) * 1566083941UL );
251                 state[i] -= i;
252                 state[i] &= 0xffffffffUL;
253                 ++i;
254                 if( i >= N ) { state[0] = state[N-1];  i = 1; }
255         }
256         state[0] = 0x80000000UL;  // MSB is 1, assuring non-zero initial array
257         reload();
258 }
259
260
261 inline void MTRand::seed()
262 {
263   // seed deterministically to produce reproducible runs
264   seed(123456);
265   
266   /*
267         // Seed the generator with an array from /dev/urandom if available
268         // Otherwise use a hash of time() and clock() values
269         
270         // First try getting an array from /dev/urandom
271         FILE* urandom = fopen( "/dev/urandom", "rb" );
272         if( urandom )
273         {
274                 uint32 bigSeed[N];
275                 uint32 *s = bigSeed;
276                 int i = N;
277                 bool success = true;
278                 while( success && i-- )
279                         success = fread( s++, sizeof(uint32), 1, urandom );
280                 fclose(urandom);
281                 if( success ) { seed( bigSeed, N );  return; }
282         }
283         
284         // Was not successful, so use time() and clock() instead
285         seed( hash( time(NULL), clock() ) );
286   */
287 }
288
289
290 inline void MTRand::initialize( const uint32 seed )
291 {
292         // Initialize generator state with seed
293         // See Knuth TAOCP Vol 2, 3rd Ed, p.106 for multiplier.
294         // In previous versions, most significant bits (MSBs) of the seed affect
295         // only MSBs of the state array.  Modified 9 Jan 2002 by Makoto Matsumoto.
296         uint32 *s = state;
297         uint32 *r = state;
298         int i = 1;
299         *s++ = seed & 0xffffffffUL;
300         for( ; i < N; ++i )
301         {
302                 *s++ = ( 1812433253UL * ( *r ^ (*r >> 30) ) + i ) & 0xffffffffUL;
303                 r++;
304         }
305 }
306
307
308 inline void MTRand::reload()
309 {
310         // Generate N new values in state
311         // Made clearer and faster by Matthew Bellew (matthew.bellew@home.com)
312         uint32 *p = state;
313         int i;
314         for( i = N - M; i--; ++p )
315                 *p = twist( p[M], p[0], p[1] );
316         for( i = M; --i; ++p )
317                 *p = twist( p[M-N], p[0], p[1] );
318         *p = twist( p[M-N], p[0], state[0] );
319
320         left = N, pNext = state;
321 }
322
323
324 inline MTRand::uint32 MTRand::hash( time_t t, clock_t c )
325 {
326         // Get a uint32 from t and c
327         // Better than uint32(x) in case x is floating point in [0,1]
328         // Based on code by Lawrence Kirby (fred@genesis.demon.co.uk)
329
330         static uint32 differ = 0;  // guarantee time-based seeds will change
331
332         uint32 h1 = 0;
333         unsigned char *p = (unsigned char *) &t;
334         for( size_t i = 0; i < sizeof(t); ++i )
335         {
336                 h1 *= UCHAR_MAX + 2U;
337                 h1 += p[i];
338         }
339         uint32 h2 = 0;
340         p = (unsigned char *) &c;
341         for( size_t j = 0; j < sizeof(c); ++j )
342         {
343                 h2 *= UCHAR_MAX + 2U;
344                 h2 += p[j];
345         }
346         return ( h1 + differ++ ) ^ h2;
347 }
348
349
350 inline void MTRand::save( uint32* saveArray ) const
351 {
352         uint32 *sa = saveArray;
353         const uint32 *s = state;
354         int i = N;
355         for( ; i--; *sa++ = *s++ ) {}
356         *sa = left;
357 }
358
359
360 inline void MTRand::load( uint32 *const loadArray )
361 {
362         uint32 *s = state;
363         uint32 *la = loadArray;
364         int i = N;
365         for( ; i--; *s++ = *la++ ) {}
366         left = *la;
367         pNext = &state[N-left];
368 }
369
370
371 inline std::ostream& operator<<( std::ostream& os, const MTRand& mtrand )
372 {
373         const MTRand::uint32 *s = mtrand.state;
374         int i = mtrand.N;
375         for( ; i--; os << *s++ << "\t" ) {}
376         return os << mtrand.left;
377 }
378
379
380 inline std::istream& operator>>( std::istream& is, MTRand& mtrand )
381 {
382         MTRand::uint32 *s = mtrand.state;
383         int i = mtrand.N;
384         for( ; i--; is >> *s++ ) {}
385         is >> mtrand.left;
386         mtrand.pNext = &mtrand.state[mtrand.N-mtrand.left];
387         return is;
388 }
389
390 #endif  // MERSENNETWISTER_H
391
392 // Change log:
393 //
394 // v0.1 - First release on 15 May 2000
395 //      - Based on code by Makoto Matsumoto, Takuji Nishimura, and Shawn Cokus
396 //      - Translated from C to C++
397 //      - Made completely ANSI compliant
398 //      - Designed convenient interface for initialization, seeding, and
399 //        obtaining numbers in default or user-defined ranges
400 //      - Added automatic seeding from /dev/urandom or time() and clock()
401 //      - Provided functions for saving and loading generator state
402 //
403 // v0.2 - Fixed bug which reloaded generator one step too late
404 //
405 // v0.3 - Switched to clearer, faster reload() code from Matthew Bellew
406 //
407 // v0.4 - Removed trailing newline in saved generator format to be consistent
408 //        with output format of built-in types
409 //
410 // v0.5 - Improved portability by replacing static const int's with enum's and
411 //        clarifying return values in seed(); suggested by Eric Heimburg
412 //      - Removed MAXINT constant; use 0xffffffffUL instead
413 //
414 // v0.6 - Eliminated seed overflow when uint32 is larger than 32 bits
415 //      - Changed integer [0,n] generator to give better uniformity
416 //
417 // v0.7 - Fixed operator precedence ambiguity in reload()
418 //      - Added access for real numbers in (0,1) and (0,n)
419 //
420 // v0.8 - Included time.h header to properly support time_t and clock_t
421 //
422 // v1.0 - Revised seeding to match 26 Jan 2002 update of Nishimura and Matsumoto
423 //      - Allowed for seeding with arrays of any length
424 //      - Added access for real numbers in [0,1) with 53-bit resolution
425 //      - Added access for real numbers from normal (Gaussian) distributions
426 //      - Increased overall speed by optimizing twist()
427 //      - Doubled speed of integer [0,n] generation
428 //      - Fixed out-of-range number generation on 64-bit machines
429 //      - Improved portability by substituting literal constants for long enum's
430 //      - Changed license from GNU LGPL to BSD
431