src/math/SeqRandNumGen.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_SEQRANDNUMGEN_HPP
#define MATH_SEQRANDNUMGEN_HPP

#include <vector>

#include "utils/simError.h"
#include "math/RandNumGen.hpp"

namespace OpenMD {

  /**
   * @class SeqRandNumGen 
   * @brief a sequential random number generator
   */
  class SeqRandNumGen : public RandNumGen{
  public:
    typedef unsigned long uint32; 
        
    SeqRandNumGen( const uint32& oneSeed);

    SeqRandNumGen();
        
    virtual void seed( const uint32 oneSeed );
        
    virtual void seed();

  private:
    SeqRandNumGen(const SeqRandNumGen&);
    SeqRandNumGen& operator =(const SeqRandNumGen&);
         
    static int nCreatedRNG_; /**< number of created random number of generator*/

  };

}


#endif 

Revision:	1850
Committed:	Wed Feb 20 15:39:39 2013 UTC (12 years, 2 months ago) by gezelter
File size:	2888 byte(s)
Log Message:	Fixed a widespread typo in the license
#	User	Rev	Content
1	gezelter	507	/*
2	tim	392	* 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	392	* 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	392	* 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	392	*/
42
43			#ifndef MATH_SEQRANDNUMGEN_HPP
44			#define MATH_SEQRANDNUMGEN_HPP
45
46			#include <vector>
47
48			#include "utils/simError.h"
49			#include "math/RandNumGen.hpp"
50
51	gezelter	1390	namespace OpenMD {
52	tim	392
53	gezelter	507	/**
54	gezelter	1808	* @class SeqRandNumGen
55			* @brief a sequential random number generator
56	gezelter	507	*/
57			class SeqRandNumGen : public RandNumGen{
58			public:
59			typedef unsigned long uint32;
60	tim	392
61	gezelter	507	SeqRandNumGen( const uint32& oneSeed);
62	tim	392
63	gezelter	507	SeqRandNumGen();
64	tim	392
65	gezelter	507	virtual void seed( const uint32 oneSeed );
66	tim	392
67	gezelter	507	virtual void seed();
68	tim	392
69	gezelter	507	private:
70			SeqRandNumGen(const SeqRandNumGen&);
71			SeqRandNumGen& operator =(const SeqRandNumGen&);
72	tim	393
73	gezelter	507	static int nCreatedRNG_; /*< number of created random number of generator/
74	tim	392
75	gezelter	507	};
76	tim	392
77			}
78
79
80			#endif
81