Skip to content

Commit aed865a

Browse files
author
lrhodes
committed
Improve javadoc
1 parent abbe5dc commit aed865a

1 file changed

Lines changed: 6 additions & 4 deletions

File tree

src/main/java/com/yahoo/sketches/kll/KllFloatsSketch.java

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -34,9 +34,9 @@
3434
public class KllFloatsSketch {
3535

3636
public static final int DEFAULT_K = 200;
37-
public static final int DEFAULT_M = 8;
38-
public static final int MIN_K = 8;
39-
public static final int MAX_K = (1 << 16) - 1; // serialized as an unsigned short
37+
static final int DEFAULT_M = 8;
38+
static final int MIN_K = 8;
39+
static final int MAX_K = (1 << 16) - 1; // serialized as an unsigned short
4040

4141
/* Serialized sketch layout:
4242
* Adr:
@@ -101,7 +101,9 @@ public KllFloatsSketch() {
101101
}
102102

103103
/**
104-
* Constructor with a given parameter K
104+
* Constructor with a given parameter K. K can be any value between 8 and 65535, inclusive.
105+
* The default K = 200 results in a normalized rank error of about 1.65%. Higher values of K
106+
* will have smaller error but the sketch will be larger (and slower).
105107
* @param k parameter that controls size of the sketch and accuracy of estimates
106108
*/
107109
public KllFloatsSketch(final int k) {

0 commit comments

Comments
 (0)