BrookRandomNumberGenerator.cpp 38.7 KB
Newer Older
Mark Friedrichs's avatar
Mark Friedrichs committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
/* -------------------------------------------------------------------------- *
 *                                   OpenMM                                   *
 * -------------------------------------------------------------------------- *
 * This is part of the OpenMM molecular simulation toolkit originating from   *
 * Simbios, the NIH National Center for Physics-Based Simulation of           *
 * Biological Structures at Stanford, funded under the NIH Roadmap for        *
 * Medical Research, grant U54 GM072970. See https://simtk.org.               *
 *                                                                            *
 * Portions copyright (c) 2008 Stanford University and the Authors.           *
 * Authors: Mark Friedrichs                                                   *
 * Contributors:                                                              *
 *                                                                            *
 * Permission is hereby granted, free of charge, to any person obtaining a    *
 * copy of this software and associated documentation files (the "Software"), *
 * to deal in the Software without restriction, including without limitation  *
 * the rights to use, copy, modify, merge, publish, distribute, sublicense,   *
 * and/or sell copies of the Software, and to permit persons to whom the      *
 * Software is furnished to do so, subject to the following conditions:       *
 *                                                                            *
 * The above copyright notice and this permission notice shall be included in *
 * all copies or substantial portions of the Software.                        *
 *                                                                            *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR *
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,   *
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL    *
 * THE AUTHORS, CONTRIBUTORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,    *
 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR      *
 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE  *
 * USE OR OTHER DEALINGS IN THE SOFTWARE.                                     *
 * -------------------------------------------------------------------------- */

#include <sstream>
#include "BrookRandomNumberGenerator.h"
Mark Friedrichs's avatar
Mods  
Mark Friedrichs committed
34
#include "../../reference/src/SimTKUtilities/SimTKOpenMMUtilities.h"
Mark Friedrichs's avatar
Mark Friedrichs committed
35
#include "OpenMMException.h"
Mark Friedrichs's avatar
Mods  
Mark Friedrichs committed
36
#include "gpu/kupdatesd.h"
Mark Friedrichs's avatar
Mark Friedrichs committed
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57

using namespace OpenMM;
using namespace std;

/** 
 *
 * Constructor
 * 
 */

BrookRandomNumberGenerator::BrookRandomNumberGenerator( ){

// ---------------------------------------------------------------------------------------

   //static const std::string methodName      = "BrookRandomNumberGenerator::BrookRandomNumberGenerator";

// ---------------------------------------------------------------------------------------

   // fixed for now

   _numberOfRandomNumberStreams     = 2;
Mark Friedrichs's avatar
Mark Friedrichs committed
58
   _randomNumberGeneratorStreams    = NULL;
Mark Friedrichs's avatar
Mark Friedrichs committed
59
60
61
62
63
64
65

   // mark stream dimension variables as unset

   _randomNumberStreamWidth         = -1;
   _randomNumberStreamHeight        = -1;
   _randomNumberStreamSize          = -1;

Mark Friedrichs's avatar
Mark Friedrichs committed
66
67
68
   _rvStreamIndex                   = 0;
   _rvStreamOffset                  = 0;
   _numberOfShuffles                = 0;
Mark Friedrichs's avatar
Mods  
Mark Friedrichs committed
69
70
   //_maxShuffles                     = 0;
   _maxShuffles                     = 100;
Mark Friedrichs's avatar
Mark Friedrichs committed
71
72
73
74

   _loadBuffer                      = NULL;
   _shuffleIndices                  = NULL;

Mark Friedrichs's avatar
Mark Friedrichs committed
75
   for( int ii = 0; ii < LastStreamIndex; ii++ ){
Mark Friedrichs's avatar
Mark Friedrichs committed
76
      _auxiliaryStreams[ii]   = NULL;
Mark Friedrichs's avatar
Mark Friedrichs committed
77
78
79
80
   }

   // set randomNumber seed 

Mark Friedrichs's avatar
Mods  
Mark Friedrichs committed
81
   _randomNumberSeed      = 1393;
Mark Friedrichs's avatar
Mods  
Mark Friedrichs committed
82
   //_randomNumberGenerator = Mersenne;
Mark Friedrichs's avatar
Mods  
Mark Friedrichs committed
83
   _randomNumberGenerator = Kiss;
Mark Friedrichs's avatar
Mark Friedrichs committed
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101

   //SimTKOpenMMUtilities::setRandomNumberSeed( randomNumberSeed );
}   
 
/** 
 * Destructor
 * 
 */

BrookRandomNumberGenerator::~BrookRandomNumberGenerator( ){

// ---------------------------------------------------------------------------------------

   //static const std::string methodName      = "BrookRandomNumberGenerator::~BrookRandomNumberGenerator";

// ---------------------------------------------------------------------------------------

   for( int ii = 0; ii < LastStreamIndex; ii++ ){
Mark Friedrichs's avatar
Mark Friedrichs committed
102
      delete _auxiliaryStreams[ii];
Mark Friedrichs's avatar
Mark Friedrichs committed
103
104
   }

Mark Friedrichs's avatar
Mark Friedrichs committed
105
106
107
108
   delete[] _randomNumberGeneratorStreams;

   delete[] _loadBuffer;
   delete[] _shuffleIndices;
Mark Friedrichs's avatar
Mark Friedrichs committed
109
110
111
112
113
114
115
116
117
118
119
120
121
122
}

/** 
 * Get number of random number streams
 * 
 * @return     number of random number streams 
 *
 */

int BrookRandomNumberGenerator::getNumberOfRandomNumberStreams( void ) const {
   return _numberOfRandomNumberStreams;
}

/** 
Mark Friedrichs's avatar
Mark Friedrichs committed
123
 * Get random number stream width
Mark Friedrichs's avatar
Mark Friedrichs committed
124
 * 
Mark Friedrichs's avatar
Mark Friedrichs committed
125
 * @return     nndom number stream width
Mark Friedrichs's avatar
Mark Friedrichs committed
126
127
128
 *
 */

Mark Friedrichs's avatar
Mark Friedrichs committed
129
130
int BrookRandomNumberGenerator::getRandomNumberStreamWidth( void ) const {
   return _randomNumberStreamWidth;
Mark Friedrichs's avatar
Mark Friedrichs committed
131
}
Mark Friedrichs's avatar
Mark Friedrichs committed
132
133
134
135
136
137
138
139
140
141
142
143

/** 
 * Get random number stream height
 * 
 * @return     nndom number stream height
 *
 */

int BrookRandomNumberGenerator::getRandomNumberStreamHeight( void ) const {
   return _randomNumberStreamHeight;
}

Mark Friedrichs's avatar
Mark Friedrichs committed
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
/** 
 * Get random number seed
 *
 * @return random number seed
 */
    
unsigned long int BrookRandomNumberGenerator::getRandomNumberSeed( void ) const {
   return _randomNumberSeed;
}
          
/** 
 * Increment random number seed
 *
 * @param increment    amount to increment random number seed; default = 1
 *
 * @return updated random number seed
 */
     
unsigned long int BrookRandomNumberGenerator::incrementRandomNumberSeed( unsigned long int  increment ){
   _randomNumberSeed += increment;
   return _randomNumberSeed;
}

/** 
 * Set random number seed
 *
 * @param new random number seed; default = 1
 *
 * @return random number seed
 */
    
Mark Friedrichs's avatar
Mark Friedrichs committed
175
176
unsigned long int BrookRandomNumberGenerator::setRandomNumberSeed( unsigned long int seed ){
   _randomNumberSeed  = seed;
Mark Friedrichs's avatar
Mark Friedrichs committed
177
178
179
180
181
182
183
184
185
186
187
188
   return _randomNumberSeed;
}

/** 
 * Generate a random number using algorithm in Gromacs
 * 
 * @param ig seed
 *
 * @return  random number
 *
 */

