| 1 |
/* |
| 2 |
* Copyright (c) 2005 The University of Notre Dame. All Rights Reserved. |
| 3 |
* |
| 4 |
* The University of Notre Dame grants you ("Licensee") a |
| 5 |
* non-exclusive, royalty free, license to use, modify and |
| 6 |
* redistribute this software in source and binary code form, provided |
| 7 |
* that the following conditions are met: |
| 8 |
* |
| 9 |
* 1. Acknowledgement of the program authors must be made in any |
| 10 |
* publication of scientific results based in part on use of the |
| 11 |
* program. An acceptable form of acknowledgement is citation of |
| 12 |
* the article in which the program was described (Matthew |
| 13 |
* A. Meineke, Charles F. Vardeman II, Teng Lin, Christopher |
| 14 |
* J. Fennell and J. Daniel Gezelter, "OOPSE: An Object-Oriented |
| 15 |
* Parallel Simulation Engine for Molecular Dynamics," |
| 16 |
* J. Comput. Chem. 26, pp. 252-271 (2005)) |
| 17 |
* |
| 18 |
* 2. Redistributions of source code must retain the above copyright |
| 19 |
* notice, this list of conditions and the following disclaimer. |
| 20 |
* |
| 21 |
* 3. Redistributions in binary form must reproduce the above copyright |
| 22 |
* notice, this list of conditions and the following disclaimer in the |
| 23 |
* documentation and/or other materials provided with the |
| 24 |
* distribution. |
| 25 |
* |
| 26 |
* This software is provided "AS IS," without a warranty of any |
| 27 |
* kind. All express or implied conditions, representations and |
| 28 |
* warranties, including any implied warranty of merchantability, |
| 29 |
* fitness for a particular purpose or non-infringement, are hereby |
| 30 |
* excluded. The University of Notre Dame and its licensors shall not |
| 31 |
* be liable for any damages suffered by licensee as a result of |
| 32 |
* using, modifying or distributing the software or its |
| 33 |
* derivatives. In no event will the University of Notre Dame or its |
| 34 |
* licensors be liable for any lost revenue, profit or data, or for |
| 35 |
* direct, indirect, special, consequential, incidental or punitive |
| 36 |
* damages, however caused and regardless of the theory of liability, |
| 37 |
* arising out of the use of or inability to use software, even if the |
| 38 |
* University of Notre Dame has been advised of the possibility of |
| 39 |
* such damages. |
| 40 |
*/ |
| 41 |
|
| 42 |
#ifndef MATH_PARALLELRANDNUMGEN_HPP |
| 43 |
#define MATH_PARALLELRANDNUMGEN_HPP |
| 44 |
|
| 45 |
#include <vector> |
| 46 |
#include "MersenneTwister.hpp" |
| 47 |
#include "utils/simError.h" |
| 48 |
|
| 49 |
#ifdef IS_MPI |
| 50 |
|
| 51 |
namespace oopse { |
| 52 |
|
| 53 |
|
| 54 |
|
| 55 |
/** |
| 56 |
* @class ParallelRandNumGen a parallel random number generator |
| 57 |
* @note use MTRand if you want a non-parallel random number generator in MPI enviroment |
| 58 |
*/ |
| 59 |
class ParallelRandNumGen{ |
| 60 |
public: |
| 61 |
typedef unsigned long uint32; |
| 62 |
|
| 63 |
ParallelRandNumGen( const uint32& oneSeed); |
| 64 |
ParallelRandNumGen(); |
| 65 |
|
| 66 |
~ParallelRandNumGen() { |
| 67 |
delete mtRand_; |
| 68 |
} |
| 69 |
|
| 70 |
/** Returns a real number in [0,1] */ |
| 71 |
double rand() { |
| 72 |
return mtRand_->rand(); |
| 73 |
} |
| 74 |
|
| 75 |
/** Returns a real number in [0, n] */ |
| 76 |
double rand( const double& n ) { |
| 77 |
return mtRand_->rand(n); |
| 78 |
} |
| 79 |
|
| 80 |
/** Returns a real number in [0, 1) */ |
| 81 |
double randExc() { |
| 82 |
return mtRand_->randExc(); |
| 83 |
} |
| 84 |
|
| 85 |
/** Returns a real number in [0, n) */ |
| 86 |
double randExc( const double& n ) { |
| 87 |
return mtRand_->randExc(n); |
| 88 |
} |
| 89 |
|
| 90 |
/** Returns a real number in (0, 1) */ |
| 91 |
double randDblExc() { |
| 92 |
return mtRand_->randDblExc(); |
| 93 |
} |
| 94 |
|
| 95 |
/** Returns a real number in (0, n) */ |
| 96 |
double randDblExc( const double& n ) { |
| 97 |
return mtRand_->randDblExc(n); |
| 98 |
} |
| 99 |
|
| 100 |
/** Returns aninteger in [0,2^32-1] */ |
| 101 |
uint32 randInt() { |
| 102 |
return mtRand_->randInt(); |
| 103 |
} |
| 104 |
|
| 105 |
/** Returns aninteger in [0, n] for n < 2^32 */ |
| 106 |
uint32 randInt( const uint32& n ) { |
| 107 |
return mtRand_->randInt(n); |
| 108 |
} |
| 109 |
|
| 110 |
/** Returns a 53-bitreal number in [0,1) (capacity of IEEE double precision) */ |
| 111 |
double rand53() { |
| 112 |
return mtRand_->rand53(); |
| 113 |
} |
| 114 |
|
| 115 |
/** Access to nonuniform random number distributions */ |
| 116 |
double randNorm( const double& mean, const double& variance) { |
| 117 |
return mtRand_->randNorm(mean, variance); |
| 118 |
} |
| 119 |
|
| 120 |
// Re-seeding functions with same behavior as initializers |
| 121 |
void seed( const uint32 oneSeed ); |
| 122 |
|
| 123 |
void seed(); |
| 124 |
|
| 125 |
private: |
| 126 |
|
| 127 |
MTRand* mtRand_; |
| 128 |
|
| 129 |
static int nCreatedRNG_; /**< number of created random number of generator*/ |
| 130 |
|
| 131 |
}; |
| 132 |
|
| 133 |
} |
| 134 |
#endif |
| 135 |
|
| 136 |
#endif |
