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. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * 2. 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.
 *
 * SUPPORT OPEN SCIENCE!  If you use OpenMD or its source code in your
 * research, please cite the appropriate papers when you publish your
 * work.  Good starting points are:
 *                                                                      
 * [1]  Meineke, et al., J. Comp. Chem. 26, 252-271 (2005).             
 * [2]  Fennell & Gezelter, J. Chem. Phys. 124, 234104 (2006).          
 * [3]  Sun, Lin & Gezelter, J. Chem. Phys. 128, 24107 (2008).          
 * [4]  Vardeman & Gezelter, in progress (2009).                        
 */

#ifndef MATH_RANDNUMGEN_HPP
#define MATH_RANDNUMGEN_HPP

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


namespace OpenMD {

  /**
   * @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] */
    RealType rand() {
      return mtRand_->rand();
    }

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

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

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

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

    /** Returns a real number in (0, n) */                        
    RealType randDblExc( const RealType& 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 RealType precision) */
    RealType rand53() {
      return mtRand_->rand53();
    }
        
    /** Access to nonuniform random number distributions */
    RealType randNorm( const RealType mean, const RealType 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:	1390
Committed:	Wed Nov 25 20:02:06 2009 UTC (15 years, 11 months ago) by gezelter
File size:	4048 byte(s)
Log Message:	Almost all of the changes necessary to create OpenMD out of our old project (OOPSE-4)
#	User	Rev	Content
1	gezelter	507	/*
2	tim	394	* 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	gezelter	1390	* 1. Redistributions of source code must retain the above copyright
10	tim	394	* notice, this list of conditions and the following disclaimer.
11			*
12	gezelter	1390	* 2. Redistributions in binary form must reproduce the above copyright
13	tim	394	* notice, this list of conditions and the following disclaimer in the
14			* documentation and/or other materials provided with the
15			* distribution.
16			*
17			* This software is provided "AS IS," without a warranty of any
18			* kind. All express or implied conditions, representations and
19			* warranties, including any implied warranty of merchantability,
20			* fitness for a particular purpose or non-infringement, are hereby
21			* excluded. The University of Notre Dame and its licensors shall not
22			* be liable for any damages suffered by licensee as a result of
23			* using, modifying or distributing the software or its
24			* derivatives. In no event will the University of Notre Dame or its
25			* licensors be liable for any lost revenue, profit or data, or for
26			* direct, indirect, special, consequential, incidental or punitive
27			* damages, however caused and regardless of the theory of liability,
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	gezelter	1390	*
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] Vardeman & Gezelter, in progress (2009).
40	tim	394	*/
41
42			#ifndef MATH_RANDNUMGEN_HPP
43			#define MATH_RANDNUMGEN_HPP
44
45			#include <vector>
46	tim	963	#include "config.h"
47	tim	394	#include "MersenneTwister.hpp"
48			#include "utils/simError.h"
49
50
51	gezelter	1390	namespace OpenMD {
52	tim	394
53	gezelter	507	/**
54			* @class RandNumGen a random number generator class
55			*/
56			class RandNumGen{
57			public:
58			typedef unsigned long uint32;
59	tim	394
60	gezelter	507	virtual ~RandNumGen() {
61			delete mtRand_;
62			}
63	tim	394
64	gezelter	507	/** Returns a real number in [0,1] */
65	tim	963	RealType rand() {
66	gezelter	507	return mtRand_->rand();
67			}
68	tim	394
69	gezelter	507	/** Returns a real number in [0, n] */
70	tim	963	RealType rand( const RealType& n ) {
71	gezelter	507	return mtRand_->rand(n);
72			}
73	tim	394
74	gezelter	507	/** Returns a real number in [0, 1) */
75	tim	963	RealType randExc() {
76	gezelter	507	return mtRand_->randExc();
77			}
78	tim	394
79	gezelter	507	/** Returns a real number in [0, n) */
80	tim	963	RealType randExc( const RealType& n ) {
81	gezelter	507	return mtRand_->randExc(n);
82			}
83	tim	394
84	gezelter	507	/** Returns a real number in (0, 1) */
85	tim	963	RealType randDblExc() {
86	gezelter	507	return mtRand_->randDblExc();
87			}
88	tim	394
89	gezelter	507	/** Returns a real number in (0, n) */
90	tim	963	RealType randDblExc( const RealType& n ) {
91	gezelter	507	return mtRand_->randDblExc(n);
92			}
93	tim	394
94	gezelter	507	/** Returns aninteger in [0,2^32-1] */
95			uint32 randInt() {
96			return mtRand_->randInt();
97			}
98	tim	394
99	gezelter	507	/** Returns aninteger in [0, n] for n < 2^32 */
100			uint32 randInt( const uint32& n ) {
101			return mtRand_->randInt(n);
102			}
103	tim	394
104	tim	963	/** Returns a 53-bitreal number in [0,1) (capacity of IEEE RealType precision) */
105			RealType rand53() {
106	gezelter	507	return mtRand_->rand53();
107			}
108	tim	394
109	gezelter	507	/** Access to nonuniform random number distributions */
110	tim	963	RealType randNorm( const RealType mean, const RealType variance) {
111	gezelter	507	return mtRand_->randNorm(mean, variance);
112			}
113	tim	394
114	gezelter	507	// Re-seeding functions with same behavior as initializers
115			virtual void seed( const uint32 oneSeed ) = 0;
116	tim	394
117	gezelter	507	virtual void seed()= 0;
118	tim	394
119	gezelter	507	protected:
120			MTRand* mtRand_;
121	tim	394
122
123	gezelter	507	};
124	tim	394
125			}
126
127			#endif
128