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

Generate x with density 1/|x-z|. More...

#include <RandomHelpers.h>

Public Member Functions

 Generator (double z, double l, double u)
 Construct from pole and boundaries.
 
double lower () const
 Return the lower bound of the density generated.
 
double upper () const
 Return the upper bound of the density generated.
 
double pole () const
 Return the position of the pole.
 
double scale () const
 Return the scale for random numbers.
 
double offset () const
 Return the offset for random mnumbers.
 
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

double thePole
 The position of the pole.
 
double theLower
 The lower bound.
 
double theUpper
 The upper bound.
 
double theScale
 Scale for random numbers.
 
double theOffset
 Offset for random mnumbers.
 

Detailed Description

Generate x with density 1/|x-z|.

Author
Simon Platzer

Definition at line 989 of file RandomHelpers.h.

Constructor & Destructor Documentation

◆ Generator()

Herwig::RandomHelpers::Generator< Inverse >::Generator ( double  z,
double  l,
double  u 
)
inline

Construct from pole and boundaries.

Definition at line 1021 of file RandomHelpers.h.

Member Function Documentation

◆ lower()

double Herwig::RandomHelpers::Generator< Inverse >::lower ( ) const
inline

Return the lower bound of the density generated.

Definition at line 1034 of file RandomHelpers.h.

◆ normalization()

double Herwig::RandomHelpers::Generator< Inverse >::normalization ( ) const
inline

Return the density's normalization.

Definition at line 1066 of file RandomHelpers.h.

◆ offset()

double Herwig::RandomHelpers::Generator< Inverse >::offset ( ) const
inline

Return the offset for random mnumbers.

Definition at line 1054 of file RandomHelpers.h.

◆ operator()()

double Herwig::RandomHelpers::Generator< Inverse >::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 1074 of file RandomHelpers.h.

References Herwig::RandomHelpers::sign(), and Herwig::RandomHelpers::Generator< Density >::upper().

◆ pole()

double Herwig::RandomHelpers::Generator< Inverse >::pole ( ) const
inline

Return the position of the pole.

Definition at line 1044 of file RandomHelpers.h.

◆ scale()

double Herwig::RandomHelpers::Generator< Inverse >::scale ( ) const
inline

Return the scale for random numbers.

Definition at line 1049 of file RandomHelpers.h.

◆ upper()

double Herwig::RandomHelpers::Generator< Inverse >::upper ( ) const
inline

Return the upper bound of the density generated.

Definition at line 1039 of file RandomHelpers.h.

◆ value()

double Herwig::RandomHelpers::Generator< Inverse >::value ( double  x) const
inline

Member Data Documentation

◆ theLower

double Herwig::RandomHelpers::Generator< Inverse >::theLower
private

The lower bound.

Definition at line 999 of file RandomHelpers.h.

◆ theOffset

double Herwig::RandomHelpers::Generator< Inverse >::theOffset
private

Offset for random mnumbers.

Definition at line 1014 of file RandomHelpers.h.

◆ thePole

double Herwig::RandomHelpers::Generator< Inverse >::thePole
private

The position of the pole.

Definition at line 994 of file RandomHelpers.h.

◆ theScale

double Herwig::RandomHelpers::Generator< Inverse >::theScale
private

Scale for random numbers.

Definition at line 1009 of file RandomHelpers.h.

◆ theUpper

double Herwig::RandomHelpers::Generator< Inverse >::theUpper
private

The upper bound.

Definition at line 1004 of file RandomHelpers.h.


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