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]  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 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:	1665
Committed:	Tue Nov 22 20:38:56 2011 UTC (13 years, 5 months ago) by gezelter
File size:	4114 byte(s)
Log Message:	updated copyright notices
#	Content
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. Redistributions of source code must retain the above copyright
10	* notice, this list of conditions and the following disclaimer.
11	*
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.
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	*
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 OpenMD {
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	RealType rand() {
67	return mtRand_->rand();
68	}
69
70	/** Returns a real number in [0, n] */
71	RealType rand( const RealType& n ) {
72	return mtRand_->rand(n);
73	}
74
75	/** Returns a real number in [0, 1) */
76	RealType randExc() {
77	return mtRand_->randExc();
78	}
79
80	/** Returns a real number in [0, n) */
81	RealType randExc( const RealType& n ) {
82	return mtRand_->randExc(n);
83	}
84
85	/** Returns a real number in (0, 1) */
86	RealType randDblExc() {
87	return mtRand_->randDblExc();
88	}
89
90	/** Returns a real number in (0, n) */
91	RealType randDblExc( const RealType& 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 RealType precision) */
106	RealType rand53() {
107	return mtRand_->rand53();
108	}
109
110	/** Access to nonuniform random number distributions */
111	RealType randNorm( const RealType mean, const RealType 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	MTRand* mtRand_;
122
123
124	};
125
126	}
127
128	#endif
129