[commons-rng] branch master updated: Document preconditions

[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-rng.git


The following commit(s) were added to refs/heads/master by this push:
     new c97825f  Document preconditions
c97825f is described below

commit c97825f6afde2692282b41542e024d100c5af237
Author: aherbert <ah...@apache.org>
AuthorDate: Tue Feb 26 13:54:20 2019 +0000

    Document preconditions
---
 .../rng/sampling/DiscreteProbabilityCollectionSamplerTest.java    | 8 +++++++-
 1 file changed, 7 insertions(+), 1 deletion(-)

diff --git a/commons-rng-sampling/src/test/java/org/apache/commons/rng/sampling/DiscreteProbabilityCollectionSamplerTest.java b/commons-rng-sampling/src/test/java/org/apache/commons/rng/sampling/DiscreteProbabilityCollectionSamplerTest.java
index 0df63c6..92a7412 100644
--- a/commons-rng-sampling/src/test/java/org/apache/commons/rng/sampling/DiscreteProbabilityCollectionSamplerTest.java
+++ b/commons-rng-sampling/src/test/java/org/apache/commons/rng/sampling/DiscreteProbabilityCollectionSamplerTest.java
@@ -36,36 +36,42 @@ public class DiscreteProbabilityCollectionSamplerTest {
 
     @Test(expected=IllegalArgumentException.class)
     public void testPrecondition1() {
+        // Size mismatch
         new DiscreteProbabilityCollectionSampler<Double>(rng,
                                                          Arrays.asList(new Double[] {1d, 2d}),
                                                          new double[] {0d});
     }
     @Test(expected=IllegalArgumentException.class)
     public void testPrecondition2() {
+        // Negative probability
         new DiscreteProbabilityCollectionSampler<Double>(rng,
                                                          Arrays.asList(new Double[] {1d, 2d}),
                                                          new double[] {0d, -1d});
     }
     @Test(expected=IllegalArgumentException.class)
     public void testPrecondition3() {
+        // Probabilities do not sum above 0
         new DiscreteProbabilityCollectionSampler<Double>(rng,
                                                          Arrays.asList(new Double[] {1d, 2d}),
                                                          new double[] {0d, 0d});
     }
     @Test(expected=IllegalArgumentException.class)
     public void testPrecondition4() {
+        // NaN probability
         new DiscreteProbabilityCollectionSampler<Double>(rng,
                                                          Arrays.asList(new Double[] {1d, 2d}),
                                                          new double[] {0d, Double.NaN});
     }
     @Test(expected=IllegalArgumentException.class)
     public void testPrecondition5() {
+        // Infinite probability
         new DiscreteProbabilityCollectionSampler<Double>(rng,
                                                          Arrays.asList(new Double[] {1d, 2d}),
                                                          new double[] {0d, Double.POSITIVE_INFINITY});
     }
     @Test(expected=IllegalArgumentException.class)
     public void testPrecondition6() {
+        // Empty Map<T, Double> not allowed
         new DiscreteProbabilityCollectionSampler<Double>(rng,
                                                          new HashMap<Double,Double>());
     }
@@ -121,7 +127,7 @@ public class DiscreteProbabilityCollectionSamplerTest {
     /**
      * Edge-case test:
      * Create a sampler that will return over 1 for nextDouble() forcing the binary search to
-     * identify insertion at the end of the cumulative probability array
+     * identify insertion at the end of the cumulative probability array.
      */
     @Test
     public void testSampleWithProbabilityPastLastItem() {