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

Container class for a general density. More...

#include <RandomHelpers.h>

Inheritance diagram for Herwig::RandomHelpers::Generator< Container< Density > >:

Public Member Functions

 Generator (const Generator< Density > &gen)
 Construct from generator.
 
virtual double lower () const
 Return the lower bound of the density generated.
 
virtual double upper () const
 Return the upper bound of the density generated.
 
virtual double value (double x) const
 Return the density's value.
 
virtual double normalization () const
 Return the density's normalization.
 
virtual double operator() (double r) const
 Generate the return value according to the implemented density, given a flat random number on the unit interval.
 
- Public Member Functions inherited from Herwig::RandomHelpers::Generator< Expression >
virtual ~Generator ()
 The destructor.
 
virtual double lower () const =0
 Return the lower bound of the density generated.
 
virtual double upper () const =0
 Return the upper bound of the density generated.
 
virtual double value (double x) const =0
 Return the density's value.
 
virtual double normalization () const =0
 Return the density's normalization.
 
virtual double operator() (double r) const =0
 Generate the return value according to the implemented density, given a flat random number on the unit interval.
 

Private Attributes

Generator< Density > generator
 The generator.
 

Detailed Description

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

Container class for a general density.

Author
Simon Platzer

Definition at line 132 of file RandomHelpers.h.

Constructor & Destructor Documentation

◆ Generator()

template<class Density >
Herwig::RandomHelpers::Generator< Container< Density > >::Generator ( const Generator< Density > &  gen)
inline

Construct from generator.

Definition at line 145 of file RandomHelpers.h.

Member Function Documentation

◆ lower()

template<class Density >
virtual double Herwig::RandomHelpers::Generator< Container< Density > >::lower ( ) const
inlinevirtual

Return the lower bound of the density generated.

Implements Herwig::RandomHelpers::Generator< Expression >.

Definition at line 151 of file RandomHelpers.h.

References Herwig::RandomHelpers::Generator< Density >::lower().

◆ normalization()

template<class Density >
virtual double Herwig::RandomHelpers::Generator< Container< Density > >::normalization ( ) const
inlinevirtual

Return the density's normalization.

Implements Herwig::RandomHelpers::Generator< Expression >.

Definition at line 166 of file RandomHelpers.h.

References Herwig::RandomHelpers::Generator< Density >::normalization().

◆ operator()()

template<class Density >
virtual double Herwig::RandomHelpers::Generator< Container< Density > >::operator() ( double  r) const
inlinevirtual

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

Implements Herwig::RandomHelpers::Generator< Expression >.

Definition at line 172 of file RandomHelpers.h.

◆ upper()

template<class Density >
virtual double Herwig::RandomHelpers::Generator< Container< Density > >::upper ( ) const
inlinevirtual

Return the upper bound of the density generated.

Implements Herwig::RandomHelpers::Generator< Expression >.

Definition at line 156 of file RandomHelpers.h.

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

◆ value()

template<class Density >
virtual double Herwig::RandomHelpers::Generator< Container< Density > >::value ( double  x) const
inlinevirtual

Return the density's value.

Implements Herwig::RandomHelpers::Generator< Expression >.

Definition at line 161 of file RandomHelpers.h.

References Herwig::RandomHelpers::Generator< Density >::value().

Member Data Documentation

◆ generator

template<class Density >
Generator<Density> Herwig::RandomHelpers::Generator< Container< Density > >::generator
private

The generator.

Definition at line 138 of file RandomHelpers.h.


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