corsika::ExponentialDistribution< Quantity > Class Template Reference

Describes a random distribution with

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

for a physical quantity of type Quantity. More...

#include <ExponentialDistribution.hpp>

Public Types
typedef Quantity	value_type

Public Member Functions
	ExponentialDistribution (value_type 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^{-\beta X}\] . More...
void	setBeta (value_type const &beta)
	Set parameter of exponential distribution \[ \beta e^{-\beta X}\] . More...
template<class Generator >
value_type	operator() (Generator &g)
	Generate a random number distributed like \[ \beta e^{-\beta X}\] . More...

Detailed Description

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

Describes a random distribution with

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

for a physical quantity of type Quantity.

Template Parameters

Quantity

is the type of the physical quantity.

Definition at line 24 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^{-\beta X}\]

.

Returns

value_type

Definition at line 54 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^{-\beta X}\]

.

Template Parameters

Generator

Parameters

g

Returns

Definition at line 73 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^{-\beta X}\]

.

Parameters

vBeta

Definition at line 62 of file ExponentialDistribution.hpp.

---

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

• corsika/framework/random/ExponentialDistribution.hpp