Mark Friedrichs's avatar
Mark Friedrichs committed
189
BrookOpenMMFloat BrookRandomNumberGenerator::_generateGromacsRandomNumber( unsigned long int* ig ){
Mark Friedrichs's avatar
Mark Friedrichs committed
190
191
192

   // ---------------------------------------------------------------------------------------

Mark Friedrichs's avatar
Mods  
Mark Friedrichs committed
193
   // static const std::string methodName = "\nBrookRandomNumberGenerator::_generateGromacsRandomNumber";
Mark Friedrichs's avatar
Mark Friedrichs committed
194
195
196
197
198
199
200
201
202
203
204
205
206

   int  irand;
 
   int  m     = 100000000;
   float rm   = 100000000.0;  /* same number as m, but real format */
   int  m1    = 10000;
   int  mult  = 31415821;
   
   BrookOpenMMFloat r;
   int  irandh,irandl,multh,multl;
 
   // ---------------------------------------------------------------------------------------
 
Mark Friedrichs's avatar
Mark Friedrichs committed
207
208
   unsigned long int igg = (*ig > 0) ? *ig : -1*(*ig);
   irand = igg % m; 
Mark Friedrichs's avatar
Mark Friedrichs committed
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
   
   /* multiply irand by mult, but take into account that overflow
    * must be discarded, and do not generate an error.
    */

   irandh = irand / m1;
   irandl = irand % m1;
   multh  = mult / m1;
   multl  = mult % m1;
   irand  = ((irandh*multl+irandl*multh) % m1) * m1 + irandl*multl;
   irand  = (irand + 1) % m; 
 
   /* convert irand to a real random number between 0 and 1. */

   r = (BrookOpenMMFloat) (irand / 10); 
   r = r * 10 / rm;
   if ((r <= 0) || (r > 1))
     r = 0.0; 
   *ig = irand;
   
   return r;
}     

inline int MaxInt( unsigned int x, unsigned int y ){ return x > y ? x : y; }

/** 
Mark Friedrichs's avatar
Mark Friedrichs committed
235
 * Generate a random number using algorithm in Kiss code
Mark Friedrichs's avatar
Mark Friedrichs committed
236
237
238
239
240
241
242
243
244
 * http://www.helsbreth.org/random/rng_kiss.html
 * 
 * @param randomV1   output random value
 * @param randomV2   output random value
 * @param randomV3   output random value
 * @param state      state
 *
 */

Mark Friedrichs's avatar
Mark Friedrichs committed
245
void BrookRandomNumberGenerator::_generateRandomsKiss( float* randomV1, float* randomV2, float* randomV3, 
Mark Friedrichs's avatar
Mods  
Mark Friedrichs committed
246
                                                       unsigned int state[4] ){
Mark Friedrichs's avatar
Mark Friedrichs committed
247
248
249
    
   // ---------------------------------------------------------------------------------------

Mark Friedrichs's avatar
Mods  
Mark Friedrichs committed
250
   // static const std::string methodName = "\nBrookRandomNumberGenerator::_generateRandomsKiss";
Mark Friedrichs's avatar
Mark Friedrichs committed
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352

   unsigned int carry          = 0;

   // ---------------------------------------------------------------------------------------
 
   state[0]             = state[0] * 69069 + 1;
   state[1]            ^= state[1] << 13;
   state[1]            ^= state[1] >> 17;
   state[1]            ^= state[1] << 5;
   unsigned int k       = (state[2] >> 2) + (state[3] >> 3) + (carry >> 2);
   unsigned int m       = state[3] + state[3] + state[2] + carry;
   state[2]             = state[3];
   state[3]             = m;
   carry                = k >> 30;
   unsigned int z1      = MaxInt(state[0] + state[1] + state[3], 0x00000001);
   float x1             = (float) ( (double) z1 / (double)UINT_MAX );

/*
if( x1 < 0.0f ){
   unsigned int z1 = MaxInt(state[0] + state[1] + state[3], 0x00000001);
   double       z2 = (double) z1/((double) UINT_MAX);
   (void) fprintf( logFile, "x1=%.6e state[%u %u %u] sum %u %.6e den=%u z2=%.6e\n",
                   x1, state[0], state[1], state[3], 
                   (state[0] + state[1] + state[3]), (float) (state[0] + state[1] + state[3]), z1, z2 );
}
*/

   state[0]             = state[0] * 69069 + 1;
   state[1]            ^= state[1] << 13;
   state[1]            ^= state[1] >> 17;
   state[1]            ^= state[1] << 5;
   x1                   = sqrt(-2.0f * log(x1));
   k                    = (state[2] >> 2) + (state[3] >> 3) + (carry >> 2);
   m                    = state[3] + state[3] + state[2] + carry;
   state[2]             = state[3];
   state[3]             = m;
   carry                = k >> 30;
   float x2             = (float)(state[0] + state[1] + state[3]) / (float)UINT_MAX;
   
   state[0]             = state[0] * 69069 + 1;
   state[1]            ^= state[1] << 13;
   state[1]            ^= state[1] >> 17;
   state[1]            ^= state[1] << 5;
   *randomV1            = x1 * cos(2.0f * 3.14159265f * x2);

   k                    = (state[2] >> 2) + (state[3] >> 3) + (carry >> 2);
   m                    = state[3] + state[3] + state[2] + carry;
   state[2]             = state[3];
   state[3]             = m;
   carry                = k >> 30;

   unsigned int z3      = MaxInt(state[0] + state[1] + state[3], 0x00000001);
   float x3             = (float) ( (double) z3 / (double)UINT_MAX );
   //float x3             = (float)MaxInt(state[0] + state[1] + state[3], 0x00000001) / (float)UINT_MAX;

   state[0]             = state[0] * 69069 + 1;
   state[1]            ^= state[1] << 13;
   state[1]            ^= state[1] >> 17;
   state[1]            ^= state[1] << 5;
   x3                   = sqrt(-2.0f * log(x3));
   k                    = (state[2] >> 2) + (state[3] >> 3) + (carry >> 2);
   m                    = state[3] + state[3] + state[2] + carry;
   state[2]             = state[3];
   state[3]             = m;
   carry                = k >> 30;
   float x4             = (float)(state[0] + state[1] + state[3]) / (float)UINT_MAX;
   
   state[0]             = state[0] * 69069 + 1;
   state[1]            ^= state[1] << 13;
   state[1]            ^= state[1] >> 17;
   state[1]            ^= state[1] << 5;
   *randomV2            = x3 * cos(2.0f * 3.14159265f * x4);
   k                    = (state[2] >> 2) + (state[3] >> 3) + (carry >> 2);
   m                    = state[3] + state[3] + state[2] + carry;
   state[2]             = state[3];
   state[3]             = m;
   carry                = k >> 30;

   //float x5             = (float)MaxInt(state[0] + state[1] + state[3], 0x00000001) / (float)UINT_MAX;
   unsigned int z5      = MaxInt(state[0] + state[1] + state[3], 0x00000001);
   float x5             = (float) ( (double) z5 / (double)UINT_MAX );

   state[0]             = state[0] * 69069 + 1;
   state[1]            ^= state[1] << 13;
   state[1]            ^= state[1] >> 17;
   state[1]            ^= state[1] << 5;
   x5                   = sqrt(-2.0f * log(x5));
   k                    = (state[2] >> 2) + (state[3] >> 3) + (carry >> 2);
   m                    = state[3] + state[3] + state[2] + carry;
   state[2]             = state[3];
   state[3]             = m;
   carry                = k >> 30;
   float x6             = (float)(state[0] + state[1] + state[3]) / (float)UINT_MAX;
   *randomV3            = x5 * cos(2.0f * 3.14159265f * x6); 
   
//(void) fprintf( logFile, "rv=%.6e %.6e %.6e\n", *randomV1, *randomV2, *randomV3 );
//exit(0);

   return;
}

/** 
Mark Friedrichs's avatar
Mark Friedrichs committed
353
 * Load random number streams using Kiss algorithm
Mark Friedrichs's avatar
Mark Friedrichs committed
354
355
356
357
358
 * 
 *
 * @return DefaultReturnValue;
 */

