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, 234107 (2008).          
 * [4]  Kuang & Gezelter,  J. Chem. Phys. 133, 164101 (2010).
 * [5]  Vardeman, Stocker & Gezelter, J. Chem. Theory Comput. 7, 834 (2011).
 */

#ifndef MATH_RANDNUMGEN_HPP
#define MATH_RANDNUMGEN_HPP

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


namespace OpenMD {

  /**
   * @class RandNumGen 
   * @brief 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:	1850
Committed:	Wed Feb 20 15:39:39 2013 UTC (12 years, 2 months ago) by gezelter
File size:	4128 byte(s)
Log Message:	Fixed a widespread typo in the license
#	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	gezelter	1850	* [3] Sun, Lin & Gezelter, J. Chem. Phys. 128, 234107 (2008).
39	gezelter	1665	* [4] Kuang & Gezelter, J. Chem. Phys. 133, 164101 (2010).
40			* [5] Vardeman, Stocker & Gezelter, J. Chem. Theory Comput. 7, 834 (2011).
41	tim	394	*/
42
43			#ifndef MATH_RANDNUMGEN_HPP
44			#define MATH_RANDNUMGEN_HPP
45
46			#include <vector>
47	tim	963	#include "config.h"
48	tim	394	#include "MersenneTwister.hpp"
49			#include "utils/simError.h"
50
51
52	gezelter	1390	namespace OpenMD {
53	tim	394
54	gezelter	507	/**
55	gezelter	1808	* @class RandNumGen
56			* @brief a random number generator class
57	gezelter	507	*/
58			class RandNumGen{
59			public:
60			typedef unsigned long uint32;
61	tim	394
62	gezelter	507	virtual ~RandNumGen() {
63			delete mtRand_;
64			}
65	tim	394
66	gezelter	507	/** Returns a real number in [0,1] */
67	tim	963	RealType rand() {
68	gezelter	507	return mtRand_->rand();
69			}
70	tim	394
71	gezelter	507	/** Returns a real number in [0, n] */
72	tim	963	RealType rand( const RealType& n ) {
73	gezelter	507	return mtRand_->rand(n);
74			}
75	tim	394
76	gezelter	507	/** Returns a real number in [0, 1) */
77	tim	963	RealType randExc() {
78	gezelter	507	return mtRand_->randExc();
79			}
80	tim	394
81	gezelter	507	/** Returns a real number in [0, n) */
82	tim	963	RealType randExc( const RealType& n ) {
83	gezelter	507	return mtRand_->randExc(n);
84			}
85	tim	394
86	gezelter	507	/** Returns a real number in (0, 1) */
87	tim	963	RealType randDblExc() {
88	gezelter	507	return mtRand_->randDblExc();
89			}
90	tim	394
91	gezelter	507	/** Returns a real number in (0, n) */
92	tim	963	RealType randDblExc( const RealType& n ) {
93	gezelter	507	return mtRand_->randDblExc(n);
94			}
95	tim	394
96	gezelter	507	/** Returns aninteger in [0,2^32-1] */
97			uint32 randInt() {
98			return mtRand_->randInt();
99			}
100	tim	394
101	gezelter	507	/** Returns aninteger in [0, n] for n < 2^32 */
102			uint32 randInt( const uint32& n ) {
103			return mtRand_->randInt(n);
104			}
105	tim	394
106	tim	963	/** Returns a 53-bitreal number in [0,1) (capacity of IEEE RealType precision) */
107			RealType rand53() {
108	gezelter	507	return mtRand_->rand53();
109			}
110	tim	394
111	gezelter	507	/** Access to nonuniform random number distributions */
112	tim	963	RealType randNorm( const RealType mean, const RealType variance) {
113	gezelter	507	return mtRand_->randNorm(mean, variance);
114			}
115	tim	394
116	gezelter	507	// Re-seeding functions with same behavior as initializers
117			virtual void seed( const uint32 oneSeed ) = 0;
118	tim	394
119	gezelter	507	virtual void seed()= 0;
120	tim	394
121	gezelter	507	protected:
122			MTRand* mtRand_;
123	tim	394
124
125	gezelter	507	};
126	tim	394
127			}
128
129			#endif
130