CORSIKA8  0.0.0
The framework to simulate particle cascades for astroparticle physics
corsika::ExponentialDistribution< Quantity > Class Template Reference

Public Types

typedef Quantity value_type
 

Public Member Functions

 ExponentialDistribution (value_type const &beta)
 
 ExponentialDistribution (ExponentialDistribution< value_type > const &other)
 
ExponentialDistribution< value_type > & operator= (ExponentialDistribution< value_type > const &other)
 
value_type getBeta () const
 Get parameter of exponential distribution

\[ \beta e^{-X}\]

. More...

 
void setBeta (value_type const &beta)
 Set parameter of exponential distribution

\[ \beta e^{-X}\]

. More...

 
template<class Generator >
value_type operator() (Generator &g)
 Generate a random number distributed like

\[ \beta e^{-X}\]

. More...

 

Detailed Description

template<typename Quantity>
class corsika::ExponentialDistribution< Quantity >

Definition at line 17 of file ExponentialDistribution.hpp.

Member Function Documentation

◆ getBeta()

template<typename Quantity>
value_type corsika::ExponentialDistribution< Quantity >::getBeta ( ) const
inline

Get parameter of exponential distribution

\[ \beta e^{-X}\]

.

Precondition
Postcondition
Returns
value_type

Definition at line 47 of file ExponentialDistribution.hpp.

◆ operator()()

template<typename Quantity>
template<class Generator >
value_type corsika::ExponentialDistribution< Quantity >::operator() ( Generator &  g)
inline

Generate a random number distributed like

\[ \beta e^{-X}\]

.

Precondition
Postcondition
Template Parameters
Generator
Parameters
g
Returns

Definition at line 70 of file ExponentialDistribution.hpp.

◆ setBeta()

template<typename Quantity>
void corsika::ExponentialDistribution< Quantity >::setBeta ( value_type const &  beta)
inline

Set parameter of exponential distribution

\[ \beta e^{-X}\]

.

Precondition
Postcondition
Parameters
vBeta

Definition at line 57 of file ExponentialDistribution.hpp.


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