Mark Friedrichs's avatar
Mark Friedrichs committed
359
int BrookRandomNumberGenerator::_loadRandomNumberStreamsKiss( void ){
Mark Friedrichs's avatar
Mark Friedrichs committed
360
361
362
363
364

   // ---------------------------------------------------------------------------------------

   static unsigned int state[4];
   static int stateInitialized    = 0;
Mark Friedrichs's avatar
Mods  
Mark Friedrichs committed
365
366
   int printOn                    = 0;
   FILE* log;
Mark Friedrichs's avatar
Mods  
Mark Friedrichs committed
367
   static const int reseed        = 10000;
Mark Friedrichs's avatar
Mark Friedrichs committed
368
 
Mark Friedrichs's avatar
Mods  
Mark Friedrichs committed
369
   static std::string methodName  = "\nBrookRandomNumberGenerator::_loadRandomNumberStreamsKiss";
Mark Friedrichs's avatar
Mark Friedrichs committed
370
371
372

   // ---------------------------------------------------------------------------------------
   
Mark Friedrichs's avatar
Mods  
Mark Friedrichs committed
373
374
375
376
377
378
   if( printOn && getLog() ){
       log = getLog();
   } else {
      printOn = 0;
   }   

Mark Friedrichs's avatar
Mark Friedrichs committed
379
380
381
382
383
384
385
386
387
   // periodically reset seeds

   if( !stateInitialized || !(stateInitialized % reseed) ){

      state[0] = rand();
      state[1] = rand();
      state[2] = rand();
      state[3] = rand();

Mark Friedrichs's avatar
Mods  
Mark Friedrichs committed
388
389
      if( printOn ){
         (void) fprintf( log, "%s reset state seeds stateInitialized=%d reseed=%d [%u %u %u %u]\n",
Mark Friedrichs's avatar
Mods  
Mark Friedrichs committed
390
                         methodName.c_str(), stateInitialized, reseed,  state[0], state[1], state[2], state[3] );
Mark Friedrichs's avatar
Mods  
Mark Friedrichs committed
391
         (void) fflush( log );
Mark Friedrichs's avatar
Mark Friedrichs committed
392
393
394
395
396
397
398
399
400
401
402
403
404
405
      }

/*
state[0] = 9578;
state[1] = 29245;
state[2] = 16266;
state[3] = 27587;
*/

   }
   stateInitialized++;

   // allocate memory once for download of random nos.

Mark Friedrichs's avatar
Mark Friedrichs committed
406
   float* loadBuffer = _getLoadBuffer();
Mark Friedrichs's avatar
Mark Friedrichs committed
407

Mark Friedrichs's avatar
Mods  
Mark Friedrichs committed
408
   if( printOn ){
Mark Friedrichs's avatar
Mark Friedrichs committed
409
	   static float count   = 0.0f;
Mark Friedrichs's avatar
Mark Friedrichs committed
410
      float block          = (float) (3*getRandomNumberStreamSize() );
Mark Friedrichs's avatar
Mark Friedrichs committed
411
      count               += 1.0f;
Mark Friedrichs's avatar
Mods  
Mark Friedrichs committed
412
      (void) fprintf( log, "%s: count=%.1f ttl=%.3e no./count=%.1f %d %d\n", methodName.c_str(),
Mark Friedrichs's avatar
Mark Friedrichs committed
413
                      count, block*count, block, getRandomNumberStreamSize(), getNumberOfRandomNumberStreams() );
Mark Friedrichs's avatar
Mods  
Mark Friedrichs committed
414
      (void) fflush( log );
Mark Friedrichs's avatar
Mark Friedrichs committed
415
416
417
418
419
   }
	
   for( int jj = 0; jj < getNumberOfRandomNumberStreams(); jj++ ){
      for( int ii = 0; ii < 3*getRandomNumberStreamSize(); ii += 3 ){
         float v1,v2,v3;
Mark Friedrichs's avatar
Mark Friedrichs committed
420
421
422
423
         _generateRandomsKiss( &v1, &v2, &v3, state );
         loadBuffer[ii]   = v1;
         loadBuffer[ii+1] = v2;
         loadBuffer[ii+2] = v3;
Mark Friedrichs's avatar
Mark Friedrichs committed
424
   	}
Mark Friedrichs's avatar
Mark Friedrichs committed
425
	   getRandomNumberStream( jj )->loadFromArray( loadBuffer );
Mark Friedrichs's avatar
Mark Friedrichs committed
426
427
   }

Mark Friedrichs's avatar
Mods  
Mark Friedrichs committed
428
429
430
   if( printOn ){
      (void) fprintf( log, "%s: stats\n%s\n", methodName.c_str(), getStatisticsString().c_str() );
      (void) fflush( log );
Mark Friedrichs's avatar
Mods  
Mark Friedrichs committed
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
   }

   return DefaultReturnValue;
}


/** 
 * Load random number streams using Mersenne algorithm
 * 
 *
 * @return DefaultReturnValue;
 */

int BrookRandomNumberGenerator::_loadRandomNumberStreamsMersenne( void ){

   // ---------------------------------------------------------------------------------------

Mark Friedrichs's avatar
Mods  
Mark Friedrichs committed
448
   static const std::string methodName  = "\nBrookRandomNumberGenerator::_loadRandomNumberStreamsMersenne";
Mark Friedrichs's avatar
Mods  
Mark Friedrichs committed
449
450
   int printOn                          = 0;
   FILE* log;
Mark Friedrichs's avatar
Mods  
Mark Friedrichs committed
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466

   // ---------------------------------------------------------------------------------------
   
   // allocate memory once for download of random nos.

   float* loadBuffer = _getLoadBuffer();

   for( int jj = 0; jj < getNumberOfRandomNumberStreams(); jj++ ){
      for( int ii = 0; ii < 3*getRandomNumberStreamSize(); ii += 3 ){
         loadBuffer[ii]   = (float) SimTKOpenMMUtilities::getNormallyDistributedRandomNumber();
         loadBuffer[ii+1] = (float) SimTKOpenMMUtilities::getNormallyDistributedRandomNumber();
         loadBuffer[ii+2] = (float) SimTKOpenMMUtilities::getNormallyDistributedRandomNumber();
   	}
	   getRandomNumberStream( jj )->loadFromArray( loadBuffer );
   }

Mark Friedrichs's avatar
Mods  
Mark Friedrichs committed
467
468
469
   if( printOn ){
      (void) fprintf( log, "%s: stats\n%s\n", methodName.c_str(), getStatisticsString().c_str() );
      (void) fflush( log );
Mark Friedrichs's avatar
Mods  
Mark Friedrichs committed
470
471
   }

Mark Friedrichs's avatar
Mark Friedrichs committed
472
473
474
475
476
477
478
479
480
481
   return DefaultReturnValue;
}

/** 
 * Load random number streams using original gpu algorithm
 * 
 *
 * @return DefaultReturnValue;
 */

Mark Friedrichs's avatar
Mark Friedrichs committed
482
int BrookRandomNumberGenerator::_loadGVStreamsOriginal( void ){
Mark Friedrichs's avatar
Mark Friedrichs committed
483
484
485
486
487

   // ---------------------------------------------------------------------------------------

	unsigned long int jran;

Mark Friedrichs's avatar
Mods  
Mark Friedrichs committed
488
   // static const std::string methodName = "\nBrookRandomNumberGenerator::_loadGVStreamsOriginal";
Mark Friedrichs's avatar
Mark Friedrichs committed
489
490
491

   // ---------------------------------------------------------------------------------------
	
Mark Friedrichs's avatar
Mark Friedrichs committed
492
   float* loadBuffer = _getLoadBuffer();
Mark Friedrichs's avatar
Mods  
Mark Friedrichs committed
493
	jran              = getRandomNumberSeed();
Mark Friedrichs's avatar
Mark Friedrichs committed
494
495
	
   for( int jj = 0; jj < getNumberOfRandomNumberStreams(); jj++ ){
Mark Friedrichs's avatar
Mark Friedrichs committed
496
497
      for( int ii = 0; ii < 3*getRandomNumberStreamSize(); ii++ ){
			loadBuffer[ii] = _generateGromacsRandomNumber( &jran );
Mark Friedrichs's avatar
Mark Friedrichs committed
498
		}
Mark Friedrichs's avatar
Mark Friedrichs committed
499
	   getRandomNumberStream( jj )->loadFromArray( loadBuffer );
Mark Friedrichs's avatar
Mark Friedrichs committed
500
501
502
503
504
505
506
	}
	
   incrementRandomNumberSeed( 1 );

   return DefaultReturnValue;
}

