Thanks, good to know. Unfortunately, I used LogNormalDistribution as template.
On Tue, Nov 10, 2015 at 9:51 PM, Gilles <gil...@harfang.homelinux.org> wrote:
> Hi Otmar.
>
> On Tue, 10 Nov 2015 20:32:13 -0000, oe...@apache.org wrote:
>>
>> MATH-1285: added definition of distribution to javadoc of
>> ZipfDistribution
>>
>> [...]
>>
>> diff --git
>>
>>
>> a/src/main/java/org/apache/commons/math3/distribution/ZipfDistribution.java
>>
>>
>> b/src/main/java/org/apache/commons/math3/distribution/ZipfDistribution.java
>> index 4538a3a..224aad4 100644
>> ---
>>
>>
>> a/src/main/java/org/apache/commons/math3/distribution/ZipfDistribution.java
>> +++
>>
>>
>> b/src/main/java/org/apache/commons/math3/distribution/ZipfDistribution.java
>> @@ -25,8 +25,22 @@ import org.apache.commons.math3.util.FastMath;
>>
>> /**
>> * Implementation of the Zipf distribution.
>> - *
>> + * <p>
>> + * <strong>Parameters:</strong>
>> + * For a random variable {@code X} whose values are distributed
>> according to this
>> + * distribution, the probability mass function is given by
>> + * <pre>
>> + * P(X = k) = H(N,s) * 1 / k^s for {@code k = 1,2,...,N}.
>> + * </pre>
>> + * {@code H(N,s)} is the normalizing constant
>> + * which corresponds to the generalized harmonic number of order N of s.
>> + * <p>
>> + * <ul>
>> + * <li>{@code N} is the number of elements</li>
>> + * <li>{@code s} is the exponent</li>
>> + * </ul>
>
>
> Some time ago, we decided to use MathJax for writing all math formulae
> in Javadoc. [I.e. it is LaTeX code enclosed in "\(" and "\)" markers.
> See e.g. the doc in file "stat/inference/KolmogorovSmirnovTest.java".]
>
> Note sure whether it was written down somewhere (apart from the ML archive).
>
>
> Best regards,
> Gilles
>
>> [...]
>
>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscr...@commons.apache.org
> For additional commands, e-mail: dev-h...@commons.apache.org
>
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscr...@commons.apache.org
For additional commands, e-mail: dev-h...@commons.apache.org
