bpp-core3  3.0.0
Uniform01K.cpp
Go to the documentation of this file.
1 //
2 // File: Uniform01K.cpp
3 // Authors:
4 // Sylvain Gaillard
5 // Last modified: 2004-09-24 00:00:00
6 //
7 
8 /*
9  Copyright or © or Copr. CNRS, (November 17, 2004)
10 
11  This software is a computer program whose purpose is to provide classes
12  for numerical calculus.
13 
14  This software is governed by the CeCILL license under French law and
15  abiding by the rules of distribution of free software. You can use,
16  modify and/ or redistribute the software under the terms of the CeCILL
17  license as circulated by CEA, CNRS and INRIA at the following URL
18  "http://www.cecill.info".
19 
20  As a counterpart to the access to the source code and rights to copy,
21  modify and redistribute granted by the license, users are provided only
22  with a limited warranty and the software's author, the holder of the
23  economic rights, and the successive licensors have only limited
24  liability.
25 
26  In this respect, the user's attention is drawn to the risks associated
27  with loading, using, modifying and/or developing or reproducing the
28  software by the user in light of its specific status of free software,
29  that may mean that it is complicated to manipulate, and that also
30  therefore means that it is reserved for developers and experienced
31  professionals having in-depth computer knowledge. Users are therefore
32  encouraged to load and test the software's suitability as regards their
33  requirements in conditions enabling the security of their systems and/or
34  data to be ensured and, more generally, to use and operate it in the
35  same conditions as regards security.
36 
37  The fact that you are presently reading this means that you have had
38  knowledge of the CeCILL license and that you accept its terms.
39 */
40 
41 
42 #include "../NumTools.h"
43 #include "Uniform01K.h"
44 
45 using namespace bpp;
46 
47 const long Uniform01K::MAXNUMBER = 1000000000;
48 const long Uniform01K::ZERO = 0;
49 const long Uniform01K::MODSEED = 256434901;
50 
51 // ** Class constructor: *******************************************************/
52 
54  _it1(), _it2()
55 {
56  setSeed(seed);
57 }
58 
59 // ** Class destructor: *******************************************************/
61 
62 // ** Other methodes: *********************************************************/
63 
64 void Uniform01K::setSeed(long seed)
65 {
66  long tmp1, tmp2;
67  unsigned short i, ii, j;
68  tmp1 = NumTools::abs(MODSEED - NumTools::abs(seed));
69  tmp1 %= MAXNUMBER;
70  _tab[55] = tmp1;
71  tmp2 = 1;
72 
73  for (i = 1; i <= 54; i++)
74  {
75  ii = static_cast<unsigned short>((21 * i) % 55);
76  _tab[ii] = tmp2;
77  tmp2 = tmp1 - tmp2;
78 
79  if (tmp2 < ZERO)
80  tmp2 += MAXNUMBER;
81 
82  tmp1 = _tab[ii];
83  }
84 
85  for (j = 1; j <= 4; j++)
86  {
87  for (i = 1; i <= 55; i++)
88  {
89  _tab[i] -= _tab[1 + (i + 30) % 55];
90  if (_tab[i] < ZERO)
91  _tab[i] += MAXNUMBER;
92  }
93  }
94  _it1 = 0;
95  _it2 = 31;
96 }
97 
98 double Uniform01K::drawNumber() const
99 {
100  if (++_it1 == 56)
101  _it1 = 1;
102  if (++_it2 == 56)
103  _it2 = 1;
104 
105  long tmp = _tab[_it1] - _tab[_it2];
106  if (tmp < ZERO)
107  tmp += MAXNUMBER;
108  _tab[_it2] = tmp;
109  double r = static_cast<double>(static_cast<long double>(tmp) / MAXNUMBER);
110  // if (r < 0.) return drawNumber(); // In case of negative number, take the next one in the serie.
111  // if (r > 1.) return drawNumber(); // In case of number > 1, take the next one in the serie.
112  return r;
113 }
static T abs(T a)
Get the magnitude of a value.
Definition: NumTools.h:67
static const long ZERO
Definition: Uniform01K.h:89
static const long MODSEED
Definition: Uniform01K.h:90
virtual ~Uniform01K()
Destroy the generator.
Definition: Uniform01K.cpp:60
void setSeed(long seed)
Set the seed for a new set of random numbers.
Definition: Uniform01K.cpp:64
unsigned int _it1
Definition: Uniform01K.h:92
unsigned int _it2
Definition: Uniform01K.h:93
long _tab[56]
Definition: Uniform01K.h:91
double drawNumber() const
Get a random number between 0.0 and 1.0 (exclusive of the end point values).
Definition: Uniform01K.cpp:98
static const long MAXNUMBER
Definition: Uniform01K.h:88
Uniform01K(long seed)
Create a Random Number Generator.
Definition: Uniform01K.cpp:53