Mark Friedrichs's avatar
Mark Friedrichs committed
507
508
509
510
511
512
513
514
515
516
517
518
519
/** 
 * Get load buffer
 *
 * @return ptr to load buffer
 *
 * @throw OpenMMException if rv stream size is < 1
 *
 **/

float* BrookRandomNumberGenerator::_getLoadBuffer( void ){

   // ---------------------------------------------------------------------------------------

Mark Friedrichs's avatar
Mods  
Mark Friedrichs committed
520
   static const std::string methodName = "\nBrookRandomNumberGenerator::_getLoadBuffer";
Mark Friedrichs's avatar
Mark Friedrichs committed
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551

   // ---------------------------------------------------------------------------------------
	
   if( getRandomNumberStreamSize() < 1 ){
      std::stringstream message;
      message << methodName << " rv stream size=" << getRandomNumberStreamSize() << " is less than 1.";
      throw OpenMMException( message.str() );
      return NULL;
   }

   if( _loadBuffer == NULL ){
   	_loadBuffer = (float*) malloc( sizeof(float)*3*getRandomNumberStreamSize() );
   }

   return _loadBuffer;

}	

/** 
 * Get ptr to shuffle indices
 *
 * @return ptr to shuffle indices
 *
 * @throw OpenMMException if size is < 1
 *
 **/

int* BrookRandomNumberGenerator::_getShuffleIndices( int size ){

   // ---------------------------------------------------------------------------------------

Mark Friedrichs's avatar
Mods  
Mark Friedrichs committed
552
   static const std::string methodName = "\nBrookRandomNumberGenerator::_getShuffleIndices";
Mark Friedrichs's avatar
Mark Friedrichs committed
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570

   // ---------------------------------------------------------------------------------------
	
   if( size < 1 ){
      std::stringstream message;
      message << methodName << " size=" << size << " is less than 1.";
      throw OpenMMException( message.str() );
      return NULL;
   }

   if( _shuffleIndices == NULL ){
   	_shuffleIndices = (int*) malloc( sizeof(int)*size );
   }

   return _shuffleIndices;

}	

Mark Friedrichs's avatar
Mark Friedrichs committed
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
/** 
 * Loads a permutation of indices from 0 to gvSize-1 in
 * sdp->strShuffle. To make sure that the order of the
 * permutation is atleast NGVSHUFFLE, we create the
 * permutation by introducing a random number of p-cycles
 * where p is randomly determined from 2,3,5,7 and 11.
 * The LCM of these numbers is 2310. 
 * Ofcourse the p-cycles are not necessarily disjoint
 * the way it's done here, but there's a good chance 
 * there will enough disjoint cycles to make the 
 * order of the permutation larger than NGVSHUFFLE
 *
 *
 * This function is only called once at startup
 *
 * @return DefaultReturnValue;
 **/

Mark Friedrichs's avatar
Mark Friedrichs committed
589
int BrookRandomNumberGenerator::_loadGVShuffle( void ){
Mark Friedrichs's avatar
Mark Friedrichs committed
590
591
592
593
594
595
596

   // ---------------------------------------------------------------------------------------

	const int p[] = { 2, 3, 5, 7, 11 };
	const int np  = sizeof(p) / sizeof(p[0]);
   const int pmax = p[np-1];

Mark Friedrichs's avatar
Mods  
Mark Friedrichs committed
597
   // static const std::string methodName = "\nBrookRandomNumberGenerator::loadGVShuffle";
Mark Friedrichs's avatar
Mark Friedrichs committed
598
599
600

   // ---------------------------------------------------------------------------------------
	
Mark Friedrichs's avatar
Mark Friedrichs committed
601
602
	float* loadBuffer  = _getLoadBuffer();
   int* indices       = _getShuffleIndices( pmax );
Mark Friedrichs's avatar
Mark Friedrichs committed
603
604
	
   int rvSize = getRandomNumberStreamSize();
Mark Friedrichs's avatar
Mark Friedrichs committed
605
606
	for ( int ii = 0; ii < rvSize; ii++ ) {
		loadBuffer[ii] = (float) ii;
Mark Friedrichs's avatar
Mark Friedrichs committed
607
608
609
610
611
	}

	//How to come up with this number here?

   unsigned long int seed = getRandomNumberSeed();
Mark Friedrichs's avatar
Mark Friedrichs committed
612
613
	for( int iter = 0; iter < 1000000; iter++ ) {

Mark Friedrichs's avatar
Mark Friedrichs committed
614
		//for each p
Mark Friedrichs's avatar
Mark Friedrichs committed
615
616
617

		for( int ii = 0; ii < np; ii++ ){

Mark Friedrichs's avatar
Mark Friedrichs committed
618
619
620
			//Come up with p random indices
			//Not checking that they are distinct
			//because that should be fairly rare
Mark Friedrichs's avatar
Mark Friedrichs committed
621
622

			for ( int jj = 0; jj < p[ii]; jj++ ) {
Mark Friedrichs's avatar
Mark Friedrichs committed
623
				//indices[j] = (int) ( gmx_rando( &sdp->seed ) * sdp->gvSize );
Mark Friedrichs's avatar
Mark Friedrichs committed
624
				indices[jj] = (int) ( _generateGromacsRandomNumber( &seed )*rvSize );
Mark Friedrichs's avatar
Mark Friedrichs committed
625
			}
Mark Friedrichs's avatar
Mark Friedrichs committed
626
627
628
629
630
631

			// do a p-cycle

			float tmp = loadBuffer[ indices[0] ];
			for ( int jj = 0; jj < p[ii]-1; jj++ ) {
				loadBuffer[ indices[jj] ] = loadBuffer[ indices[jj+1] ];
Mark Friedrichs's avatar
Mark Friedrichs committed
632
			}
Mark Friedrichs's avatar
Mark Friedrichs committed
633
			loadBuffer[ indices[ p[ii]-1 ] ] = tmp;
Mark Friedrichs's avatar
Mark Friedrichs committed
634
635
		}
	}
Mark Friedrichs's avatar
Mark Friedrichs committed
636
   _getShuffleStream()->loadFromArray( loadBuffer );
Mark Friedrichs's avatar
Mark Friedrichs committed
637
638
639
640
641
642
643
644
645
646
	
   return DefaultReturnValue;
}

/** 
 * Shuffle streams
 *
 * @return DefaultReturnValue;
 */

Mark Friedrichs's avatar
Mark Friedrichs committed
647
int BrookRandomNumberGenerator::_shuffleGVStreams( void ){
Mark Friedrichs's avatar
Mark Friedrichs committed
648
649
650

   // ---------------------------------------------------------------------------------------

Mark Friedrichs's avatar
Mods  
Mark Friedrichs committed
651
   // static const std::string methodName = "\nBrookRandomNumberGenerator::_shuffleGVStreams";
Mark Friedrichs's avatar
Mark Friedrichs committed
652
653
654
655

   // ---------------------------------------------------------------------------------------
	
   int numberOfRvStreams = getNumberOfRandomNumberStreams();
Mark Friedrichs's avatar
Mark Friedrichs committed
656

Mark Friedrichs's avatar
Mark Friedrichs committed
657
	for( int ii = 0; ii < numberOfRvStreams - 1; ii++ ){
Mark Friedrichs's avatar
Mark Friedrichs committed
658
659
660
661
		kpermute_vectors( (float) getRandomNumberStreamWidth(),
                         _getShuffleStream()->getBrookStream(),
                         getRandomNumberStream( ii + 1 )->getBrookStream(), 
                         getRandomNumberStream( ii  )->getBrookStream() );
Mark Friedrichs's avatar
Mark Friedrichs committed
662
663
   }

Mark Friedrichs's avatar
Mark Friedrichs committed
664
665
666
667
	kpermute_vectors( (float) getRandomNumberStreamWidth(),
                      _getShuffleStream()->getBrookStream(),
                      getRandomNumberStream( 0 )->getBrookStream(), 
                      getRandomNumberStream( numberOfRvStreams - 1 )->getBrookStream() );
Mark Friedrichs's avatar
Mark Friedrichs committed
668
669
670
671

   return DefaultReturnValue;
}

