[commons-rng] 01/04: Fix checkstyle and javadoc in examples sampling ProbabilityDensityApproximation

[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

commit bd7db4673ec0ed1f41c2db7274344c8bad061117
Author: Alex Herbert <ah...@apache.org>
AuthorDate: Fri Feb 15 22:12:52 2019 +0000

    Fix checkstyle and javadoc in examples sampling
    ProbabilityDensityApproximation
    
    This requires suppression of MultipleStringLiteralsCheck to ignore the
    use of "# " and " ".
---
 .../rng/examples/sampling/ProbabilityDensityApproximation.java     | 7 +++++--
 1 file changed, 5 insertions(+), 2 deletions(-)

diff --git a/commons-rng-examples/examples-sampling/src/main/java/org/apache/commons/rng/examples/sampling/ProbabilityDensityApproximation.java b/commons-rng-examples/examples-sampling/src/main/java/org/apache/commons/rng/examples/sampling/ProbabilityDensityApproximation.java
index 3fa5ace..be5fb59 100644
--- a/commons-rng-examples/examples-sampling/src/main/java/org/apache/commons/rng/examples/sampling/ProbabilityDensityApproximation.java
+++ b/commons-rng-examples/examples-sampling/src/main/java/org/apache/commons/rng/examples/sampling/ProbabilityDensityApproximation.java
@@ -59,10 +59,11 @@ public class ProbabilityDensityApproximation {
      * @param min Right abscissa of the first bin: every sample smaller
      * than that value will increment an additional bin (of infinite width)
      * placed before the first "equal-width" bin.
-     * @param Left abscissa of the last bin: every sample larger than or
+     * @param max abscissa of the last bin: every sample larger than or
      * equal to that value will increment an additional bin (of infinite
      * width) placed after the last "equal-width" bin.
-     * @param output Filename.
+     * @param outputFile Filename.
+     * @throws IOException Signals that an I/O exception has occurred.
      */
     private void createDensity(ContinuousSampler sampler,
                                double min,
@@ -96,6 +97,7 @@ public class ProbabilityDensityApproximation {
         final double norm = 1 / (binSize * numSamples);
 
         final PrintWriter out = new PrintWriter(outputFile);
+        // CHECKSTYLE: stop MultipleStringLiteralsCheck
         out.println("# Sampler: " + sampler);
         out.println("# Number of bins: " + numBins);
         out.println("# Min: " + min + " (fraction of samples below: " + (belowMin / (double) numSamples) + ")");
@@ -109,6 +111,7 @@ public class ProbabilityDensityApproximation {
         }
         out.println("# " + (max + binHalfSize) + " " + (aboveMax * norm));
         out.close();
+        // CHECKSTYLE: resume MultipleStringLiteralsCheck
     }
 
     /**