IAP GITLAB

Skip to content
Snippets Groups Projects
Commit 5e996288 authored by Jean-Marco Alameddine's avatar Jean-Marco Alameddine
Browse files

Update docstring ExponentialDistribution.hpp

parent 8074e2b4
No related branches found
No related tags found
1 merge request!493Update docstring ExponentialDistribution.hpp
Pipeline #10226 passed with warnings
...@@ -14,8 +14,8 @@ ...@@ -14,8 +14,8 @@
namespace corsika { namespace corsika {
/** /**
* Describes a random distribution with \f[ \beta e^{-X} \f] for a physical quantity of * Describes a random distribution with \f[ \beta e^{-\beta X} \f] for a physical
* type Quantity. * quantity of type Quantity.
* *
* @tparam Quantity is the type of the physical quantity. * @tparam Quantity is the type of the physical quantity.
*/ */
...@@ -46,7 +46,7 @@ namespace corsika { ...@@ -46,7 +46,7 @@ namespace corsika {
/** /**
* @fn value_type getBeta() const * @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 * @return value_type
*/ */
...@@ -54,7 +54,7 @@ namespace corsika { ...@@ -54,7 +54,7 @@ namespace corsika {
/** /**
* @fn void setBeta(value_type) * @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 * @param vBeta
*/ */
...@@ -62,7 +62,7 @@ namespace corsika { ...@@ -62,7 +62,7 @@ namespace corsika {
/** /**
* @fn value_type operator ()(Generator&) * @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 * @tparam Generator
* @param g * @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