G4INCL::Random Namespace Reference

Classes
class	Adapter
class	SeedVector

Functions
void	setGenerator (G4INCL::IRandomGenerator *aGenerator)
void	setSeeds (const SeedVector &sv)
SeedVector	getSeeds ()
G4double	shoot ()
G4double	shoot0 ()
G4double	shoot1 ()
template<typename T >
T	shootInteger (T n)
G4double	gauss (G4double sigma=1.)
ThreeVector	normVector (G4double norm=1.)
ThreeVector	sphereVector (G4double rmax=1.)
ThreeVector	gaussVector (G4double sigma=1.)
	Generate Gaussianly-distributed ThreeVectors. More...
std::pair< G4double, G4double >	correlatedGaussian (const G4double corrCoeff, const G4double x0=0., const G4double sigma=1.)
	Generate pairs of correlated Gaussian random numbers. More...
std::pair< G4double, G4double >	correlatedUniform (const G4double corrCoeff)
	Generate pairs of correlated uniform random numbers. More...
void	deleteGenerator ()
G4bool	isInitialized ()
void	saveSeeds ()
	Save the status of the random-number generator. More...
SeedVector	getSavedSeeds ()
	Get the saved status of the random-number generator. More...
void	initialize (Config const *const)
	Initialize generator according to a Config object. More...
Adapter const &	getAdapter ()
std::ostream &	operator<< (std::ostream &out, SeedVector const &sv)

Function Documentation

std::pair< G4double, G4double > G4INCL::Random::correlatedGaussian	(	const G4double	corrCoeff,
		const G4double	x0 = 0.,
		const G4double	sigma = 1.
	)

Generate pairs of correlated Gaussian random numbers.

