IAP GITLAB

Skip to content
Snippets Groups Projects
Commit c1ac012c authored by Maximilian Reininghaus's avatar Maximilian Reininghaus :vulcan:
Browse files

Merge branch 'JAlameddine-master-patch-04649' into 'master'

Update docstring ExponentialDistribution.hpp

See merge request !493
parents 8074e2b4 dbbd7ad3
No related branches found
No related tags found
1 merge request!493Update docstring ExponentialDistribution.hpp
Pipeline #10232 passed with warnings
......@@ -14,8 +14,8 @@
namespace corsika {
/**
* Describes a random distribution with \f[ \beta e^{-X} \f] for a physical quantity of
* type Quantity.
* Describes a random distribution with \f[ \beta e^{-\beta X} \f] for a physical
* quantity of type Quantity.
*
* @tparam Quantity is the type of the physical quantity.
*/
......@@ -46,7 +46,7 @@ namespace corsika {
/**
* @fn value_type getBeta() const
* @brief Get parameter of exponential distribution \f[ \beta e^{-X}\f].
* @brief Get parameter of exponential distribution \f[ \beta e^{-\beta X}\f].
*
* @return value_type
*/
......@@ -54,7 +54,7 @@ namespace corsika {
/**
* @fn void setBeta(value_type)
* @brief Set parameter of exponential distribution \f[ \beta e^{-X}\f].
* @brief Set parameter of exponential distribution \f[ \beta e^{-\beta X}\f].
*
* @param vBeta
*/
......@@ -62,7 +62,7 @@ namespace corsika {
/**
* @fn value_type operator ()(Generator&)
* @brief Generate a random number distributed like \f[ \beta e^{-X}\f].
* @brief Generate a random number distributed like \f[ \beta e^{-\beta X}\f].
*
* @tparam Generator
* @param g
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment