Skip to content

Commit 4bc22a2

Browse files
leerholeerho
committed
More cleanup
1 parent 469cfb3 commit 4bc22a2

17 files changed

Lines changed: 96 additions & 97 deletions

‎src/main/java/org/apache/datasketches/hllmap/CouponHashMap.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -235,7 +235,7 @@ int getCurrentCountEntries() {
235235
}
236236

237237
@Override
238-
long getMemoryUsageBytes() {
238+
long getTotalUsageBytes() {
239239
final long arrays = keysArr_.length
240240
+ ((long) couponsArr_.length * Short.BYTES)
241241
+ curCountsArr_.length

‎src/main/java/org/apache/datasketches/hllmap/CouponTraverseMap.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -213,7 +213,7 @@ int getCurrentCountEntries() {
213213
}
214214

215215
@Override
216-
long getMemoryUsageBytes() {
216+
long getTotalUsageBytes() {
217217
return keysArr_.length
218218
+ ((long)couponsArr_.length * Short.BYTES)
219219
+ stateArr_.length + (4L * Integer.BYTES);

‎src/main/java/org/apache/datasketches/hllmap/HllMap.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -200,7 +200,7 @@ int getCurrentCountEntries() {
200200
}
201201

202202
@Override
203-
long getMemoryUsageBytes() {
203+
long getTotalUsageBytes() {
204204
final long arrays = keysArr_.length
205205
+ ((long) arrOfHllArr_.length * Long.BYTES)
206206
+ ((long) invPow2SumLoArr_.length * Double.BYTES)

‎src/main/java/org/apache/datasketches/hllmap/Map.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@ void updateEstimate(final int index, final double estimate) {}
126126

127127
abstract int getCurrentCountEntries();
128128

129-
abstract long getMemoryUsageBytes();
129+
abstract long getTotalUsageBytes();
130130

131131
int getKeySizeBytes() {
132132
return keySizeBytes_;
@@ -239,7 +239,7 @@ public String toString() {
239239
final String ae = Map.fmtLong(getActiveEntries());
240240
final String de = Map.fmtLong(getDeletedEntries());
241241
final String esb = Map.fmtDouble(getEntrySizeBytes());
242-
final String mub = Map.fmtLong(getMemoryUsageBytes());
242+
final String mub = Map.fmtLong(getTotalUsageBytes());
243243

244244
final StringBuilder sb = new StringBuilder();
245245
final String thisSimpleName = this.getClass().getSimpleName();

‎src/main/java/org/apache/datasketches/hllmap/SingleCouponMap.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -222,7 +222,7 @@ int getCurrentCountEntries() {
222222
}
223223

224224
@Override
225-
long getMemoryUsageBytes() {
225+
long getTotalUsageBytes() {
226226
final long arrays = keysArr_.length
227227
+ (long)couponsArr_.length * Short.BYTES
228228
+ stateArr_.length;

‎src/main/java/org/apache/datasketches/hllmap/UniqueCountMap.java‎

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@
4343
* <p>Given such highly-skewed distributions, using this map is far more efficient space-wise than
4444
* the alternative of dedicating an HLL sketch per key. Based on our use cases, after
4545
* subtracting the space required for key storage, the average bytes per key required for unique
46-
* count estimation ({@link #getAverageSketchMemoryPerKey()}) is about 10.
46+
* count estimation ({@link #getAverageSketchBytesPerKey()}) is about 10.
4747
*
4848
* <p>Internally, this map is implemented as a hierarchy of internal hash maps with progressively
4949
* increasing storage allocated for unique count estimation. As a key acquires more identifiers it
@@ -209,11 +209,11 @@ public int getActiveEntries() {
209209
* Returns total bytes used by all internal maps
210210
* @return total bytes used by all internal maps
211211
*/
212-
public long getMemoryUsageBytes() {
212+
public long getTotalUsageBytes() {
213213
long total = 0;
214214
for (int i = 0; i < maps_.length; i++) {
215215
if (maps_[i] != null) {
216-
total += maps_[i].getMemoryUsageBytes();
216+
total += maps_[i].getTotalUsageBytes();
217217
}
218218
}
219219
return total;
@@ -223,7 +223,7 @@ public long getMemoryUsageBytes() {
223223
* Returns total bytes used for key storage
224224
* @return total bytes used for key storage
225225
*/
226-
public long getKeyMemoryUsageBytes() {
226+
public long getKeyUsageBytes() {
227227
long total = 0;
228228
for (int i = 0; i < maps_.length; i++) {
229229
if (maps_[i] != null) {
@@ -234,11 +234,11 @@ public long getKeyMemoryUsageBytes() {
234234
}
235235

236236
/**
237-
* Returns the average memory storage per key that is dedicated to sketching the unique counts.
238-
* @return the average memory storage per key that is dedicated to sketching the unique counts.
237+
* Returns the average bytes storage per key that is dedicated to sketching the unique counts.
238+
* @return the average bytes storage per key that is dedicated to sketching the unique counts.
239239
*/
240-
public double getAverageSketchMemoryPerKey() {
241-
return (double) (getMemoryUsageBytes() - getKeyMemoryUsageBytes()) / getActiveEntries();
240+
public double getAverageSketchBytesPerKey() {
241+
return (double) (getTotalUsageBytes() - getKeyUsageBytes()) / getActiveEntries();
242242
}
243243

244244
/**
@@ -280,16 +280,16 @@ Map getHllMap() {
280280
@Override
281281
public String toString() {
282282
final long totKeys = getActiveEntries();
283-
final long totMem = getMemoryUsageBytes();
284-
final long keyMem = getKeyMemoryUsageBytes();
285-
final double avgValMemPerKey = getAverageSketchMemoryPerKey();
283+
final long totBytes = getTotalUsageBytes();
284+
final long keyBytes = getKeyUsageBytes();
285+
final double avgValBytesPerKey = getAverageSketchBytesPerKey();
286286

287287
final String ksb = Map.fmtLong(keySizeBytes_);
288288
final String alvls = Map.fmtLong(getActiveMaps());
289289
final String tKeys = Map.fmtLong(totKeys);
290-
final String tMem = Map.fmtLong(totMem);
291-
final String kMem = Map.fmtLong(keyMem);
292-
final String avgValMem = Map.fmtDouble(avgValMemPerKey);
290+
final String tBytes = Map.fmtLong(totBytes);
291+
final String kBytes = Map.fmtLong(keyBytes);
292+
final String avgValBytes = Map.fmtDouble(avgValBytesPerKey);
293293

294294

295295
final StringBuilder sb = new StringBuilder();
@@ -298,9 +298,9 @@ public String toString() {
298298
sb.append(" Key Size Bytes : ").append(ksb).append(LS);
299299
sb.append(" Active Map Levels : ").append(alvls).append(LS);
300300
sb.append(" Total keys : ").append(tKeys).append(LS);
301-
sb.append(" Total Memory Bytes : ").append(tMem).append(LS);
302-
sb.append(" Total Key Memory Bytes : ").append(kMem).append(LS);
303-
sb.append(" Avg Sketch Memory Bytes/Key: ").append(avgValMem).append(LS);
301+
sb.append(" Total Usage Bytes : ").append(tBytes).append(LS);
302+
sb.append(" Total Key Usage Bytes : ").append(kBytes).append(LS);
303+
sb.append(" Avg Sketch Usage Bytes/Key : ").append(avgValBytes).append(LS);
304304
sb.append(LS);
305305
for (int i = 0; i < maps_.length; i++) {
306306
final Map cMap = maps_[i];

‎src/main/java/org/apache/datasketches/kll/KllDirectDoublesSketch.java‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -64,21 +64,21 @@
6464
*/
6565
class KllDirectDoublesSketch extends KllDoublesSketch {
6666
private MemorySegment wseg;
67-
private final MemorySegmentRequest memSegReq;
67+
private final MemorySegmentRequest mSegReq;
6868

6969
/**
7070
* Constructs from MemorySegment or MemorySegment already initialized with a sketch image and validated.
71-
* @param sketchStructure the given structure.
7271
* @param wseg the current MemorySegment
73-
* @param segVal the MemoryValadate object
72+
* @param segVal the MemorySegment Validate object
73+
* @param mSegmentRequest the MemorySegmentRequest object.
7474
*/
7575
KllDirectDoublesSketch(
7676
final MemorySegment wseg,
7777
final KllMemorySegmentValidate segVal,
78-
final MemorySegmentRequest memSegReq) {
78+
final MemorySegmentRequest mSegmentRequest) {
7979
super(segVal);
8080
this.wseg = wseg;
81-
this.memSegReq = memSegReq;
81+
mSegReq = mSegmentRequest;
8282
}
8383

8484
/**
@@ -93,7 +93,7 @@ static KllDirectDoublesSketch newDirectUpdatableInstance(
9393
final int k,
9494
final int m,
9595
final MemorySegment dstSeg,
96-
final MemorySegmentRequest memSegReq) {
96+
final MemorySegmentRequest mSegmentRequest) {
9797
setMemorySegmentPreInts(dstSeg, UPDATABLE.getPreInts());
9898
setMemorySegmentSerVer(dstSeg, UPDATABLE.getSerVer());
9999
setMemorySegmentFamilyID(dstSeg, Family.KLL.getID());
@@ -113,7 +113,7 @@ static KllDirectDoublesSketch newDirectUpdatableInstance(
113113
MemorySegment.copy(new double[k], 0, dstSeg, JAVA_DOUBLE_UNALIGNED, offset, k);
114114
final KllMemorySegmentValidate segVal = new KllMemorySegmentValidate(dstSeg, DOUBLES_SKETCH, null);
115115
final MemorySegment wSeg = dstSeg;
116-
return new KllDirectDoublesSketch(wSeg, segVal, memSegReq);
116+
return new KllDirectDoublesSketch(wSeg, segVal, mSegmentRequest);
117117
}
118118

119119
//End of constructors
@@ -256,7 +256,7 @@ int getM() {
256256

257257
@Override
258258
MemorySegmentRequest getMemorySegmentRequest() {
259-
return memSegReq;
259+
return mSegReq;
260260
}
261261

262262
@Override

‎src/main/java/org/apache/datasketches/kll/KllDirectFloatsSketch.java‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -64,36 +64,36 @@
6464
*/
6565
class KllDirectFloatsSketch extends KllFloatsSketch {
6666
private MemorySegment wseg;
67-
private final MemorySegmentRequest memSegReq;
67+
private final MemorySegmentRequest mSegReq;
6868

6969
/**
7070
* Constructs from MemorySegment or MemorySegment already initialized with a sketch image and validated.
71-
* @param sketchStructure the given structure.
72-
* @param wseg the current MemorySegment
73-
* @param segVal the MemoryValadate object
71+
* @param wseg the current writable MemorySegment
72+
* @param segVal the MemorySegment Validate object
73+
* @param mSegmentRequest the MemorySegmentRequest object
7474
*/
7575
KllDirectFloatsSketch(
7676
final MemorySegment wseg,
7777
final KllMemorySegmentValidate segVal,
78-
final MemorySegmentRequest memSegReq) {
78+
final MemorySegmentRequest mSegmentRequest) {
7979
super(segVal);
8080
this.wseg = wseg;
81-
this.memSegReq = memSegReq;
81+
mSegReq = mSegmentRequest;
8282
}
8383

8484
/**
8585
* Create a new updatable, direct instance of this sketch.
8686
* @param k parameter that controls size of the sketch and accuracy of estimates
8787
* @param m parameter that controls the minimum level width in items.
8888
* @param dstSeg the given destination MemorySegment object for use by the sketch
89-
* @param mSegReq the callback for the sketch to request a larger MemorySegment.
89+
* @param mSegmentRequest the callback for the sketch to request a larger MemorySegment.
9090
* @return a new instance of this sketch
9191
*/
9292
static KllDirectFloatsSketch newDirectUpdatableInstance(
9393
final int k,
9494
final int m,
9595
final MemorySegment dstSeg,
96-
final MemorySegmentRequest memSegReq) {
96+
final MemorySegmentRequest mSegmentRequest) {
9797
setMemorySegmentPreInts(dstSeg, UPDATABLE.getPreInts());
9898
setMemorySegmentSerVer(dstSeg, UPDATABLE.getSerVer());
9999
setMemorySegmentFamilyID(dstSeg, Family.KLL.getID());
@@ -113,7 +113,7 @@ static KllDirectFloatsSketch newDirectUpdatableInstance(
113113
MemorySegment.copy(new float[k], 0, dstSeg, JAVA_FLOAT_UNALIGNED, offset, k);
114114
final KllMemorySegmentValidate segVal = new KllMemorySegmentValidate(dstSeg, FLOATS_SKETCH, null);
115115
final MemorySegment wSeg = dstSeg;
116-
return new KllDirectFloatsSketch(wSeg, segVal, memSegReq);
116+
return new KllDirectFloatsSketch(wSeg, segVal, mSegmentRequest);
117117
}
118118

119119
//End of Constructors
@@ -256,7 +256,7 @@ int getM() {
256256

257257
@Override
258258
MemorySegmentRequest getMemorySegmentRequest() {
259-
return memSegReq;
259+
return mSegReq;
260260
}
261261

262262
@Override

‎src/main/java/org/apache/datasketches/kll/KllDirectLongsSketch.java‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -64,21 +64,21 @@
6464
*/
6565
class KllDirectLongsSketch extends KllLongsSketch {
6666
private MemorySegment wseg;
67-
private final MemorySegmentRequest memSegReq;
67+
private final MemorySegmentRequest mSegReq;
6868

6969
/**
7070
* Constructs from MemorySegment already initialized with a sketch image and validated.
71-
* @param sketchStructure the given structure.
7271
* @param wseg the current MemorySegment
7372
* @param segVal the MemoryValadate object
73+
* @param mSegmentRequest the MemorySegmentRequest object.
7474
*/
7575
KllDirectLongsSketch(
7676
final MemorySegment wseg,
7777
final KllMemorySegmentValidate segVal,
78-
final MemorySegmentRequest memSegReq) {
78+
final MemorySegmentRequest mSegmentRequest) {
7979
super(segVal);
8080
this.wseg = wseg;
81-
this.memSegReq = memSegReq;
81+
mSegReq = mSegmentRequest;
8282
}
8383

8484
/**
@@ -93,7 +93,7 @@ static KllDirectLongsSketch newDirectUpdatableInstance(
9393
final int k,
9494
final int m,
9595
final MemorySegment dstSeg,
96-
final MemorySegmentRequest memSegReq) {
96+
final MemorySegmentRequest mSegmentRequest) {
9797
setMemorySegmentPreInts(dstSeg, UPDATABLE.getPreInts());
9898
setMemorySegmentSerVer(dstSeg, UPDATABLE.getSerVer());
9999
setMemorySegmentFamilyID(dstSeg, Family.KLL.getID());
@@ -113,7 +113,7 @@ static KllDirectLongsSketch newDirectUpdatableInstance(
113113
MemorySegment.copy(new long[k], 0, dstSeg, JAVA_LONG_UNALIGNED, offset, k);
114114
final KllMemorySegmentValidate segVal = new KllMemorySegmentValidate(dstSeg, LONGS_SKETCH, null);
115115
final MemorySegment wSeg = dstSeg;
116-
return new KllDirectLongsSketch(wSeg, segVal, memSegReq);
116+
return new KllDirectLongsSketch(wSeg, segVal, mSegmentRequest);
117117
}
118118

119119
//End of Constructors
@@ -256,7 +256,7 @@ int getM() {
256256

257257
@Override
258258
MemorySegmentRequest getMemorySegmentRequest() {
259-
return memSegReq;
259+
return mSegReq;
260260
}
261261

262262
@Override
@@ -394,5 +394,5 @@ public boolean isSameResource(final MemorySegment that) {
394394
void setMemorySegment(final MemorySegment wseg) {
395395
this.wseg = wseg;
396396
}
397-
397+
398398
}

‎src/main/java/org/apache/datasketches/kll/KllHelper.java‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -509,15 +509,15 @@ static <T> String toStringImpl(final KllSketch sketch, final boolean withLevels,
509509
final int[] fullLevelsArr = sketch.getLevelsArray(UPDATABLE);
510510

511511
final SketchType sketchType = sketch.sketchType;
512-
final boolean hasMemSeg = sketch.hasMemorySegment();
512+
final boolean hasMSeg = sketch.hasMemorySegment();
513513
final long n = sketch.getN();
514514
final String epsPct = String.format("%.3f%%", sketch.getNormalizedRankError(false) * 100);
515515
final String epsPMFPct = String.format("%.3f%%", sketch.getNormalizedRankError(true) * 100);
516516
final boolean compact = sketch.isCompactMemorySegmentFormat();
517517

518-
final String directStr = hasMemSeg ? "Direct" : "";
518+
final String directStr = hasMSeg ? "Direct" : "";
519519
final String compactStr = compact ? "Compact" : "";
520-
final String readOnlyStr = sketch.isReadOnly() ? "true" + ("(" + (compact ? "Format" : "MemSeg") + ")") : "false";
520+
final String readOnlyStr = sketch.isReadOnly() ? "true" + ("(" + (compact ? "Format" : "MemorySegment") + ")") : "false";
521521
final String skTypeStr = sketchType.getName();
522522
final String className = "Kll" + directStr + compactStr + skTypeStr;
523523

0 commit comments

Comments
 (0)