CLHEP/Random/RandGamma.h
// $Id: RandGamma.h,v 1.4 2000/04/17 23:00:04 mf Exp $
// -*- C++ -*-
//
// -----------------------------------------------------------------------
// HEP Random
// --- RandGamma ---
// class header file
// -----------------------------------------------------------------------
// Class defining methods for shooting gamma distributed random values,
// given a k (default=1) and specifying also a lambda (default=1).
// Default values are used for operator()().
// Valid input values are k > 0 and lambda > 0. When invalid values are
// presented, the code silently returns -1.0.
// =======================================================================
// John Marraffino - Created: 12th May 1998 Based on the C-Rand package
// by Ernst Stadlober and Franz Niederl of the Technical
// University of Graz, Austria.
// Gabriele Cosmo - Removed useless methods and data: 5th Jan 1999
// =======================================================================
#ifndef RandGamma_h
#define RandGamma_h 1
#include "CLHEP/Random/Random.h"
class RandGamma : public HepRandom {
public:
inline RandGamma ( HepRandomEngine& anEngine, HepDouble k=1.0,
HepDouble lambda=1.0 );
inline RandGamma ( HepRandomEngine* anEngine, HepDouble k=1.0,
HepDouble lambda=1.0 );
// These constructors should be used to instantiate a RandGamma
// distribution object defining a local engine for it.
// The static generator will be skipped using the non-static methods
// defined below.
// If the engine is passed by pointer the corresponding engine object
// will be deleted by the RandGamma destructor.
// If the engine is passed by reference the corresponding engine object
// will not be deleted by the RandGamma destructor.
virtual ~RandGamma();
// Destructor
// Static methods to shoot random values using the static generator
static inline HepDouble shoot();
static HepDouble shoot( HepDouble k, HepDouble lambda );
static void shootArray ( const HepInt size, HepDouble* vect,
HepDouble k=1.0, HepDouble lambda=1.0 );
// Static methods to shoot random values using a given engine
// by-passing the static generator.
static inline HepDouble shoot( HepRandomEngine* anEngine );
static HepDouble shoot( HepRandomEngine* anEngine,
HepDouble k, HepDouble lambda );
static void shootArray ( HepRandomEngine* anEngine, const HepInt size,
HepDouble* vect, HepDouble k=1.0,
HepDouble lambda=1.0 );
// Methods using the localEngine to shoot random values, by-passing
// the static generator.
inline HepDouble fire();
HepDouble fire( HepDouble k, HepDouble lambda );
void fireArray ( const HepInt size, HepDouble* vect);
void fireArray ( const HepInt size, HepDouble* vect,
HepDouble k, HepDouble lambda );
inline HepDouble operator()();
inline HepDouble operator()( HepDouble k, HepDouble lambda );
private:
// Private copy constructor. Defining it here disallows use.
RandGamma(const RandGamma& d);
static HepDouble genGamma( HepRandomEngine *anEngine, HepDouble k,
HepDouble lambda );
HepRandomEngine* localEngine;
HepBoolean deleteEngine;
const HepDouble defaultK;
const HepDouble defaultLambda;
};
#include "CLHEP/Random/RandGamma.icc"
#endif
Generated by GNU enscript 1.6.1.