Specify streamSize() overflow

motinis · Jul 1, 2018 · 47e8cca · 47e8cca
1 parent 5f803f7
commit 47e8cca
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 6 deletions.
diff --git a/src/main/java/gr/james/sampling/AbstractRandomSampling.java b/src/main/java/gr/james/sampling/AbstractRandomSampling.java
@@ -123,9 +123,12 @@ public final int sampleSize() {
     }
 
     /**
-     * {@inheritDoc}
+     * Get the number of items that have been feeded to the algorithm during the lifetime of this instance, which is a
+     * non-negative {@code long} value.
+     * <p>
+     * This method runs in constant time.
      *
-     * @return {@inheritDoc}
+     * @return the number of items that have been feeded to the algorithm
      */
     @Override
     public final long streamSize() {

diff --git a/src/main/java/gr/james/sampling/ChaoSampling.java b/src/main/java/gr/james/sampling/ChaoSampling.java
@@ -265,9 +265,12 @@ public final int sampleSize() {
     }
 
     /**
-     * {@inheritDoc}
+     * Get the number of items that have been feeded to the algorithm during the lifetime of this instance, which is a
+     * non-negative {@code long} value.
+     * <p>
+     * This method runs in constant time.
      *
-     * @return {@inheritDoc}
+     * @return the number of items that have been feeded to the algorithm
      */
     @Override
     public final long streamSize() {

diff --git a/src/main/java/gr/james/sampling/EfraimidisSampling.java b/src/main/java/gr/james/sampling/EfraimidisSampling.java
@@ -192,9 +192,14 @@ public final int sampleSize() {
     }
 
     /**
-     * {@inheritDoc}
+     * Get the number of items that have been feeded to the algorithm during the lifetime of this instance.
+     * <p>
+     * If more than {@link Long#MAX_VALUE} items has been feeded to the instance, {@code streamSize()} will cycle the
+     * long values, continuing from {@link Long#MIN_VALUE}.
+     * <p>
+     * This method runs in constant time.
      *
-     * @return {@inheritDoc}
+     * @return the number of items that have been feeded to the algorithm
      */
     @Override
     public final long streamSize() {