herwig is hosted by Hepforge, IPPP Durham
Herwig 7.3.0
Herwig::RandomHelpers::Generator< Rescale< Density > > Class Template Reference

Generate a rescaled density. More...

#include <RandomHelpers.h>

Public Member Functions

 Generator (const Generator< Density > &gen, double sc)
 Construct from generator and scale.
 
const Generator< Density > & generator () const
 Return the generator.
 
double scale () const
 Return the scale.
 
double lower () const
 Return the lower bound of the density generated.
 
double upper () const
 Return the upper bound of the density generated.
 
double value (double x) const
 Return the density's value.
 
double normalization () const
 Return the density's normalization.
 
double operator() (double r) const
 Generate the return value according to the implemented density, given a flat random number on the unit interval.
 

Private Attributes

Generator< Density > theGenerator
 The underlying generator.
 
double theScale
 The rescaling factor.
 

Detailed Description

template<class Density>
class Herwig::RandomHelpers::Generator< Rescale< Density > >

Generate a rescaled density.

Author
Simon Platzer

Definition at line 336 of file RandomHelpers.h.

Constructor & Destructor Documentation

◆ Generator()

template<class Density >
Herwig::RandomHelpers::Generator< Rescale< Density > >::Generator ( const Generator< Density > &  gen,
double  sc 
)
inline

Construct from generator and scale.

Definition at line 353 of file RandomHelpers.h.

Member Function Documentation

◆ generator()

template<class Density >
const Generator< Density > & Herwig::RandomHelpers::Generator< Rescale< Density > >::generator ( ) const
inline

Return the generator.

Definition at line 361 of file RandomHelpers.h.

◆ lower()

template<class Density >
double Herwig::RandomHelpers::Generator< Rescale< Density > >::lower ( ) const
inline

Return the lower bound of the density generated.

Definition at line 371 of file RandomHelpers.h.

◆ normalization()

template<class Density >
double Herwig::RandomHelpers::Generator< Rescale< Density > >::normalization ( ) const
inline

Return the density's normalization.

Definition at line 388 of file RandomHelpers.h.

◆ operator()()

template<class Density >
double Herwig::RandomHelpers::Generator< Rescale< Density > >::operator() ( double  r) const
inline

Generate the return value according to the implemented density, given a flat random number on the unit interval.

Definition at line 396 of file RandomHelpers.h.

◆ scale()

template<class Density >
double Herwig::RandomHelpers::Generator< Rescale< Density > >::scale ( ) const
inline

Return the scale.

Definition at line 366 of file RandomHelpers.h.

◆ upper()

template<class Density >
double Herwig::RandomHelpers::Generator< Rescale< Density > >::upper ( ) const
inline

Return the upper bound of the density generated.

Definition at line 376 of file RandomHelpers.h.

◆ value()

template<class Density >
double Herwig::RandomHelpers::Generator< Rescale< Density > >::value ( double  x) const
inline

Return the density's value.

Definition at line 381 of file RandomHelpers.h.

Member Data Documentation

◆ theGenerator

template<class Density >
Generator<Density> Herwig::RandomHelpers::Generator< Rescale< Density > >::theGenerator
private

The underlying generator.

Definition at line 341 of file RandomHelpers.h.

◆ theScale

template<class Density >
double Herwig::RandomHelpers::Generator< Rescale< Density > >::theScale
private

The rescaling factor.

Definition at line 346 of file RandomHelpers.h.


The documentation for this class was generated from the following file: