The LogNormalDistribution takes in parameters scale and shape.

The parameters are the mean and standard deviation of the logarithm of the
random value X. Other libraries use mean (mu) and sigma for the parameters.
These are the parameters used on:

- Wikipedia: mu, sigma [1]
- Matlab: mu, sigma [2]
- R: meanLog, sdLog [3]
- Wolfram: mu, sigma [4]

The distribution defines a mean and variance. These are not directly the
values of mu and sigma^2. So using mean as a parameter name is misleading.
However using shape and scale is not standard. No references I found refer
to these parameters as shape and scale parameters.

I would suggest changing to mu and sigma with the getters getMu and
getSigma. These can be documented as returning the mean and standard
deviation of the logarithm of the random variable X.

Alex


[1] https://en.wikipedia.org/wiki/Log-normal_distribution
[2] https://uk.mathworks.com/help/stats/prob.lognormaldistribution.html
[3] https://stat.ethz.ch/R-manual/R-devel/library/stats/html/Lognormal.html
[4] https://reference.wolfram.com/language/ref/LogNormalDistribution.html

Reply via email to