Mark Friedrichs's avatar
Mark Friedrichs committed
672
/** 
Mark Friedrichs's avatar
Mods  
Mark Friedrichs committed
673
 * Advances the current position by 2*gpu->particles
Mark Friedrichs's avatar
Mark Friedrichs committed
674
675
676
 * If we run out of rand numbers, we shuffle and 
 * reuse a few times before reloading from the cpu
 *
Mark Friedrichs's avatar
Mark Friedrichs committed
677
 * @param numberOfRandomValuesConsumedPerIteration    number of random values consumed/iteration
Mark Friedrichs's avatar
Mark Friedrichs committed
678
 *
Mark Friedrichs's avatar
Mark Friedrichs committed
679
 * @return DefaultReturnValue;
Mark Friedrichs's avatar
Mark Friedrichs committed
680
681
 */

Mark Friedrichs's avatar
Mark Friedrichs committed
682
int BrookRandomNumberGenerator::advanceGVCursor( int numberOfRandomValuesConsumedPerIteration ){
Mark Friedrichs's avatar
Mark Friedrichs committed
683
684
685

   // ---------------------------------------------------------------------------------------

Mark Friedrichs's avatar
Mods  
Mark Friedrichs committed
686
   static const std::string methodName = "BrookRandomNumberGenerator::advanceGVCursor";
Mark Friedrichs's avatar
Mods  
Mark Friedrichs committed
687
688
   int printOn                         = 0;
   FILE* log;
Mark Friedrichs's avatar
Mark Friedrichs committed
689
690

   // ---------------------------------------------------------------------------------------
Mark Friedrichs's avatar
Mark Friedrichs committed
691
	
Mark Friedrichs's avatar
Mods  
Mark Friedrichs committed
692
693
694
695
696
697
   if( printOn && getLog() ){
       log = getLog();
   } else {
      printOn = 0;
   }   

Mark Friedrichs's avatar
Mark Friedrichs committed
698
   int rvStreamSize  = getRandomNumberStreamSize();
Mark Friedrichs's avatar
Mark Friedrichs committed
699

Mark Friedrichs's avatar
Mark Friedrichs committed
700
   // use 2 random values per sd 
Mark Friedrichs's avatar
Mark Friedrichs committed
701

Mark Friedrichs's avatar
Mods  
Mark Friedrichs committed
702
	_rvStreamOffset  += numberOfRandomValuesConsumedPerIteration;
Mark Friedrichs's avatar
Mark Friedrichs committed
703

Mark Friedrichs's avatar
Mark Friedrichs committed
704
	//Check if we've used up this texture
Mark Friedrichs's avatar
Mark Friedrichs committed
705

Mark Friedrichs's avatar
Mark Friedrichs committed
706
	if ( _rvStreamOffset > rvStreamSize - numberOfRandomValuesConsumedPerIteration ){
Mark Friedrichs's avatar
Mark Friedrichs committed
707

Mark Friedrichs's avatar
Mods  
Mark Friedrichs committed
708
709
      char* action;

Mark Friedrichs's avatar
Mark Friedrichs committed
710
		// next one if available
Mark Friedrichs's avatar
Mark Friedrichs committed
711

Mark Friedrichs's avatar
Mark Friedrichs committed
712
      _rvStreamOffset = 0;
Mark Friedrichs's avatar
Mark Friedrichs committed
713

Mark Friedrichs's avatar
Mark Friedrichs committed
714
715
		if ( _rvStreamIndex < _numberOfRandomNumberStreams - 1 ){
         _rvStreamIndex++;
Mark Friedrichs's avatar
Mods  
Mark Friedrichs committed
716
         action = "incremented stream index";
Mark Friedrichs's avatar
Mark Friedrichs committed
717
		} else {
Mark Friedrichs's avatar
Mark Friedrichs committed
718

Mark Friedrichs's avatar
Mark Friedrichs committed
719
			//No more textures, need to shuffle
Mark Friedrichs's avatar
Mark Friedrichs committed
720

Mark Friedrichs's avatar
Mark Friedrichs committed
721
			if( _numberOfShuffles < _maxShuffles ){
Mark Friedrichs's avatar
Mark Friedrichs committed
722

Mark Friedrichs's avatar
Mark Friedrichs committed
723
724
				_shuffleGVStreams( );
            _numberOfShuffles++;
Mark Friedrichs's avatar
Mods  
Mark Friedrichs committed
725
            action = "shuffled streams";
Mark Friedrichs's avatar
Mark Friedrichs committed
726

Mark Friedrichs's avatar
Mark Friedrichs committed
727
			} else { //Need to refresh random numbers from cpu
Mark Friedrichs's avatar
Mark Friedrichs committed
728

Mark Friedrichs's avatar
Mods  
Mark Friedrichs committed
729
730
731
732
            if( _randomNumberGenerator == Mersenne ){
               action = "loaded new values from GPU using Mersenne rng";
               _loadRandomNumberStreamsMersenne( );
            } else if( _randomNumberGenerator == Kiss ){
Mark Friedrichs's avatar
Mods  
Mark Friedrichs committed
733
               action = "loaded new values from GPU using KISS rng";
Mark Friedrichs's avatar
Mods  
Mark Friedrichs committed
734
735
736
737
               _loadRandomNumberStreamsKiss( );
            } else if( _randomNumberGenerator == Original ){
               action = "loaded new values from GPU using original Gromac's rng";
               _loadGVStreamsOriginal( );
Mark Friedrichs's avatar
Mark Friedrichs committed
738
739
740
741
742
            }
            _numberOfShuffles  = 0;
			}
         _rvStreamIndex = 0;
		}
Mark Friedrichs's avatar
Mods  
Mark Friedrichs committed
743

Mark Friedrichs's avatar
Mods  
Mark Friedrichs committed
744
745
746
      if( printOn ){
         (void) fprintf( log, "%s StrmIdx=%d action=%s\n", methodName, _rvStreamIndex, action );
         (void) fflush( log );
Mark Friedrichs's avatar
Mods  
Mark Friedrichs committed
747
      }
Mark Friedrichs's avatar
Mark Friedrichs committed
748
	}
Mark Friedrichs's avatar
Mark Friedrichs committed
749
750
751
752
753

   return DefaultReturnValue;
}

/** 
Mark Friedrichs's avatar
Mark Friedrichs committed
754
 * Get random number stream size
Mark Friedrichs's avatar
Mark Friedrichs committed
755
 *
Mark Friedrichs's avatar
Mark Friedrichs committed
756
 * @return  random number stream size
Mark Friedrichs's avatar
Mark Friedrichs committed
757
758
759
 *
 */

Mark Friedrichs's avatar
Mark Friedrichs committed
760
761
int BrookRandomNumberGenerator::getRandomNumberStreamSize( void ) const {
   return _randomNumberStreamSize;
Mark Friedrichs's avatar
Mark Friedrichs committed
762
763
764
}

/** 
Mark Friedrichs's avatar
Mark Friedrichs committed
765
 * Get Shuffle stream 
Mark Friedrichs's avatar
Mark Friedrichs committed
766
 *
Mark Friedrichs's avatar
Mark Friedrichs committed
767
 * @return  shuffle stream
Mark Friedrichs's avatar
Mark Friedrichs committed
768
769
770
 *
 */

Mark Friedrichs's avatar
Mark Friedrichs committed
771
772
BrookFloatStreamInternal* BrookRandomNumberGenerator::_getShuffleStream( void ) const {
   return _auxiliaryStreams[ShuffleStream];
Mark Friedrichs's avatar
Mark Friedrichs committed
773
774
775
}

