Skip to content

Commit

Permalink
Rewrite StreamOverflowException javadoc
Browse files Browse the repository at this point in the history
  • Loading branch information
gstamatelat committed Jul 4, 2018
1 parent d624faf commit 1b3b389
Showing 1 changed file with 2 additions and 4 deletions.
6 changes: 2 additions & 4 deletions src/main/java/gr/james/sampling/StreamOverflowException.java
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,8 @@
import java.util.Map;

/**
* A {@code StreamOverflowException} indicates that the internal state of the algorithm has overflown.
* <p>
* The exception may occur when the amount of items feeded to a random sampling algorithm exceeds the maximum allowed or
* when the internal state has overflown in a way that would otherwise cause the algorithm to behave inconsistently.
* A {@code StreamOverflowException} indicates that the internal state of the algorithm has reached a situation where
* the precision has degraded into a non-recurrent state that would prevent the algorithm from behaving consistently.
* <p>
* More specifically, this exception targets the methods
* <ul>
Expand Down

0 comments on commit 1b3b389

Please sign in to comment.