[commons-statistics] 13/15: Document special cases

[ah...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

aherbert pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-statistics.git

commit df70e900dedc7275d9db2d2a98f403aaa56642d5
Author: aherbert <ah...@apache.org>
AuthorDate: Wed Nov 30 13:07:38 2022 +0000

    Document special cases
---
 .../commons/statistics/distribution/TrapezoidalDistribution.java    | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/TrapezoidalDistribution.java b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/TrapezoidalDistribution.java
index 405ce44..da11161 100644
--- a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/TrapezoidalDistribution.java
+++ b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/TrapezoidalDistribution.java
@@ -33,6 +33,12 @@ import org.apache.commons.rng.UniformRandomProvider;
  * <p>for \( -\infty \lt a \le b \le c \le d \lt \infty \) and
  * \( x \in [a, d] \).
  *
+ * <p>Note the special cases:
+ * <ul>
+ * <li>\( b = c \) is the triangular distribution
+ * <li>\( a = b \) and \( c = d \) is the uniform distribution
+ * </ul>
+ *
  * @see <a href="https://en.wikipedia.org/wiki/Trapezoidal_distribution">Trapezoidal distribution (Wikipedia)</a>
  */
 public abstract class TrapezoidalDistribution extends AbstractContinuousDistribution {