/** 
Mark Friedrichs's avatar
Mark Friedrichs committed
776
 * Get random number stream 
Mark Friedrichs's avatar
Mark Friedrichs committed
777
 *
Mark Friedrichs's avatar
Mods  
Mark Friedrichs committed
778
 * @param index     random number stream index     
Mark Friedrichs's avatar
Mark Friedrichs committed
779
780
 *
 * @return  random number stream
Mark Friedrichs's avatar
Mark Friedrichs committed
781
 *
Mark Friedrichs's avatar
Mark Friedrichs committed
782
 * @throw OpenMMException if index is invalid or _randomNumberGeneratorStreams not set
Mark Friedrichs's avatar
Mark Friedrichs committed
783
784
785
 *
 */

Mark Friedrichs's avatar
Mark Friedrichs committed
786
BrookFloatStreamInternal* BrookRandomNumberGenerator::getRandomNumberStream( int index ) const {
Mark Friedrichs's avatar
Mark Friedrichs committed
787

Mark Friedrichs's avatar
Mark Friedrichs committed
788
   // ---------------------------------------------------------------------------------------
Mark Friedrichs's avatar
Mark Friedrichs committed
789

Mark Friedrichs's avatar
Mods  
Mark Friedrichs committed
790
   static const std::string methodName = "\nBrookRandomNumberGenerator::getRandomNumberStream";
Mark Friedrichs's avatar
Mark Friedrichs committed
791

Mark Friedrichs's avatar
Mark Friedrichs committed
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
   // ---------------------------------------------------------------------------------------
	
   if( index < 0 || index >= _numberOfRandomNumberStreams ){
      std::stringstream message;
      message << methodName << " index=" << index << " is out of range: [0," << _numberOfRandomNumberStreams;
      throw OpenMMException( message.str() );
      return NULL;
   }

   if( _randomNumberGeneratorStreams == NULL ){
      std::stringstream message;
      message << methodName << " rv streams not initialized; input index=" << index;
      throw OpenMMException( message.str() );
      return NULL;
   }

   return _randomNumberGeneratorStreams[index];
Mark Friedrichs's avatar
Mark Friedrichs committed
809
810
811
}

/** 
Mark Friedrichs's avatar
Mark Friedrichs committed
812
 * Get random value stream index
Mark Friedrichs's avatar
Mark Friedrichs committed
813
 *
Mark Friedrichs's avatar
Mark Friedrichs committed
814
 * @return  random value stream index
Mark Friedrichs's avatar
Mark Friedrichs committed
815
816
817
 *
 */

Mark Friedrichs's avatar
Mark Friedrichs committed
818
819
int BrookRandomNumberGenerator::getRvStreamIndex( void ) const {
   return _rvStreamIndex;
Mark Friedrichs's avatar
Mark Friedrichs committed
820
821
822
}

/** 
Mark Friedrichs's avatar
Mark Friedrichs committed
823
 * Get random value stream offset
Mark Friedrichs's avatar
Mark Friedrichs committed
824
 *
Mark Friedrichs's avatar
Mark Friedrichs committed
825
 * @return  random value stream offset
Mark Friedrichs's avatar
Mark Friedrichs committed
826
827
828
 *
 */

Mark Friedrichs's avatar
Mark Friedrichs committed
829
830
int BrookRandomNumberGenerator::getRvStreamOffset( void ) const {
   return _rvStreamOffset;
Mark Friedrichs's avatar
Mark Friedrichs committed
831
832
833
}

/** 
Mark Friedrichs's avatar
Mark Friedrichs committed
834
 * Get max shuffles
Mark Friedrichs's avatar
Mark Friedrichs committed
835
 *
Mark Friedrichs's avatar
Mark Friedrichs committed
836
 * @return  max shuffles
Mark Friedrichs's avatar
Mark Friedrichs committed
837
838
839
 *
 */

Mark Friedrichs's avatar
Mark Friedrichs committed
840
841
int BrookRandomNumberGenerator::getMaxShuffles( void ) const {
   return _maxShuffles;
Mark Friedrichs's avatar
Mark Friedrichs committed
842
843
844
}

/** 
Mark Friedrichs's avatar
Mark Friedrichs committed
845
 * Get number of shuffles
Mark Friedrichs's avatar
Mark Friedrichs committed
846
 *
Mark Friedrichs's avatar
Mark Friedrichs committed
847
 * @return  number of shuffles
Mark Friedrichs's avatar
Mark Friedrichs committed
848
849
850
 *
 */

Mark Friedrichs's avatar
Mark Friedrichs committed
851
852
int BrookRandomNumberGenerator::_getNumberOfShuffles( void ) const {
   return _numberOfShuffles;
Mark Friedrichs's avatar
Mark Friedrichs committed
853
854
855
856
857
}

/** 
 * Initialize stream dimensions
 * 
Mark Friedrichs's avatar
Mods  
Mark Friedrichs committed
858
 * @param numberOfParticles         number of particles
Mark Friedrichs's avatar
Mark Friedrichs committed
859
860
861
862
863
864
 * @param platform                  platform
 *      
 * @return ErrorReturnValue if error, else DefaultReturnValue
 *
 */

Mark Friedrichs's avatar
Mods  
Mark Friedrichs committed
865
int BrookRandomNumberGenerator::_initializeStreamSizes( int numberOfParticles, const Platform& platform ){
Mark Friedrichs's avatar
Mark Friedrichs committed
866
867
868
869
870
871
872

// ---------------------------------------------------------------------------------------

   //static const std::string methodName      = "BrookRandomNumberGenerator::_initializeStreamSizes";

// ---------------------------------------------------------------------------------------

Mark Friedrichs's avatar
Mods  
Mark Friedrichs committed
873
   setNumberOfParticles( numberOfParticles );
Mark Friedrichs's avatar
Mark Friedrichs committed
874

Mark Friedrichs's avatar
Mark Friedrichs committed
875
   // get randomNumber stream dimensions
Mark Friedrichs's avatar
Mark Friedrichs committed
876

Mark Friedrichs's avatar
Mark Friedrichs committed
877
878
879
880
881
   const BrookPlatform brookPlatform            = dynamic_cast<const BrookPlatform&> (platform);
   const BrookStreamFactory& brookStreamFactory = dynamic_cast<const BrookStreamFactory&> (platform.getDefaultStreamFactory() );
   _randomNumberStreamWidth                     = brookStreamFactory.getDefaultRandomNumberStreamWidth();
   _randomNumberStreamSize                      = brookStreamFactory.getDefaultRandomNumberStreamSize();
   _randomNumberStreamHeight                    = (int) ( ((float) _randomNumberStreamSize)/( (float) _randomNumberStreamWidth) + 0.001);
Mark Friedrichs's avatar
Mark Friedrichs committed
882

Mark Friedrichs's avatar
Mark Friedrichs committed
883
   _randomNumberStreamSize                      =  _randomNumberStreamWidth*_randomNumberStreamHeight;
Mark Friedrichs's avatar
Mark Friedrichs committed
884

Mark Friedrichs's avatar
Mark Friedrichs committed
885
   return DefaultReturnValue;
Mark Friedrichs's avatar
Mark Friedrichs committed
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
}

/** 
 * Initialize streams
 * 
 * @param platform                  platform
 *
 * @return ErrorReturnValue if error, else DefaultReturnValue
 *
 */

