src/math/RandNumGen.hpp

 /*
 * Copyright (c) 2005 The University of Notre Dame. All Rights Reserved.
 *
 * The University of Notre Dame grants you ("Licensee") a
 * non-exclusive, royalty free, license to use, modify and
 * redistribute this software in source and binary code form, provided
 * that the following conditions are met:
 *
 * 1. Acknowledgement of the program authors must be made in any
 *    publication of scientific results based in part on use of the
 *    program.  An acceptable form of acknowledgement is citation of
 *    the article in which the program was described (Matthew
 *    A. Meineke, Charles F. Vardeman II, Teng Lin, Christopher
 *    J. Fennell and J. Daniel Gezelter, "OOPSE: An Object-Oriented
 *    Parallel Simulation Engine for Molecular Dynamics,"
 *    J. Comput. Chem. 26, pp. 252-271 (2005))
 *
 * 2. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * 3. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the
 *    distribution.
 *
 * This software is provided "AS IS," without a warranty of any
 * kind. All express or implied conditions, representations and
 * warranties, including any implied warranty of merchantability,
 * fitness for a particular purpose or non-infringement, are hereby
 * excluded.  The University of Notre Dame and its licensors shall not
 * be liable for any damages suffered by licensee as a result of
 * using, modifying or distributing the software or its
 * derivatives. In no event will the University of Notre Dame or its
 * licensors be liable for any lost revenue, profit or data, or for
 * direct, indirect, special, consequential, incidental or punitive
 * damages, however caused and regardless of the theory of liability,
 * arising out of the use of or inability to use software, even if the
 * University of Notre Dame has been advised of the possibility of
 * such damages.
 */

#ifndef MATH_RANDNUMGEN_HPP
#define MATH_RANDNUMGEN_HPP

#include <vector>
#include "MersenneTwister.hpp"
#include "utils/simError.h"


namespace oopse {


/**
 * @class RandNumGen a random number generator class
 */
class RandNumGen{
    public:
        typedef unsigned long uint32; 
        
        virtual ~RandNumGen() {
            delete mtRand_;
        }
        
        /** Returns a real number in [0,1] */
        double rand() {
            return mtRand_->rand();
        }

        /** Returns a real number in [0, n] */
        double rand( const double& n ) {
            return mtRand_->rand(n);
        }

        /** Returns a real number in [0, 1) */
        double randExc() {
            return mtRand_->randExc();
        }

        /** Returns a real number in [0, n) */        
        double randExc( const double& n ) {
            return mtRand_->randExc(n);
        }

        /** Returns a real number in (0, 1) */                
        double randDblExc() {
            return mtRand_->randDblExc();
        }

        /** Returns a real number in (0, n) */                        
        double randDblExc( const double& n ) {
            return mtRand_->randDblExc(n);
        }

        /** Returns aninteger in [0,2^32-1]  */            
        uint32 randInt() {
           return mtRand_->randInt();
        }

        /** Returns aninteger in [0, n]  for n < 2^32 */     
        uint32 randInt( const uint32& n ) {
           return mtRand_->randInt(n);
        }
        
        /** Returns a 53-bitreal number in [0,1) (capacity of IEEE double precision) */
        double rand53() {
            return mtRand_->rand53();
        }
        
        /** Access to nonuniform random number distributions */
        double randNorm( const double& mean, const double& variance) {
            return mtRand_->randNorm(mean, variance);
        }
        
        // Re-seeding functions with same behavior as initializers
        virtual void seed( const uint32 oneSeed ) = 0;
        
        virtual void seed()= 0;

    protected:
        
        MTRand* mtRand_;


};

}

#endif 

Revision:	2078
Committed:	Wed Mar 2 16:29:47 2005 UTC (19 years, 4 months ago) by tim
File size:	4052 byte(s)
Log Message:	adding base class of Random Number generator
#	User	Rev	Content
1	tim	2078	/*
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_RANDNUMGEN_HPP
43			#define MATH_RANDNUMGEN_HPP
44
45			#include <vector>
46			#include "MersenneTwister.hpp"
47			#include "utils/simError.h"
48
49
50			namespace oopse {
51
52
53
54			/**
55			* @class RandNumGen a random number generator class
56			*/
57			class RandNumGen{
58			public:
59			typedef unsigned long uint32;
60
61			virtual ~RandNumGen() {
62			delete mtRand_;
63			}
64
65			/** Returns a real number in [0,1] */
66			double rand() {
67			return mtRand_->rand();
68			}
69
70			/** Returns a real number in [0, n] */
71			double rand( const double& n ) {
72			return mtRand_->rand(n);
73			}
74
75			/** Returns a real number in [0, 1) */
76			double randExc() {
77			return mtRand_->randExc();
78			}
79
80			/** Returns a real number in [0, n) */
81			double randExc( const double& n ) {
82			return mtRand_->randExc(n);
83			}
84
85			/** Returns a real number in (0, 1) */
86			double randDblExc() {
87			return mtRand_->randDblExc();
88			}
89
90			/** Returns a real number in (0, n) */
91			double randDblExc( const double& n ) {
92			return mtRand_->randDblExc(n);
93			}
94
95			/** Returns aninteger in [0,2^32-1] */
96			uint32 randInt() {
97			return mtRand_->randInt();
98			}
99
100			/** Returns aninteger in [0, n] for n < 2^32 */
101			uint32 randInt( const uint32& n ) {
102			return mtRand_->randInt(n);
103			}
104
105			/** Returns a 53-bitreal number in [0,1) (capacity of IEEE double precision) */
106			double rand53() {
107			return mtRand_->rand53();
108			}
109
110			/** Access to nonuniform random number distributions */
111			double randNorm( const double& mean, const double& variance) {
112			return mtRand_->randNorm(mean, variance);
113			}
114
115			// Re-seeding functions with same behavior as initializers
116			virtual void seed( const uint32 oneSeed ) = 0;
117
118			virtual void seed()= 0;
119
120			protected:
121
122			MTRand* mtRand_;
123
124
125			};
126
127			}
128
129			#endif
130