CLHEP VERSION Reference Documentation
   
CLHEP Home Page     CLHEP Documentation     CLHEP Bug Reports

Random/CLHEP/Random/Hurd160Engine.h
Go to the documentation of this file.
1 // $Id: Hurd160Engine.h,v 1.5 2010/06/16 17:24:53 garren Exp $
2 // -*- C++ -*-
3 //
4 // -----------------------------------------------------------------------
5 // HEP Random
6 // --- Hurd160Engine ---
7 // class header file
8 // -----------------------------------------------------------------------
9 //
10 // The starting point for the Hurd Random algorithm is the paper in
11 // IEEE Transactions on Computers c23, 2 Feb 1974. The algorithm is
12 // essentially a series of 32 interconnected b-bit registers. The basic
13 // property is that at each step, bit 1 becomes bit 0, bit 2 the new bit 1,
14 // bit b the new bit b-1. This is modified so that the new bit b0 is the old
15 // bit b1 XOR'd with some bit b-d from the previous bit register. The values
16 // of d can be chosen so as to generate a primitive polynomial, a maximal
17 // length sequence through all bit patterns except the zero pattern.
18 //
19 // This generator, Hurd160 use values based upon Table I of the afore
20 // mentioned paper, such that we have 160 total bits, representing 32
21 // 5-bit registers (actually implemented as an array of 5 32-bit words)
22 // =======================================================================
23 // 07-23-98 KLS Initial draft started
24 // Ken Smith - Added conversion operators: 6th Aug 1998
25 // Mark Fischler - Methods put, get for instance save/restore 12/8/04
26 // Mark Fischler - methods for anonymous save/restore 12/27/04
27 // =======================================================================
28 
29 #ifndef Hurd160Engine_h
30 #define Hurd160Engine_h
31 
32 #include "CLHEP/Random/defs.h"
33 #include "CLHEP/Random/RandomEngine.h"
34 
35 namespace CLHEP {
36 
41 class Hurd160Engine: public HepRandomEngine {
42 
43 public:
44 
45  Hurd160Engine();
46  Hurd160Engine( std::istream &is);
47  Hurd160Engine( long seed );
48  Hurd160Engine( int rowIndex, int colIndex );
49  virtual ~Hurd160Engine();
50  // Constructors and destructor.
51 
52  double flat();
53  // Returns a pseudo random number between 0 and 1
54 
55  void flatArray( const int size, double* vect );
56  // Fills the array "vect" of specified size with flat random values.
57 
58  void setSeed( long seed, int );
59  // Sets the state of the algorithm according to seed.
60 
61  void setSeeds( const long* seeds, int );
62  // Sets the state of the algorithm according to the zero-terminated
63  // array of seeds.
64 
65  void saveStatus( const char filename[] = "Hurd160Engine.conf" ) const;
66  // Saves on named file the current engine status
67 
68  void restoreStatus( const char filename[] = "Hurd160Engine.conf" );
69  // Reads from named file the last saved engine status
70  // and restores it.
71 
72  void showStatus() const;
73  // Dumps the engine status on the screen
74 
75  operator float(); // flat value, without worrying about filling bits
76  operator unsigned int(); // 32-bit flat value, quickest of all
77 
78  virtual std::ostream & put (std::ostream & os) const;
79  virtual std::istream & get (std::istream & is);
80 
81  std::string name() const;
82  static std::string engineName() {return "Hurd160Engine";}
83  static std::string beginTag ( );
84  virtual std::istream & getState ( std::istream & is );
85 
86  std::vector<unsigned long> put () const;
87  bool get (const std::vector<unsigned long> & v);
88  bool getState (const std::vector<unsigned long> & v);
89 
90  static const unsigned int VECTOR_STATE_SIZE = 7;
91 
92 private:
93  static int numEngines;
94  static int maxIndex;
95 
96  void advance();
97 
98  int wordIndex;
99  unsigned int words[5];
100 
101 }; // Hurd160Engine
102 
103 } // namespace CLHEP
104 
105 #ifdef ENABLE_BACKWARDS_COMPATIBILITY
106 // backwards compatibility will be enabled ONLY in CLHEP 1.9
107 using namespace CLHEP;
108 #endif
109 
110 #endif // Hurd160Engine_h
CLHEP::Hurd160Engine::get
virtual std::istream & get(std::istream &is)
Definition: Hurd160Engine.cc:289
CLHEP::Hurd160Engine::restoreStatus
void restoreStatus(const char filename[]="Hurd160Engine.conf")
Definition: Hurd160Engine.cc:190
CLHEP::Hurd160Engine::flatArray
void flatArray(const int size, double *vect)
Definition: Hurd160Engine.cc:143
CLHEP::Hurd160Engine::name
std::string name() const
Definition: Hurd160Engine.cc:42
CLHEP::Hurd160Engine::put
std::vector< unsigned long > put() const
Definition: Hurd160Engine.cc:278
CLHEP::Hurd160Engine::showStatus
void showStatus() const
Definition: Hurd160Engine.cc:227
is
HepRotation and so forth isNear() norm2() rectify() static Rotation row1 row4(To avoid bloat in the code pulled in for programs which don 't use all these features, we split the implementation .cc files. Only isNear() goes into the original Rotation.cc) --------------------------------------- HepAxisAngle and HepEulerAngles classes --------------------------------------- These classes are very useful and simple structures for holding the result of a nice intuituve decomposition of a rotation there is no longer much content in the distinct ZOOM PhysicsVectors library The only content left in the library is the object files representing the various Exception objects When we build the CLHEP classes for the ZOOM we will set up so as to use ZOOM SpaceVector is(but we can disable namespace usage and most of our users do so at this point). What I do is leave Hep3Vector in the global namespace
CLHEP::Hurd160Engine::flat
double flat()
Definition: Hurd160Engine.cc:128
CLHEP::Hurd160Engine::engineName
static std::string engineName()
Definition: Random/CLHEP/Random/Hurd160Engine.h:82
size
user code seldom needs to call this function directly ZMerrno whether or not they are still recorded ZMerrno size() Return the(integer) number of ZMthrow 'n exceptions currently recorded. 5) ZMerrno.clear() Set an internal counter to zero. This counter is available(see next function) to user code to track ZMthrow 'n exceptions that have occurred during any arbitrary time interval. 6) ZMerrno.countSinceCleared() Return the(integer) number of ZMthrow 'n exceptions that have been recorded via ZMerrno.write()
CLHEP::Hurd160Engine::beginTag
static std::string beginTag()
Definition: Hurd160Engine.cc:306
CLHEP::Hurd160Engine::saveStatus
void saveStatus(const char filename[]="Hurd160Engine.conf") const
Definition: Hurd160Engine.cc:161
CLHEP
Definition: ClhepVersion.h:13
v
they are gone ZOOM Features Discontinued The following features of the ZOOM package were felt to be extreme overkill These have been after checking that no existing user code was utilizing as in SpaceVector v
Definition: keyMergeIssues.doc:324
CLHEP::Hurd160Engine::VECTOR_STATE_SIZE
static const unsigned int VECTOR_STATE_SIZE
Definition: Matrix/CLHEP/Random/Hurd160Engine.h:90
seeds
Technical Maintenance Note for CLHEP Random Consequences of seeding JamesRandom with positive seed values greater than In the source code JamesRandom The usual way of seeding a generator is via the default which makes use of the table of seeds(with some trickery to ensure that the values won 't repeat after the table rows are exhausted). The trickery preserves the fact that sees are never negative(because the table values are never negative
CLHEP::Hurd160Engine::~Hurd160Engine
virtual ~Hurd160Engine()
Definition: Hurd160Engine.cc:104
CLHEP::Hurd160Engine::setSeeds
void setSeeds(const long *seeds, int)
Definition: Hurd160Engine.cc:156
CLHEP::Hurd160Engine::getState
virtual std::istream & getState(std::istream &is)
Definition: Hurd160Engine.cc:310
CLHEP::Hurd160Engine::setSeed
void setSeed(long seed, int)
Definition: Hurd160Engine.cc:149
CLHEP::Hurd160Engine::Hurd160Engine
Hurd160Engine()
Definition: Hurd160Engine.cc:55