int BrookRandomNumberGenerator::_initializeStreams( const Platform& platform ){

// ---------------------------------------------------------------------------------------

   //static const std::string methodName      = "BrookRandomNumberGenerator::_initializeStreams";

Mark Friedrichs's avatar
Mark Friedrichs committed
903
   float dangleValue                          = 0.0f;
Mark Friedrichs's avatar
Mark Friedrichs committed
904
905
906

// ---------------------------------------------------------------------------------------

Mark Friedrichs's avatar
Mark Friedrichs committed
907
908
   int randomNumberStreamSize                = getRandomNumberStreamSize();
   int randomNumberStreamWidth               = getRandomNumberStreamWidth();
Mark Friedrichs's avatar
Mark Friedrichs committed
909

Mark Friedrichs's avatar
Mark Friedrichs committed
910
911
912
   _auxiliaryStreams[ShuffleStream]         = new BrookFloatStreamInternal( BrookCommon::ShuffleStream,
                                                                            randomNumberStreamSize, randomNumberStreamWidth,
                                                                            BrookStreamInternal::Float, dangleValue );
Mark Friedrichs's avatar
Mark Friedrichs committed
913

Mark Friedrichs's avatar
Mark Friedrichs committed
914
915
916
917
918
   // insure number of random number streams is > 0
   // delete if already allocated and then initialize
 
   if( _numberOfRandomNumberStreams < 1 ){
      _numberOfRandomNumberStreams     = 1;
Mark Friedrichs's avatar
Mark Friedrichs committed
919
920
   }

Mark Friedrichs's avatar
Mark Friedrichs committed
921
922
   if( _randomNumberGeneratorStreams ){
      delete[] _randomNumberGeneratorStreams;
Mark Friedrichs's avatar
Mark Friedrichs committed
923
924
   }

Mark Friedrichs's avatar
Mark Friedrichs committed
925
   _randomNumberGeneratorStreams = new BrookFloatStreamInternal*[_numberOfRandomNumberStreams];
Mark Friedrichs's avatar
Mark Friedrichs committed
926

Mark Friedrichs's avatar
Mark Friedrichs committed
927
928
929
930
   for( int ii = 0; ii < _numberOfRandomNumberStreams; ii++ ){
      _randomNumberGeneratorStreams[ii]    = new BrookFloatStreamInternal( BrookCommon::ShuffleStream,
                                                                           randomNumberStreamSize, randomNumberStreamWidth,
                                                                           BrookStreamInternal::Float3, dangleValue );
Mark Friedrichs's avatar
Mark Friedrichs committed
931
932
933
934
935
936
937
938
   }

   return DefaultReturnValue;
}

/*  
 * Setup of StochasticDynamics parameters
 *
Mark Friedrichs's avatar
Mods  
Mark Friedrichs committed
939
 * @param numberOfParticles     number of particles
Mark Friedrichs's avatar
Mark Friedrichs committed
940
941
942
943
944
945
 * @param platform              Brook platform
 *
 * @return nonzero value if error
 *
 * */
    
Mark Friedrichs's avatar
Mods  
Mark Friedrichs committed
946
int BrookRandomNumberGenerator::setup( int numberOfParticles,  const Platform& platform ){
Mark Friedrichs's avatar
Mark Friedrichs committed
947
948
949
    
// ---------------------------------------------------------------------------------------

Mark Friedrichs's avatar
Mark Friedrichs committed
950
   //static const std::string methodName      = "BrookRandomNumberGenerator::setup";
Mark Friedrichs's avatar
Mark Friedrichs committed
951
952
953

// ---------------------------------------------------------------------------------------

Mark Friedrichs's avatar
Mods  
Mark Friedrichs committed
954
955
956
   const BrookPlatform brookPlatform            = dynamic_cast<const BrookPlatform&> (platform);
   setLog( brookPlatform.getLog() );

Mark Friedrichs's avatar
Mark Friedrichs committed
957
958
   // set stream sizes and then create streams

Mark Friedrichs's avatar
Mods  
Mark Friedrichs committed
959
   _initializeStreamSizes( numberOfParticles, platform );
Mark Friedrichs's avatar
Mark Friedrichs committed
960
   _initializeStreams( platform );
Mark Friedrichs's avatar
Mods  
Mark Friedrichs committed
961
962
963
964

   if( _randomNumberGenerator == Mersenne ){
      _loadRandomNumberStreamsMersenne( );
   } else if( _randomNumberGenerator == Kiss ){
965
      _loadRandomNumberStreamsKiss( );
Mark Friedrichs's avatar
Mods  
Mark Friedrichs committed
966
967
   } else if( _randomNumberGenerator == Original ){
      _loadGVStreamsOriginal( );
968
   }
Mark Friedrichs's avatar
Mark Friedrichs committed
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003

   return DefaultReturnValue;
}

/* 
 * Get contents of object
 *
 * @param level   level of dump
 *
 * @return string containing contents
 *
 * */

std::string BrookRandomNumberGenerator::getContentsString( int level ) const {

// ---------------------------------------------------------------------------------------

   static const std::string methodName      = "BrookRandomNumberGenerator::getContentsString";

   static const unsigned int MAX_LINE_CHARS = 256;
   char value[MAX_LINE_CHARS];
   static const char* Set                   = "Set";
   static const char* NotSet                = "Not set";

// ---------------------------------------------------------------------------------------

   std::stringstream message;
   std::string tab   = "   ";

#ifdef WIN32
#define LOCAL_SPRINTF(a,b,c) sprintf_s( (a), MAX_LINE_CHARS, (b), (c) );   
#else
#define LOCAL_SPRINTF(a,b,c) sprintf( (a), (b), (c) );   
#endif

Mark Friedrichs's avatar
Mods  
Mark Friedrichs committed
1004
1005
1006
1007
1008
1009
1010
1011
   
   if( _randomNumberGenerator == Mersenne ){
      (void) LOCAL_SPRINTF( value, "%s", "Mersenne Rng");
   } else if( _randomNumberGenerator == Kiss ){
      (void) LOCAL_SPRINTF( value, "%s", "Kiss Rng");
   } else if( _randomNumberGenerator == Original ){
      (void) LOCAL_SPRINTF( value, "%s", "Original Gromacs Rng");
   }
Mark Friedrichs's avatar
Mark Friedrichs committed
1012
   message << _getLine( tab, "Random number generator:", value ); 
Mark Friedrichs's avatar
Mark Friedrichs committed
1013

1014
1015
   (void) LOCAL_SPRINTF( value, "%d", getRandomNumberStreamSize() );
   message << _getLine( tab, "RandomNumber stream size:", value ); 
Mark Friedrichs's avatar
Mark Friedrichs committed
1016

Mark Friedrichs's avatar
Mark Friedrichs committed
1017
1018
   (void) LOCAL_SPRINTF( value, "%d", getRandomNumberStreamWidth() );
   message << _getLine( tab, "RandomNumber stream width:", value ); 
Mark Friedrichs's avatar
Mark Friedrichs committed
1019

Mark Friedrichs's avatar
Mark Friedrichs committed
1020
1021
   (void) LOCAL_SPRINTF( value, "%d", getRandomNumberStreamHeight() );
   message << _getLine( tab, "RandomNumber stream height:", value ); 
Mark Friedrichs's avatar
Mark Friedrichs committed
1022

Mark Friedrichs's avatar
Mark Friedrichs committed
1023
1024
   (void) LOCAL_SPRINTF( value, "%d", getNumberOfRandomNumberStreams() );
   message << _getLine( tab, "Number of RandomNumber streams:", value ); 
Mark Friedrichs's avatar
Mark Friedrichs committed
1025

Mark Friedrichs's avatar
Mark Friedrichs committed
1026
1027
   (void) LOCAL_SPRINTF( value, "%ld", getRandomNumberSeed() );
   message << _getLine( tab, "Seed:", value ); 
Mark Friedrichs's avatar
Mark Friedrichs committed
1028

Mark Friedrichs's avatar
Mark Friedrichs committed
1029
1030
   (void) LOCAL_SPRINTF( value, "%d", getRvStreamIndex() );
   message << _getLine( tab, "Rv stream index:", value ); 
Mark Friedrichs's avatar
Mark Friedrichs committed
1031

Mark Friedrichs's avatar
Mark Friedrichs committed
1032
1033
1034
1035
1036
   (void) LOCAL_SPRINTF( value, "%d", getRvStreamOffset() );
   message << _getLine( tab, "Rv stream offset:", value ); 

   (void) LOCAL_SPRINTF( value, "%d", _getNumberOfShuffles() );
   message << _getLine( tab, "Number of rv stream shuffles:", value ); 
Mark Friedrichs's avatar
Mark Friedrichs committed
1037

Mark Friedrichs's avatar
Mark Friedrichs committed
1038
1039
   (void) LOCAL_SPRINTF( value, "%d", getMaxShuffles() );
   message << _getLine( tab, "Max number of rv stream shuffles:", value ); 
Mark Friedrichs's avatar
Mark Friedrichs committed
1040

Mark Friedrichs's avatar
Mods  
Mark Friedrichs committed
1041
   message << _getLine( tab, "Log:",                  (getLog()                 ? Set : NotSet) ); 
Mark Friedrichs's avatar
Mark Friedrichs committed
1042

Mark Friedrichs's avatar
Mark Friedrichs committed
1043
   message << _getLine( tab, "Shuffle:",              (_getShuffleStream()      ? Set : NotSet) ); 
Mark Friedrichs's avatar
Mark Friedrichs committed
1044
 
Mark Friedrichs's avatar
Mods  
Mark Friedrichs committed
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
   message << getStatisticsString( );

   for( int ii = 0; ii < LastStreamIndex; ii++ ){
      message << std::endl;
      if( _auxiliaryStreams[ii] ){
         message << _auxiliaryStreams[ii]->getContentsString( );
      }
   }

#undef LOCAL_SPRINTF

   return message.str();
}

