Geant4  10.03
RanecuEngine.cc
Go to the documentation of this file.
1 // $Id:$
2 // -*- C++ -*-
3 //
4 // -----------------------------------------------------------------------
5 // HEP Random
6 // --- RanecuEngine ---
7 // class implementation file
8 // -----------------------------------------------------------------------
9 // This file is part of Geant4 (simulation toolkit for HEP).
10 //
11 // RANECU Random Engine - algorithm originally written in FORTRAN77
12 // as part of the MATHLIB HEP library.
13 
14 // =======================================================================
15 // Gabriele Cosmo - Created - 2nd February 1996
16 // - Minor corrections: 31st October 1996
17 // - Added methods for engine status: 19th November 1996
18 // - Added abs for setting seed index: 11th July 1997
19 // - Modified setSeeds() to handle default index: 16th Oct 1997
20 // - setSeed() now resets the engine status to the original
21 // values in the static table of HepRandom: 19th Mar 1998
22 // J.Marraffino - Added stream operators and related constructor.
23 // Added automatic seed selection from seed table and
24 // engine counter: 16th Feb 1998
25 // Ken Smith - Added conversion operators: 6th Aug 1998
26 // J. Marraffino - Remove dependence on hepString class 13 May 1999
27 // M. Fischler - Add endl to the end of saveStatus 10 Apr 2001
28 // M. Fischler - In restore, checkFile for file not found 03 Dec 2004
29 // M. Fischler - Methods for distrib. instance save/restore 12/8/04
30 // M. Fischler - split get() into tag validation and
31 // getState() for anonymous restores 12/27/04
32 // M. Fischler - put/get for vectors of ulongs 3/14/05
33 // M. Fischler - State-saving using only ints, for portability 4/12/05
34 // M. Fischler - Modify ctor and setSeed to utilize all info provided
35 // and avoid coincidence of same state from different
36 // seeds 6/22/10
37 //
38 // =======================================================================
39 
40 #include "CLHEP/Random/Random.h"
41 #include "CLHEP/Random/RanecuEngine.h"
42 #include "CLHEP/Random/engineIDulong.h"
43 #include "CLHEP/Utility/atomic_int.h"
44 
45 #include <string.h> // for strcmp
46 #include <cmath>
47 #include <cstdlib>
48 
49 namespace CLHEP {
50 
51 namespace {
52  // Number of instances with automatic seed selection
53  CLHEP_ATOMIC_INT_TYPE numberOfEngines(0);
54 }
55 
56 static const int MarkerLen = 64; // Enough room to hold a begin or end marker.
57 
58 static const double prec = 4.6566128E-10;
59 
60 std::string RanecuEngine::name() const {return "RanecuEngine";}
61 
62 void RanecuEngine::further_randomize (int seq1, int col, int index, int modulus)
63 {
64  table[seq1][col] -= (index&0x3FFFFFFF);
65  while (table[seq1][col] <= 0) table[seq1][col] += (modulus-1);
66 } // mf 6/22/10
67 
68 RanecuEngine::RanecuEngine()
69 : HepRandomEngine()
70 {
71  int numEngines = numberOfEngines++;
72  int cycle = std::abs(int(numEngines/maxSeq));
73  seq = std::abs(int(numEngines%maxSeq));
74 
75  theSeed = seq;
76  long mask = ((cycle & 0x007fffff) << 8);
77  for (int i=0; i<2; ++i) {
78  for (int j=0; j<maxSeq; ++j) {
79  HepRandom::getTheTableSeeds(table[j],j);
80  table[j][i] ^= mask;
81  }
82  }
83  theSeeds = &table[seq][0];
84 }
85 
86 RanecuEngine::RanecuEngine(int index)
87 : HepRandomEngine()
88 {
89  int cycle = std::abs(int(index/maxSeq));
90  seq = std::abs(int(index%maxSeq));
91  theSeed = seq;
92  long mask = ((cycle & 0x000007ff) << 20);
93  for (int j=0; j<maxSeq; ++j) {
94  HepRandom::getTheTableSeeds(table[j],j);
95  table[j][0] ^= mask;
96  table[j][1] ^= mask;
97  }
98  theSeeds = &table[seq][0];
99  further_randomize (seq, 0, index, shift1); // mf 6/22/10
100 }
101 
102 RanecuEngine::RanecuEngine(std::istream& is)
103 : HepRandomEngine()
104 {
105  is >> *this;
106 }
107 
108 RanecuEngine::~RanecuEngine() {}
109 
110 void RanecuEngine::setSeed(long index, int dum)
111 {
112  seq = std::abs(int(index%maxSeq));
113  theSeed = seq;
114  HepRandom::getTheTableSeeds(table[seq],seq);
115  theSeeds = &table[seq][0];
116  further_randomize (seq, 0, index, shift1); // mf 6/22/10
117  further_randomize (seq, 1, dum, shift2); // mf 6/22/10
118 }
119 
120 void RanecuEngine::setSeeds(const long* seeds, int pos)
121 {
122  if (pos != -1) {
123  seq = std::abs(int(pos%maxSeq));
124  theSeed = seq;
125  }
126  // only positive seeds are allowed
127  table[seq][0] = std::abs(seeds[0])%shift1;
128  table[seq][1] = std::abs(seeds[1])%shift2;
129  theSeeds = &table[seq][0];
130 }
131 
132 void RanecuEngine::setIndex(long index)
133 {
134  seq = std::abs(int(index%maxSeq));
135  theSeed = seq;
136  theSeeds = &table[seq][0];
137 }
138 
139 void RanecuEngine::saveStatus( const char filename[] ) const
140 {
141  std::ofstream outFile( filename, std::ios::out ) ;
142 
143  if (!outFile.bad()) {
144  outFile << "Uvec\n";
145  std::vector<unsigned long> v = put();
146  for (unsigned int i=0; i<v.size(); ++i) {
147  outFile << v[i] << "\n";
148  }
149  }
150 }
151 
152 void RanecuEngine::restoreStatus( const char filename[] )
153 {
154  std::ifstream inFile( filename, std::ios::in);
155  if (!checkFile ( inFile, filename, engineName(), "restoreStatus" )) {
156  std::cerr << " -- Engine state remains unchanged\n";
157  return;
158  }
159  if ( possibleKeywordInput ( inFile, "Uvec", theSeed ) ) {
160  std::vector<unsigned long> v;
161  unsigned long xin;
162  for (unsigned int ivec=0; ivec < VECTOR_STATE_SIZE; ++ivec) {
163  inFile >> xin;
164  if (!inFile) {
165  inFile.clear(std::ios::badbit | inFile.rdstate());
166  std::cerr << "\nJamesRandom state (vector) description improper."
167  << "\nrestoreStatus has failed."
168  << "\nInput stream is probably mispositioned now." << std::endl;
169  return;
170  }
171  v.push_back(xin);
172  }
173  getState(v);
174  return;
175  }
176 
177  if (!inFile.bad() && !inFile.eof()) {
178 // inFile >> theSeed; removed -- encompased by possibleKeywordInput
179  for (int i=0; i<2; ++i)
180  inFile >> table[theSeed][i];
181  seq = int(theSeed);
182  }
183 }
184 
185 void RanecuEngine::showStatus() const
186 {
187  std::cout << std::endl;
188  std::cout << "--------- Ranecu engine status ---------" << std::endl;
189  std::cout << " Initial seed (index) = " << theSeed << std::endl;
190  std::cout << " Current couple of seeds = "
191  << table[theSeed][0] << ", "
192  << table[theSeed][1] << std::endl;
193  std::cout << "----------------------------------------" << std::endl;
194 }
195 
196 double RanecuEngine::flat()
197 {
198  const int index = seq;
199  long seed1 = table[index][0];
200  long seed2 = table[index][1];
201 
202  int k1 = (int)(seed1/ecuyer_b);
203  int k2 = (int)(seed2/ecuyer_e);
204 
205  seed1 = ecuyer_a*(seed1-k1*ecuyer_b)-k1*ecuyer_c;
206  if (seed1 < 0) seed1 += shift1;
207  seed2 = ecuyer_d*(seed2-k2*ecuyer_e)-k2*ecuyer_f;
208  if (seed2 < 0) seed2 += shift2;
209 
210  table[index][0] = seed1;
211  table[index][1] = seed2;
212 
213  long diff = seed1-seed2;
214 
215  if (diff <= 0) diff += (shift1-1);
216  return (double)(diff*prec);
217 }
218 
219 void RanecuEngine::flatArray(const int size, double* vect)
220 {
221  const int index = seq;
222  long seed1 = table[index][0];
223  long seed2 = table[index][1];
224  int k1, k2;
225  int i;
226 
227  for (i=0; i<size; ++i)
228  {
229  k1 = (int)(seed1/ecuyer_b);
230  k2 = (int)(seed2/ecuyer_e);
231 
232  seed1 = ecuyer_a*(seed1-k1*ecuyer_b)-k1*ecuyer_c;
233  if (seed1 < 0) seed1 += shift1;
234  seed2 = ecuyer_d*(seed2-k2*ecuyer_e)-k2*ecuyer_f;
235  if (seed2 < 0) seed2 += shift2;
236 
237  long diff = seed1-seed2;
238  if (diff <= 0) diff += (shift1-1);
239 
240  vect[i] = (double)(diff*prec);
241  }
242  table[index][0] = seed1;
243  table[index][1] = seed2;
244 }
245 
246 RanecuEngine::operator unsigned int() {
247  const int index = seq;
248  long seed1 = table[index][0];
249  long seed2 = table[index][1];
250 
251  int k1 = (int)(seed1/ecuyer_b);
252  int k2 = (int)(seed2/ecuyer_e);
253 
254  seed1 = ecuyer_a*(seed1-k1*ecuyer_b)-k1*ecuyer_c;
255  if (seed1 < 0) seed1 += shift1;
256  seed2 = ecuyer_d*(seed2-k2*ecuyer_e)-k2*ecuyer_f;
257  if (seed2 < 0) seed2 += shift2;
258 
259  table[index][0] = seed1;
260  table[index][1] = seed2;
261  long diff = seed1-seed2;
262  if( diff <= 0 ) diff += (shift1-1);
263 
264  return ((diff << 1) | (seed1&1))& 0xffffffff;
265 }
266 
267 std::ostream & RanecuEngine::put( std::ostream& os ) const
268 {
269  char beginMarker[] = "RanecuEngine-begin";
270  os << beginMarker << "\nUvec\n";
271  std::vector<unsigned long> v = put();
272  for (unsigned int i=0; i<v.size(); ++i) {
273  os << v[i] << "\n";
274  }
275  return os;
276 }
277 
278 std::vector<unsigned long> RanecuEngine::put () const {
279  std::vector<unsigned long> v;
280  v.push_back (engineIDulong<RanecuEngine>());
281  v.push_back(static_cast<unsigned long>(theSeed));
282  v.push_back(static_cast<unsigned long>(table[theSeed][0]));
283  v.push_back(static_cast<unsigned long>(table[theSeed][1]));
284  return v;
285 }
286 
287 std::istream & RanecuEngine::get ( std::istream& is )
288 {
289  char beginMarker [MarkerLen];
290 
291  is >> std::ws;
292  is.width(MarkerLen); // causes the next read to the char* to be <=
293  // that many bytes, INCLUDING A TERMINATION \0
294  // (Stroustrup, section 21.3.2)
295  is >> beginMarker;
296  if (strcmp(beginMarker,"RanecuEngine-begin")) {
297  is.clear(std::ios::badbit | is.rdstate());
298  std::cerr << "\nInput stream mispositioned or"
299  << "\nRanecuEngine state description missing or"
300  << "\nwrong engine type found." << std::endl;
301  return is;
302  }
303  return getState(is);
304 }
305 
306 std::string RanecuEngine::beginTag ( ) {
307  return "RanecuEngine-begin";
308 }
309 
310 std::istream & RanecuEngine::getState ( std::istream& is )
311 {
312  if ( possibleKeywordInput ( is, "Uvec", theSeed ) ) {
313  std::vector<unsigned long> v;
314  unsigned long uu;
315  for (unsigned int ivec=0; ivec < VECTOR_STATE_SIZE; ++ivec) {
316  is >> uu;
317  if (!is) {
318  is.clear(std::ios::badbit | is.rdstate());
319  std::cerr << "\nRanecuEngine state (vector) description improper."
320  << "\ngetState() has failed."
321  << "\nInput stream is probably mispositioned now." << std::endl;
322  return is;
323  }
324  v.push_back(uu);
325  }
326  getState(v);
327  return (is);
328  }
329 
330 // is >> theSeed; Removed, encompassed by possibleKeywordInput()
331  char endMarker [MarkerLen];
332  for (int i=0; i<2; ++i) {
333  is >> table[theSeed][i];
334  }
335  is >> std::ws;
336  is.width(MarkerLen);
337  is >> endMarker;
338  if (strcmp(endMarker,"RanecuEngine-end")) {
339  is.clear(std::ios::badbit | is.rdstate());
340  std::cerr << "\nRanecuEngine state description incomplete."
341  << "\nInput stream is probably mispositioned now." << std::endl;
342  return is;
343  }
344 
345  seq = int(theSeed);
346  return is;
347 }
348 
349 bool RanecuEngine::get (const std::vector<unsigned long> & v) {
350  if ((v[0] & 0xffffffffUL) != engineIDulong<RanecuEngine>()) {
351  std::cerr <<
352  "\nRanecuEngine get:state vector has wrong ID word - state unchanged\n";
353  return false;
354  }
355  return getState(v);
356 }
357 
358 bool RanecuEngine::getState (const std::vector<unsigned long> & v) {
359  if (v.size() != VECTOR_STATE_SIZE ) {
360  std::cerr <<
361  "\nRanecuEngine get:state vector has wrong length - state unchanged\n";
362  return false;
363  }
364  theSeed = v[1];
365  table[theSeed][0] = v[2];
366  table[theSeed][1] = v[3];
367  seq = int(theSeed);
368  return true;
369 }
370 
371 
372 } // namespace CLHEP
static const int MarkerLen
Definition: DualRand.cc:67
static ush mask[]
Definition: csz_inflate.cc:317
const char * name(G4int ptype)
static const double prec
Definition: RanecuEngine.cc:58
double flat()
Definition: G4AblaRandom.cc:47
static const G4double pos
void setSeeds(const SeedVector &sv)
Set the seeds of the current generator.
Definition: G4INCLRandom.cc:85