Skip to content

Commit 61169bc

Browse files
author
Lee Rhodes
committed
Javadoc updates
1 parent 6792a8b commit 61169bc

3 files changed

Lines changed: 12 additions & 27 deletions

File tree

src/main/java/com/yahoo/sketches/quantiles/HeapUnion.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ static HeapQuantilesSketch unionUpdateLogic(HeapQuantilesSketch qs1, HeapQuantil
100100
return qs1;
101101
}
102102

103-
//myK > thatK
103+
//qs1K > qs2K
104104
HeapQuantilesSketch copyQS2 = HeapQuantilesSketch.copy(qs2);
105105
HeapUnion.mergeInto(qs1, copyQS2);
106106
return copyQS2;

src/main/java/com/yahoo/sketches/quantiles/QuantilesSketch.java

Lines changed: 0 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -315,31 +315,6 @@ public String toString() {
315315
*/
316316
public abstract String toString(boolean sketchSummary, boolean dataDetail);
317317

318-
//Merging etc
319-
320-
// /**
321-
// * Merges the given sketch into this one.
322-
// * Merges the source sketch into this sketch that can have a smaller value of K.
323-
// * However, it is required that the ratio of the two K values be a power of 2.
324-
// * I.e., source.getK() = this.getK() * 2^(nonnegative integer).
325-
// * The source is not modified.
326-
// *
327-
// * @param source the given source sketch
328-
// */
329-
// public void merge(QuantilesSketch source) {
330-
// mergeInto(source, this);
331-
// }
332-
//
333-
// /**
334-
// * Merges the source sketch into the target sketch that can have a smaller value of K.
335-
// * However, it is required that the ratio of the two K values be a power of 2.
336-
// * I.e., source.getK() = target.getK() * 2^(nonnegative integer).
337-
// * The source is not modified.
338-
// *
339-
// * @param source The source sketch
340-
// * @param target The target sketch
341-
// */
342-
// public abstract void mergeInto(QuantilesSketch source, QuantilesSketch target);
343318

344319
/**
345320
* From an existing sketch, this creates a new sketch that can have a smaller value of K.

src/main/java/com/yahoo/sketches/quantiles/Union.java

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,12 +65,22 @@ public static final UnionBuilder builder() {
6565
public abstract QuantilesSketch getResult();
6666

6767
/**
68-
* Resets this Union to its virgin state.
68+
* Resets this Union to a virgin state.
6969
*/
7070
public abstract void reset();
7171

72+
/**
73+
* Returns summary information about the backing sketch.
74+
*/
7275
@Override
7376
public abstract String toString();
7477

78+
79+
/**
80+
* Returns summary information about the backing sketch. Used for debugging.
81+
* @param sketchSummary if true includes sketch summary
82+
* @param dataDetail if true includes data detail
83+
* @return summary information about the sketch.
84+
*/
7585
public abstract String toString(boolean sketchSummary, boolean dataDetail);
7686
}

0 commit comments

Comments
 (0)