1 |
< |
/* |
1 |
> |
/* |
2 |
|
* Copyright (c) 2005 The University of Notre Dame. All Rights Reserved. |
3 |
|
* |
4 |
|
* The University of Notre Dame grants you ("Licensee") a |
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 |
9 |
> |
* 1. Redistributions of source code must retain the above copyright |
10 |
|
* notice, this list of conditions and the following disclaimer. |
11 |
|
* |
12 |
< |
* 3. Redistributions in binary form must reproduce the above copyright |
12 |
> |
* 2. Redistributions in binary form must reproduce the above copyright |
13 |
|
* notice, this list of conditions and the following disclaimer in the |
14 |
|
* documentation and/or other materials provided with the |
15 |
|
* distribution. |
28 |
|
* arising out of the use of or inability to use software, even if the |
29 |
|
* University of Notre Dame has been advised of the possibility of |
30 |
|
* such damages. |
31 |
+ |
* |
32 |
+ |
* SUPPORT OPEN SCIENCE! If you use OpenMD or its source code in your |
33 |
+ |
* research, please cite the appropriate papers when you publish your |
34 |
+ |
* work. Good starting points are: |
35 |
+ |
* |
36 |
+ |
* [1] Meineke, et al., J. Comp. Chem. 26, 252-271 (2005). |
37 |
+ |
* [2] Fennell & Gezelter, J. Chem. Phys. 124, 234104 (2006). |
38 |
+ |
* [3] Sun, Lin & Gezelter, J. Chem. Phys. 128, 24107 (2008). |
39 |
+ |
* [4] Kuang & Gezelter, J. Chem. Phys. 133, 164101 (2010). |
40 |
+ |
* [5] Vardeman, Stocker & Gezelter, J. Chem. Theory Comput. 7, 834 (2011). |
41 |
|
*/ |
42 |
|
|
43 |
|
#ifndef MATH_RANDNUMGEN_HPP |
44 |
|
#define MATH_RANDNUMGEN_HPP |
45 |
|
|
46 |
|
#include <vector> |
47 |
+ |
#include "config.h" |
48 |
|
#include "MersenneTwister.hpp" |
49 |
|
#include "utils/simError.h" |
50 |
|
|
51 |
|
|
52 |
< |
namespace oopse { |
52 |
> |
namespace OpenMD { |
53 |
|
|
54 |
< |
|
55 |
< |
|
56 |
< |
/** |
57 |
< |
* @class RandNumGen a random number generator class |
58 |
< |
*/ |
59 |
< |
class RandNumGen{ |
60 |
< |
public: |
59 |
< |
typedef unsigned long uint32; |
54 |
> |
/** |
55 |
> |
* @class RandNumGen |
56 |
> |
* @brief a random number generator class |
57 |
> |
*/ |
58 |
> |
class RandNumGen{ |
59 |
> |
public: |
60 |
> |
typedef unsigned long uint32; |
61 |
|
|
62 |
< |
virtual ~RandNumGen() { |
63 |
< |
delete mtRand_; |
64 |
< |
} |
62 |
> |
virtual ~RandNumGen() { |
63 |
> |
delete mtRand_; |
64 |
> |
} |
65 |
|
|
66 |
< |
/** Returns a real number in [0,1] */ |
67 |
< |
double rand() { |
68 |
< |
return mtRand_->rand(); |
69 |
< |
} |
66 |
> |
/** Returns a real number in [0,1] */ |
67 |
> |
RealType rand() { |
68 |
> |
return mtRand_->rand(); |
69 |
> |
} |
70 |
|
|
71 |
< |
/** Returns a real number in [0, n] */ |
72 |
< |
double rand( const double& n ) { |
73 |
< |
return mtRand_->rand(n); |
74 |
< |
} |
71 |
> |
/** Returns a real number in [0, n] */ |
72 |
> |
RealType rand( const RealType& n ) { |
73 |
> |
return mtRand_->rand(n); |
74 |
> |
} |
75 |
|
|
76 |
< |
/** Returns a real number in [0, 1) */ |
77 |
< |
double randExc() { |
78 |
< |
return mtRand_->randExc(); |
79 |
< |
} |
76 |
> |
/** Returns a real number in [0, 1) */ |
77 |
> |
RealType randExc() { |
78 |
> |
return mtRand_->randExc(); |
79 |
> |
} |
80 |
|
|
81 |
< |
/** Returns a real number in [0, n) */ |
82 |
< |
double randExc( const double& n ) { |
83 |
< |
return mtRand_->randExc(n); |
84 |
< |
} |
81 |
> |
/** Returns a real number in [0, n) */ |
82 |
> |
RealType randExc( const RealType& n ) { |
83 |
> |
return mtRand_->randExc(n); |
84 |
> |
} |
85 |
|
|
86 |
< |
/** Returns a real number in (0, 1) */ |
87 |
< |
double randDblExc() { |
88 |
< |
return mtRand_->randDblExc(); |
89 |
< |
} |
86 |
> |
/** Returns a real number in (0, 1) */ |
87 |
> |
RealType randDblExc() { |
88 |
> |
return mtRand_->randDblExc(); |
89 |
> |
} |
90 |
|
|
91 |
< |
/** Returns a real number in (0, n) */ |
92 |
< |
double randDblExc( const double& n ) { |
93 |
< |
return mtRand_->randDblExc(n); |
94 |
< |
} |
91 |
> |
/** Returns a real number in (0, n) */ |
92 |
> |
RealType randDblExc( const RealType& n ) { |
93 |
> |
return mtRand_->randDblExc(n); |
94 |
> |
} |
95 |
|
|
96 |
< |
/** Returns aninteger in [0,2^32-1] */ |
97 |
< |
uint32 randInt() { |
98 |
< |
return mtRand_->randInt(); |
99 |
< |
} |
96 |
> |
/** Returns aninteger in [0,2^32-1] */ |
97 |
> |
uint32 randInt() { |
98 |
> |
return mtRand_->randInt(); |
99 |
> |
} |
100 |
|
|
101 |
< |
/** Returns aninteger in [0, n] for n < 2^32 */ |
102 |
< |
uint32 randInt( const uint32& n ) { |
103 |
< |
return mtRand_->randInt(n); |
104 |
< |
} |
101 |
> |
/** Returns aninteger in [0, n] for n < 2^32 */ |
102 |
> |
uint32 randInt( const uint32& n ) { |
103 |
> |
return mtRand_->randInt(n); |
104 |
> |
} |
105 |
|
|
106 |
< |
/** Returns a 53-bitreal number in [0,1) (capacity of IEEE double precision) */ |
107 |
< |
double rand53() { |
108 |
< |
return mtRand_->rand53(); |
109 |
< |
} |
106 |
> |
/** Returns a 53-bitreal number in [0,1) (capacity of IEEE RealType precision) */ |
107 |
> |
RealType rand53() { |
108 |
> |
return mtRand_->rand53(); |
109 |
> |
} |
110 |
|
|
111 |
< |
/** Access to nonuniform random number distributions */ |
112 |
< |
double randNorm( const double& mean, const double& variance) { |
113 |
< |
return mtRand_->randNorm(mean, variance); |
114 |
< |
} |
111 |
> |
/** Access to nonuniform random number distributions */ |
112 |
> |
RealType randNorm( const RealType mean, const RealType variance) { |
113 |
> |
return mtRand_->randNorm(mean, variance); |
114 |
> |
} |
115 |
|
|
116 |
< |
// Re-seeding functions with same behavior as initializers |
117 |
< |
virtual void seed( const uint32 oneSeed ) = 0; |
116 |
> |
// Re-seeding functions with same behavior as initializers |
117 |
> |
virtual void seed( const uint32 oneSeed ) = 0; |
118 |
|
|
119 |
< |
virtual void seed()= 0; |
119 |
> |
virtual void seed()= 0; |
120 |
|
|
121 |
< |
protected: |
122 |
< |
|
122 |
< |
MTRand* mtRand_; |
121 |
> |
protected: |
122 |
> |
MTRand* mtRand_; |
123 |
|
|
124 |
|
|
125 |
< |
}; |
125 |
> |
}; |
126 |
|
|
127 |
|
} |
128 |
|
|