/* 
 * Get statistics
 *
 * @return string containing contents
 *
 * */

std::string BrookRandomNumberGenerator::getStatisticsString( void ) const {

// ---------------------------------------------------------------------------------------

   static const std::string methodName      = "BrookRandomNumberGenerator::getStatisticsString";

   static const unsigned int MAX_LINE_CHARS = 256;
   char value[MAX_LINE_CHARS];
   static const char* Set                   = "Set";
   static const char* NotSet                = "Not set";
   static double cumulativeStatistics[7]    = { 0.0, 0.0, 0.0, 0.0, 0.0, 1.0e+99, -1.0e+99 };

// ---------------------------------------------------------------------------------------

   std::stringstream message;
   std::string tab   = "   ";

#ifdef WIN32
#define LOCAL_SPRINTF(a,b,c) sprintf_s( (a), MAX_LINE_CHARS, (b), (c) );   
#else
#define LOCAL_SPRINTF(a,b,c) sprintf( (a), (b), (c) );   
#endif

1089
1090
1091
   message << "\n   Statistics:\n";

   double statistics[7];
Mark Friedrichs's avatar
Mods  
Mark Friedrichs committed
1092
   getStatistics( statistics, -1, cumulativeStatistics );
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111

   (void) LOCAL_SPRINTF( value, "%.5e", statistics[4] );
   message << _getLine( tab, "Count:",  value ); 

   (void) LOCAL_SPRINTF( value, "%.5e", statistics[0] );
   message << _getLine( tab, "Average:",  value ); 

   (void) LOCAL_SPRINTF( value, "%.5e", statistics[1] );
   message << _getLine( tab, "StdDev:",  value ); 

   (void) LOCAL_SPRINTF( value, "%.5e", statistics[3] );
   message << _getLine( tab, "Kurtosis:",  value ); 

   (void) LOCAL_SPRINTF( value, "%.5e", statistics[5] );
   message << _getLine( tab, "Min:",  value ); 

   (void) LOCAL_SPRINTF( value, "%.6e", statistics[6] );
   message << _getLine( tab, "Max:",  value ); 

Mark Friedrichs's avatar
Mods  
Mark Friedrichs committed
1112
1113
1114
1115
   if( cumulativeStatistics[4] > 1000.0 ){ 

      for( int ii = 0; ii < 7; ii++ ){
         statistics[ii] = cumulativeStatistics[ii];
Mark Friedrichs's avatar
Mark Friedrichs committed
1116
1117
      }

Mark Friedrichs's avatar
Mods  
Mark Friedrichs committed
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
      statistics[0] /= statistics[4];
      statistics[1]  = statistics[1] - statistics[4]*statistics[0]*statistics[0];
      if( statistics[4] > 1.0 ){
         statistics[1] = sqrt( statistics[1]/( statistics[4] - 1.0 ) );
      }
      statistics[3]  = (statistics[3]/(statistics[4]*statistics[1]*statistics[1]) ) - 3.0;
      (void) LOCAL_SPRINTF( value, "%.5e", statistics[4] );
      message << _getLine( tab, "Cumulative Count:",  value ); 
   
      (void) LOCAL_SPRINTF( value, "%.5e", statistics[0] );
      message << _getLine( tab, "Cumulative Average:",  value ); 
   
      (void) LOCAL_SPRINTF( value, "%.5e", statistics[1] );
      message << _getLine( tab, "Cumulative StdDev:",  value ); 
   
      (void) LOCAL_SPRINTF( value, "%.5e", statistics[3] );
      message << _getLine( tab, "Cumulative Kurtosis:",  value ); 
   
      (void) LOCAL_SPRINTF( value, "%.5e", statistics[5] );
      message << _getLine( tab, "Cumulative Min:",  value ); 
   
      (void) LOCAL_SPRINTF( value, "%.6e", statistics[6] );
      message << _getLine( tab, "Cumulative Max:",  value ); 
   }
   
Mark Friedrichs's avatar
Mark Friedrichs committed
1143
1144
1145
1146
#undef LOCAL_SPRINTF

   return message.str();
}
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165

/* 
 * Get statistics
 *
 * @param statistics   array of size 5:
 *                       0: mean
 *                       1: std dev
 *                       2: 3rd moment (not normalized)
 *                       3: kurtosis
 *                       4: count 
 *                       5: min
 *                       6: max
 *
 * @param streamIndex  stream index to analyze
 *
 * @return DefaultReturnValue
 *
 * */

Mark Friedrichs's avatar
Mods  
Mark Friedrichs committed
1166
int BrookRandomNumberGenerator::getStatistics( double statistics[7], int streamIndex, double cumulativeStatistics[7] ) const {
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207

// ---------------------------------------------------------------------------------------

   static const std::string methodName      = "BrookRandomNumberGenerator::";

// ---------------------------------------------------------------------------------------

   statistics[0] = 0.0;
   statistics[1] = 0.0;
   statistics[2] = 0.0;
   statistics[3] = 0.0;
   statistics[4] = 0.0;
   statistics[5] =  1.0e+99;
   statistics[6] = -1.0e+99;

   for( int ii = 0; ii < _numberOfRandomNumberStreams; ii++ ){
      if( streamIndex < 0 || ii == streamIndex ){
         void* dataArrayV       = _randomNumberGeneratorStreams[ii]->getData( 1 );
         int streamSize         = _randomNumberGeneratorStreams[ii]->getStreamSize();
         int index              = 0;
         const float* dataArray = (float*) dataArrayV;
         for( int ii = 0; ii < streamSize; ii++, index++ ){

             statistics[0] += dataArray[index];

             double rv2     = dataArray[index]*dataArray[index];
             statistics[1] += rv2;
             statistics[2] += rv2*dataArray[index];
             statistics[3] += rv2*rv2;

             if( statistics[5] > dataArray[index] ){
                statistics[5] = dataArray[index];
             }
             if( statistics[6] < dataArray[index] ){
                statistics[6] = dataArray[index];
             }
         } 
         statistics[4] += (double) index;
      }   
   }   

Mark Friedrichs's avatar
Mods  
Mark Friedrichs committed
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
   for( int ii = 0; ii < 5; ii++ ){
      cumulativeStatistics[ii] += statistics[ii];
   }
   if( statistics[5] < cumulativeStatistics[5] ){
      cumulativeStatistics[5] = statistics[5];
   }
   if( statistics[6] > cumulativeStatistics[6] ){
      cumulativeStatistics[6] = statistics[6];
   }

1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
   if( statistics[4] > 0.0 ){ 
      statistics[0] /= statistics[4];
      statistics[1]  = statistics[1] - statistics[4]*statistics[0]*statistics[0];
      if( statistics[4] > 1.0 ){
         statistics[1] = sqrt( statistics[1]/( statistics[4] - 1.0 ) );
      }
      statistics[3]  = (statistics[3]/(statistics[4]*statistics[1]*statistics[1]) ) - 3.0;
   }

   return DefaultReturnValue;
}