From 5e99628815b391601c476b7598c3496ee7c2d285 Mon Sep 17 00:00:00 2001
From: Jean-Marco Alameddine <jean-marco.alameddine@udo.edu>
Date: Tue, 28 Mar 2023 14:59:34 +0000
Subject: [PATCH] Update docstring ExponentialDistribution.hpp
---
corsika/framework/random/ExponentialDistribution.hpp | 10 +++++-----
1 file changed, 5 insertions(+), 5 deletions(-)
diff --git a/corsika/framework/random/ExponentialDistribution.hpp b/corsika/framework/random/ExponentialDistribution.hpp
index ce075ece3..41299ac07 100644
--- a/corsika/framework/random/ExponentialDistribution.hpp
+++ b/corsika/framework/random/ExponentialDistribution.hpp
@@ -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
--
GitLab