changeset 1307:ce0559bf7731

Complete Javadoc in Statistics interface.
author shade
date Thu, 14 Jan 2016 23:23:12 +0300
parents 80b666fe8548
children 534d83d9137f
files jmh-core/src/main/java/org/openjdk/jmh/util/Statistics.java
diffstat 1 files changed, 43 insertions(+), 10 deletions(-) [+]
line wrap: on
line diff
--- a/jmh-core/src/main/java/org/openjdk/jmh/util/Statistics.java	Thu Jan 14 21:47:25 2016 +0300
+++ b/jmh-core/src/main/java/org/openjdk/jmh/util/Statistics.java	Thu Jan 14 23:23:12 2016 +0300
@@ -75,20 +75,53 @@
 
     int compareTo(Statistics other, double confidence);
 
+    /**
+     * Returns the maximum for this statistics.
+     * @return maximum
+     */
+    double getMax();
+
+    /**
+     * Returns the minimum for this statistics.
+     * @return minimum
+     */
+    double getMin();
+
+    /**
+     * Returns the arithmetic mean for this statistics.
+     * @return arithmetic mean
+     */
+    double getMean();
+
+    /**
+     * Returns the number of samples in this statistics.
+     * @return number of samples
+     */
+    long getN();
+
+    /**
+     * Returns the sum of samples in this statistics.
+     * @return sum
+     */
+    double getSum();
+
+    /**
+     * Returns the standard deviation for this statistics.
+     * @return standard deviation
+     */
     double getStandardDeviation();
 
-    double getMax();
-
-    double getMin();
-
-    double getMean();
-
-    long getN();
-
-    double getSum();
-
+    /**
+     * Returns the variance for this statistics.
+     * @return variance
+     */
     double getVariance();
 
+    /**
+     * Returns the percentile at given rank.
+     * @param rank the rank, [0..100]
+     * @return percentile
+     */
     double getPercentile(double rank);
 
     /**