Definition at line 155 of file G4INCLRandom.cc.

                                                                                                                     {
// assert(corrCoeff<=1. && corrCoeff>=-1.);
      G4double factor = 1.-corrCoeff*corrCoeff;
      if(factor<=0.)
        factor=0.;
      const G4double x = gauss(sigma) + x0;
      const G4double y = corrCoeff * x + gauss(sigma*std::sqrt(factor)) + x0;
      return std::make_pair(x, y);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

std::pair< G4double, G4double > G4INCL::Random::correlatedUniform

(

const G4double

corrCoeff

)

Generate pairs of correlated uniform random numbers.

Definition at line 165 of file G4INCLRandom.cc.

                                                                           {
      std::pair<G4double,G4double> gaussians = correlatedGaussian(corrCoeff);
      return std::make_pair(Math::gaussianCDF(gaussians.first), Math::gaussianCDF(gaussians.second));
    }

Here is the call graph for this function:

void G4INCL::Random::deleteGenerator

(

)

Delete the generator

Definition at line 170 of file G4INCLRandom.cc.

                           {
      delete theGenerator;
      theGenerator = NULL;
      delete savedSeeds;
      savedSeeds = NULL;
      delete theAdapter;
      theAdapter = NULL;
    }

Here is the caller graph for this function:

G4double G4INCL::Random::gauss

(

G4double

sigma = 1.

)

Generate random numbers using gaussian distribution.

Definition at line 114 of file G4INCLRandom.cc.

                                   {
      // generate a Gaussian random number with standard deviation sigma
      // uses the flat() and flat0() methods
      static G4ThreadLocal G4bool generated = false;
      static G4ThreadLocal G4double u, v;

      if( !generated )
      {
        u = shoot0();
        v = Math::twoPi*shoot();
        generated = true;
        return sigma*std::sqrt(-2*std::log(u))*std::cos(v);
      }
      else
      {
        generated = false;
        return sigma*std::sqrt(-2*std::log(u))*std::sin(v);
      }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

ThreeVector G4INCL::Random::gaussVector

(

G4double

sigma = 1.

)

Generate Gaussianly-distributed ThreeVectors.

Generate ThreeVectors that are distributed as a three-dimensional Gaussian of the given sigma.

Definition at line 150 of file G4INCLRandom.cc.

                                            {
      const G4double sigmax = sigma * Math::oneOverSqrtThree;
      return ThreeVector(gauss(sigmax), gauss(sigmax), gauss(sigmax));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Adapter const & G4INCL::Random::getAdapter

(

)

Definition at line 227 of file G4INCLRandom.cc.

                                {
      return *theAdapter;
    }

SeedVector G4INCL::Random::getSavedSeeds

(

)

Get the saved status of the random-number generator.

Definition at line 198 of file G4INCLRandom.cc.

                               {
      if(!savedSeeds)
        savedSeeds = new SeedVector;

      return *savedSeeds;
    }

SeedVector G4INCL::Random::getSeeds

(

)

Get the seeds of the current generator.

Definition at line 89 of file G4INCLRandom.cc.

                          {
      return theGenerator->getSeeds();
    }

Here is the caller graph for this function:

void G4INCL::Random::initialize

(

Config const * const

)

Initialize generator according to a Config object.

Definition at line 205 of file G4INCLRandom.cc.

                      {
#ifdef INCLXX_IN_GEANT4_MODE
      Random::setGenerator(new Geant4RandomGenerator());
#else // INCLXX_IN_GEANT4_MODE
      RNGType rng = theConfig->getRNGType();
      if(rng == RanecuType)
        setGenerator(new Ranecu(theConfig->getRandomSeeds()));
      else if(rng == Ranecu3Type)
        setGenerator(new Ranecu3(theConfig->getRandomSeeds()));
      else
        setGenerator(NULL);
#endif // INCLXX_IN_GEANT4_MODE
    }

Here is the call graph for this function:

Here is the caller graph for this function:

G4bool G4INCL::Random::isInitialized

(

)

Check if the generator is initialized.

Definition at line 179 of file G4INCLRandom.cc.

                           {
      if(theGenerator == 0) return false;
      return true;
    }

Here is the caller graph for this function:

ThreeVector G4INCL::Random::normVector

(

G4double

norm = 1.

)

Generate isotropically-distributed ThreeVectors of given norm.

Definition at line 134 of file G4INCLRandom.cc.

                                          {

      const G4double ctheta = (1.-2.*shoot());
      const G4double stheta = std::sqrt(1.-ctheta*ctheta);
      const G4double phi = Math::twoPi*shoot();
      return ThreeVector(
                         norm * stheta * std::cos(phi),
                         norm * stheta * std::sin(phi),
                         norm * ctheta);

    }

Here is the call graph for this function:

Here is the caller graph for this function:

std::ostream& G4INCL::Random::operator<<	(	std::ostream &	out,
		SeedVector const &	sv
	)

Definition at line 50 of file G4INCLRandomSeedVector.cc.

                                                                  {
      if(sv.size()<=0)
        return out;
      for(size_t i=0; i<sv.size()-1; ++i)
        out << sv.at(i) << '\t';
      out << sv.at(sv.size()-1);
      return out;
    }

void G4INCL::Random::saveSeeds

(

)

Save the status of the random-number generator.

Definition at line 191 of file G4INCLRandom.cc.

                     {
      if(!savedSeeds)
        savedSeeds = new SeedVector;

      (*savedSeeds) = theGenerator->getSeeds();
    }

void G4INCL::Random::setGenerator

(

G4INCL::IRandomGenerator *

aGenerator

)

Set the random number generator implementation to be used globally by INCL.

See Also

G4INCL::IRandomGenerator

Definition at line 72 of file G4INCLRandom.cc.

                                                          {
      if(isInitialized()) {
        INCL_ERROR("INCL random number generator already initialized." << '\n');
      } else {
#ifdef INCL_COUNT_RND_CALLS
        nCalls = 0;
#endif
        theGenerator = aGenerator;
      }
      if(!theAdapter)
        theAdapter = new Adapter();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

void G4INCL::Random::setSeeds

(

const SeedVector &

sv

)

Set the seeds of the current generator.

Definition at line 85 of file G4INCLRandom.cc.

                                        {
      theGenerator->setSeeds(sv);
    }

G4double G4INCL::Random::shoot

(

)

Generate flat distribution of random numbers.

Definition at line 93 of file G4INCLRandom.cc.

                     {
#ifdef INCL_COUNT_RND_CALLS
      nCalls++;
#endif
      return theGenerator->flat();
    }

Here is the caller graph for this function:

G4double G4INCL::Random::shoot0

(

)

Return a random number in the ]0,1] interval

Definition at line 100 of file G4INCLRandom.cc.

                      {
      G4double r;
      while( (r=shoot()) <= 0. ) /* Loop checking, 10.07.2015, D.Mancusi */
        ;
      return r;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

G4double G4INCL::Random::shoot1

(

)

Return a random number in the [0,1[ interval

Definition at line 107 of file G4INCLRandom.cc.

                      {
      G4double r;
      while( (r=shoot()) >= 1. ) /* Loop checking, 10.07.2015, D.Mancusi */
        ;
      return r;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

template<typename T >

T G4INCL::Random::shootInteger

(

T

n

)

Return a random integer in the [0,n[ interval

Definition at line 96 of file G4INCLRandom.hh.

                                            {
      return static_cast<T>(shoot1() * n);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

ThreeVector G4INCL::Random::sphereVector

(

G4double

rmax = 1.

)

Generate ThreeVectors that are uniformly distributed in a sphere of radius rmax.

Definition at line 146 of file G4INCLRandom.cc.

                                            {
      return normVector( rmax*Math::pow13(shoot0()) );
    }

Here is the call graph for this function: