This changes the names to FrequentItemsSketch and FrequentLongsSketch.

In KLL, I changed the names of the enum constants to KLL_DOUBLES_SKETCH,
etc.  And the methods to isKllItmesSketch(), etc.

Author: leerho

…atasketches/frequencies/ItemsSketch.java …hes/frequencies/FrequentItemsSketch.javasrc/main/java/org/apache/datasketches/frequencies/ItemsSketch.java renamed to src/main/java/org/apache/datasketches/frequencies/FrequentItemsSketch.java src/main/java/org/apache/datasketches/frequencies/ItemsSketch.java renamed to src/main/java/org/apache/datasketches/frequencies/FrequentItemsSketch.java

@@ -148,7 +148,7 @@
  * @author Justin Thaler
  * @author Alexander Saydakov
  */
-public class ItemsSketch<T> {
+public class FrequentItemsSketch<T> {
 
   /**
    * Log2 Maximum length of the arrays internal to the hash map supported by the data
@@ -190,7 +190,7 @@ public class ItemsSketch<T> {
    * 0.75 times * maxMapSize. Both the ultimate accuracy and size of this sketch are
    * functions of maxMapSize.
    */
-  public ItemsSketch(final int maxMapSize) {
+  public FrequentItemsSketch(final int maxMapSize) {
     this(exactLog2OfInt(maxMapSize, "maxMapSize"), LG_MIN_MAP_SIZE);
   }
 
@@ -205,7 +205,7 @@ public ItemsSketch(final int maxMapSize) {
    * @param lgCurMapSize Log2 of the starting (current) physical size of the internal hash
    * map managed by this sketch.
    */
-  ItemsSketch(final int lgMaxMapSize, final int lgCurMapSize) {
+  FrequentItemsSketch(final int lgMaxMapSize, final int lgCurMapSize) {
     //set initial size of hash map
     this.lgMaxMapSize = Math.max(lgMaxMapSize, LG_MIN_MAP_SIZE);
     final int lgCurMapSz = Math.max(lgCurMapSize, LG_MIN_MAP_SIZE);
@@ -226,7 +226,7 @@ public ItemsSketch(final int maxMapSize) {
    * @param serDe an instance of ArrayOfItemsSerDe
    * @return a sketch instance of this class.
    */
-  public static <T> ItemsSketch<T> getInstance(final MemorySegment srcSeg,
+  public static <T> FrequentItemsSketch<T> getInstance(final MemorySegment srcSeg,
       final ArrayOfItemsSerDe<T> serDe) {
     Objects.requireNonNull(srcSeg, "srcSeg must not be null.");
     Objects.requireNonNull(serDe, "serDe must not be null.");
@@ -263,13 +263,13 @@ public static <T> ItemsSketch<T> getInstance(final MemorySegment srcSeg,
     }
 
     if (empty) {
-      return new ItemsSketch<>(lgMaxMapSize, LG_MIN_MAP_SIZE);
+      return new FrequentItemsSketch<>(lgMaxMapSize, LG_MIN_MAP_SIZE);
     }
     //get full preamble
     final long[] preArr = new long[preLongs];
     MemorySegment.copy(srcSeg, JAVA_LONG_UNALIGNED, 0, preArr, 0, preLongs);
 
-    final ItemsSketch<T> fis = new ItemsSketch<>(lgMaxMapSize, lgCurMapSize);
+    final FrequentItemsSketch<T> fis = new FrequentItemsSketch<>(lgMaxMapSize, lgCurMapSize);
     fis.streamWeight = 0; //update after
     fis.offset = preArr[3];
 
@@ -461,7 +461,7 @@ public boolean isEmpty() {
    * @return a sketch whose estimates are within the guarantees of the
    * largest error tolerance of the two merged sketches.
    */
-  public ItemsSketch<T> merge(final ItemsSketch<T> other) {
+  public FrequentItemsSketch<T> merge(final FrequentItemsSketch<T> other) {
     if ((other == null) || other.isEmpty()) { return this; }
 
     final long streamLen = streamWeight + other.streamWeight; //capture before merge
@@ -551,18 +551,18 @@ public String toString() {
   }
 
   /**
-   * Returns a human readable string of the preamble of a byte array image of a ItemsSketch.
+   * Returns a human readable string of the preamble of a byte array image of a FrequentItemsSketch.
    * @param byteArr the given byte array
-   * @return a human readable string of the preamble of a byte array image of a ItemsSketch.
+   * @return a human readable string of the preamble of a byte array image of a FrequentItemsSketch.
    */
   public static String toString(final byte[] byteArr) {
     return toString(MemorySegment.ofArray(byteArr));
   }
 
   /**
-   * Returns a human readable string of the preamble of a MemorySegment image of a ItemsSketch.
+   * Returns a human readable string of the preamble of a MemorySegment image of a FrequentItemsSketch.
    * @param seg the given MemorySegment object
-   * @return a human readable string of the preamble of a MemorySegment image of a ItemsSketch.
+   * @return a human readable string of the preamble of a MemorySegment image of a FrequentItemsSketch.
    */
   public static String toString(final MemorySegment seg) {
     return PreambleUtil.preambleToString(seg);

…atasketches/frequencies/LongsSketch.java …hes/frequencies/FrequentLongsSketch.javasrc/main/java/org/apache/datasketches/frequencies/LongsSketch.java renamed to src/main/java/org/apache/datasketches/frequencies/FrequentLongsSketch.java src/main/java/org/apache/datasketches/frequencies/LongsSketch.java renamed to src/main/java/org/apache/datasketches/frequencies/FrequentLongsSketch.java

@@ -144,7 +144,7 @@
  * @author Lee Rhodes
  */
 @SuppressFBWarnings(value = "SIC_INNER_SHOULD_BE_STATIC_ANON", justification = "Harmless, fix later")
-public class LongsSketch {
+public class FrequentLongsSketch {
 
   private static final int STR_PREAMBLE_TOKENS = 6;
 
@@ -188,7 +188,7 @@ public class LongsSketch {
    * 0.75 times * maxMapSize. Both the ultimate accuracy and size of this sketch are a
    * function of maxMapSize.
    */
-  public LongsSketch(final int maxMapSize) {
+  public FrequentLongsSketch(final int maxMapSize) {
     this(exactLog2OfInt(maxMapSize, "maxMapSize"), LG_MIN_MAP_SIZE);
   }
 
@@ -203,7 +203,7 @@ public LongsSketch(final int maxMapSize) {
    * @param lgCurMapSize Log2 of the starting (current) physical size of the internal hash
    * map managed by this sketch.
    */
-  LongsSketch(final int lgMaxMapSize, final int lgCurMapSize) {
+  FrequentLongsSketch(final int lgMaxMapSize, final int lgCurMapSize) {
     //set initial size of hash map
     this.lgMaxMapSize = Math.max(lgMaxMapSize, LG_MIN_MAP_SIZE);
     final int lgCurMapSz = Math.max(lgCurMapSize, LG_MIN_MAP_SIZE);
@@ -222,7 +222,7 @@ public LongsSketch(final int maxMapSize) {
    * @param srcSeg a MemorySegment representation of a sketch of this class.
    * @return a sketch instance of this class.
    */
-  public static LongsSketch getInstance(final MemorySegment srcSeg) {
+  public static FrequentLongsSketch getInstance(final MemorySegment srcSeg) {
     Objects.requireNonNull(srcSeg, "Source MemorySegment must not be null.");
     final long pre0 = PreambleUtil.checkPreambleSize(srcSeg); //check MemorySegment capacity
     final int maxPreLongs = Family.FREQUENCY.getMaxPreLongs();
@@ -256,13 +256,13 @@ public static LongsSketch getInstance(final MemorySegment srcSeg) {
     }
 
     if (empty) {
-      return new LongsSketch(lgMaxMapSize, LG_MIN_MAP_SIZE);
+      return new FrequentLongsSketch(lgMaxMapSize, LG_MIN_MAP_SIZE);
     }
     //get full preamble
     final long[] preArr = new long[preLongs];
     MemorySegment.copy(srcSeg, JAVA_LONG_UNALIGNED, 0, preArr, 0, preLongs);
 
-    final LongsSketch fls = new LongsSketch(lgMaxMapSize, lgCurMapSize);
+    final FrequentLongsSketch fls = new FrequentLongsSketch(lgMaxMapSize, lgCurMapSize);
     fls.streamWeight = 0; //update after
     fls.offset = preArr[3];
 
@@ -294,7 +294,7 @@ public static LongsSketch getInstance(final MemorySegment srcSeg) {
    * @param string a String representation of a sketch of this class.
    * @return a sketch instance of this class.
    */
-  public static LongsSketch getInstance(final String string) {
+  public static FrequentLongsSketch getInstance(final String string) {
     Objects.requireNonNull(string, "string must not be null.");
     final String[] tokens = string.split(",");
     if (tokens.length < (STR_PREAMBLE_TOKENS + 2)) {
@@ -328,7 +328,7 @@ public static LongsSketch getInstance(final String string) {
             + ", numActive: " + numActive);
     }
 
-    final LongsSketch sketch = new LongsSketch(lgMax, lgCur);
+    final FrequentLongsSketch sketch = new FrequentLongsSketch(lgMax, lgCur);
     sketch.streamWeight = streamWt;
     sketch.offset = offset;
     sketch.hashMap = deserializeFromStringArray(tokens);
@@ -512,7 +512,7 @@ public boolean isEmpty() {
    * @return a sketch whose estimates are within the guarantees of the
    * largest error tolerance of the two merged sketches.
    */
-  public LongsSketch merge(final LongsSketch other) {
+  public FrequentLongsSketch merge(final FrequentLongsSketch other) {
     if ((other == null) || other.isEmpty()) { return this; }
 
     final long streamWt = streamWeight + other.streamWeight; //capture before merge
@@ -620,18 +620,18 @@ public String toString() {
   }
 
   /**
-   * Returns a human readable string of the preamble of a byte array image of a LongsSketch.
+   * Returns a human readable string of the preamble of a byte array image of a FrequentLongsSketch.
    * @param byteArr the given byte array
-   * @return a human readable string of the preamble of a byte array image of a LongsSketch.
+   * @return a human readable string of the preamble of a byte array image of a FrequentLongsSketch.
    */
   public static String toString(final byte[] byteArr) {
     return toString(MemorySegment.ofArray(byteArr));
   }
 
   /**
-   * Returns a human readable string of the preamble of a MemorySegment image of a LongsSketch.
+   * Returns a human readable string of the preamble of a MemorySegment image of a FrequentLongsSketch.
    * @param seg the given MemorySegment object
-   * @return  a human readable string of the preamble of a MemorySegment image of a LongsSketch.
+   * @return  a human readable string of the preamble of a MemorySegment image of a FrequentLongsSketch.
    */
   public static String toString(final MemorySegment seg) {
     return PreambleUtil.preambleToString(seg);

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

@@ -44,7 +44,7 @@
 import static org.apache.datasketches.kll.KllSketch.SketchStructure.COMPACT_FULL;
 import static org.apache.datasketches.kll.KllSketch.SketchStructure.COMPACT_SINGLE;
 import static org.apache.datasketches.kll.KllSketch.SketchStructure.UPDATABLE;
-import static org.apache.datasketches.kll.KllSketch.SketchType.DOUBLES_SKETCH;
+import static org.apache.datasketches.kll.KllSketch.SketchType.KLL_DOUBLES_SKETCH;
 
 import java.lang.foreign.MemorySegment;
 
@@ -111,7 +111,7 @@ static KllDirectDoublesSketch newDirectUpdatableInstance(
     offset += 2 * ITEM_BYTES;
     //new empty items array
     MemorySegment.copy(new double[k], 0, dstSeg, JAVA_DOUBLE_UNALIGNED, offset, k);
-    final KllMemorySegmentValidate segVal = new KllMemorySegmentValidate(dstSeg, DOUBLES_SKETCH, null);
+    final KllMemorySegmentValidate segVal = new KllMemorySegmentValidate(dstSeg, KLL_DOUBLES_SKETCH, null);
     final MemorySegment wSeg = dstSeg;
     return new KllDirectDoublesSketch(wSeg, segVal, mSegmentRequest);
   }

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

@@ -44,7 +44,7 @@
 import static org.apache.datasketches.kll.KllSketch.SketchStructure.COMPACT_FULL;
 import static org.apache.datasketches.kll.KllSketch.SketchStructure.COMPACT_SINGLE;
 import static org.apache.datasketches.kll.KllSketch.SketchStructure.UPDATABLE;
-import static org.apache.datasketches.kll.KllSketch.SketchType.FLOATS_SKETCH;
+import static org.apache.datasketches.kll.KllSketch.SketchType.KLL_FLOATS_SKETCH;
 
 import java.lang.foreign.MemorySegment;
 
@@ -111,7 +111,7 @@ static KllDirectFloatsSketch newDirectUpdatableInstance(
     offset += 2 * ITEM_BYTES;
     //new empty items array
     MemorySegment.copy(new float[k], 0, dstSeg, JAVA_FLOAT_UNALIGNED, offset, k);
-    final KllMemorySegmentValidate segVal = new KllMemorySegmentValidate(dstSeg, FLOATS_SKETCH, null);
+    final KllMemorySegmentValidate segVal = new KllMemorySegmentValidate(dstSeg, KLL_FLOATS_SKETCH, null);
     final MemorySegment wSeg = dstSeg;
     return new KllDirectFloatsSketch(wSeg, segVal, mSegmentRequest);
   }

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

@@ -44,7 +44,7 @@
 import static org.apache.datasketches.kll.KllSketch.SketchStructure.COMPACT_FULL;
 import static org.apache.datasketches.kll.KllSketch.SketchStructure.COMPACT_SINGLE;
 import static org.apache.datasketches.kll.KllSketch.SketchStructure.UPDATABLE;
-import static org.apache.datasketches.kll.KllSketch.SketchType.LONGS_SKETCH;
+import static org.apache.datasketches.kll.KllSketch.SketchType.KLL_LONGS_SKETCH;
 
 import java.lang.foreign.MemorySegment;
 
@@ -111,7 +111,7 @@ static KllDirectLongsSketch newDirectUpdatableInstance(
     offset += 2 * ITEM_BYTES;
     //new empty items array
     MemorySegment.copy(new long[k], 0, dstSeg, JAVA_LONG_UNALIGNED, offset, k);
-    final KllMemorySegmentValidate segVal = new KllMemorySegmentValidate(dstSeg, LONGS_SKETCH, null);
+    final KllMemorySegmentValidate segVal = new KllMemorySegmentValidate(dstSeg, KLL_LONGS_SKETCH, null);
     final MemorySegment wSeg = dstSeg;
     return new KllDirectLongsSketch(wSeg, segVal, mSegmentRequest);
   }

src/main/java/org/apache/datasketches/kll/KllDoublesSketch.java

@@ -23,7 +23,7 @@
 import static java.lang.Math.min;
 import static org.apache.datasketches.common.ByteArrayUtil.putDoubleLE;
 import static org.apache.datasketches.kll.KllSketch.SketchStructure.UPDATABLE;
-import static org.apache.datasketches.kll.KllSketch.SketchType.DOUBLES_SKETCH;
+import static org.apache.datasketches.kll.KllSketch.SketchType.KLL_DOUBLES_SKETCH;
 
 import java.lang.foreign.MemorySegment;
 import java.util.Arrays;
@@ -51,7 +51,7 @@ public abstract class KllDoublesSketch extends KllSketch implements QuantilesDou
    * @param sketchStructure the current sketch structure
    */
   KllDoublesSketch(final SketchStructure sketchStructure) {
-    super(SketchType.DOUBLES_SKETCH, sketchStructure);
+    super(SketchType.KLL_DOUBLES_SKETCH, sketchStructure);
   }
 
   /**
@@ -167,7 +167,7 @@ public static KllDoublesSketch wrap(final MemorySegment srcSeg) {
    */
   public static KllDoublesSketch wrap(final MemorySegment srcSeg, final MemorySegmentRequest mSegReq) {
     Objects.requireNonNull(srcSeg, "Parameter 'srcSeg' must not be null");
-    final KllMemorySegmentValidate segVal = new KllMemorySegmentValidate(srcSeg, DOUBLES_SKETCH);
+    final KllMemorySegmentValidate segVal = new KllMemorySegmentValidate(srcSeg, KLL_DOUBLES_SKETCH);
     return new KllDirectDoublesSketch(srcSeg, segVal, mSegReq);
   }
 

src/main/java/org/apache/datasketches/kll/KllFloatsSketch.java

@@ -23,7 +23,7 @@
 import static java.lang.Math.min;
 import static org.apache.datasketches.common.ByteArrayUtil.putFloatLE;
 import static org.apache.datasketches.kll.KllSketch.SketchStructure.UPDATABLE;
-import static org.apache.datasketches.kll.KllSketch.SketchType.FLOATS_SKETCH;
+import static org.apache.datasketches.kll.KllSketch.SketchType.KLL_FLOATS_SKETCH;
 
 import java.lang.foreign.MemorySegment;
 import java.util.Arrays;
@@ -51,7 +51,7 @@ public abstract class KllFloatsSketch extends KllSketch implements QuantilesFloa
    * @param sketchStructure the current sketch structure
    */
   KllFloatsSketch(final SketchStructure sketchStructure) {
-    super(SketchType.FLOATS_SKETCH, sketchStructure);
+    super(SketchType.KLL_FLOATS_SKETCH, sketchStructure);
   }
 
   /**
@@ -167,7 +167,7 @@ public static KllFloatsSketch wrap(final MemorySegment srcSeg) {
    */
   public static KllFloatsSketch wrap(final MemorySegment srcSeg, final MemorySegmentRequest mSegReq) {
     Objects.requireNonNull(srcSeg, "Parameter 'srcSeg' must not be null");
-    final KllMemorySegmentValidate segVal = new KllMemorySegmentValidate(srcSeg, FLOATS_SKETCH);
+    final KllMemorySegmentValidate segVal = new KllMemorySegmentValidate(srcSeg, KLL_FLOATS_SKETCH);
     return new KllDirectFloatsSketch(srcSeg, segVal, mSegReq);
   }
 

src/main/java/org/apache/datasketches/kll/KllHeapDoublesSketch.java

@@ -27,7 +27,7 @@
 import static org.apache.datasketches.kll.KllSketch.SketchStructure.COMPACT_FULL;
 import static org.apache.datasketches.kll.KllSketch.SketchStructure.COMPACT_SINGLE;
 import static org.apache.datasketches.kll.KllSketch.SketchStructure.UPDATABLE;
-import static org.apache.datasketches.kll.KllSketch.SketchType.DOUBLES_SKETCH;
+import static org.apache.datasketches.kll.KllSketch.SketchType.KLL_DOUBLES_SKETCH;
 
 import java.lang.foreign.MemorySegment;
 import java.util.Arrays;
@@ -154,7 +154,7 @@ else if (segStructure == COMPACT_FULL) {
 
   static KllHeapDoublesSketch heapifyImpl(final MemorySegment srcSeg) {
     Objects.requireNonNull(srcSeg, "Parameter 'srcSeg' must not be null");
-    final KllMemorySegmentValidate segVal = new KllMemorySegmentValidate(srcSeg, DOUBLES_SKETCH);
+    final KllMemorySegmentValidate segVal = new KllMemorySegmentValidate(srcSeg, KLL_DOUBLES_SKETCH);
     return new KllHeapDoublesSketch(srcSeg, segVal);
   }
 

src/main/java/org/apache/datasketches/kll/KllHeapFloatsSketch.java

@@ -27,7 +27,7 @@
 import static org.apache.datasketches.kll.KllSketch.SketchStructure.COMPACT_FULL;
 import static org.apache.datasketches.kll.KllSketch.SketchStructure.COMPACT_SINGLE;
 import static org.apache.datasketches.kll.KllSketch.SketchStructure.UPDATABLE;
-import static org.apache.datasketches.kll.KllSketch.SketchType.FLOATS_SKETCH;
+import static org.apache.datasketches.kll.KllSketch.SketchType.KLL_FLOATS_SKETCH;
 
 import java.lang.foreign.MemorySegment;
 import java.util.Arrays;
@@ -154,7 +154,7 @@ else if (segStructure == COMPACT_FULL) {
 
   static KllHeapFloatsSketch heapifyImpl(final MemorySegment srcSeg) {
     Objects.requireNonNull(srcSeg, "Parameter 'srcSeg' must not be null");
-    final KllMemorySegmentValidate segVal = new KllMemorySegmentValidate(srcSeg, FLOATS_SKETCH);
+    final KllMemorySegmentValidate segVal = new KllMemorySegmentValidate(srcSeg, KLL_FLOATS_SKETCH);
     return new KllHeapFloatsSketch(srcSeg, segVal);
   }
 

src/main/java/org/apache/datasketches/kll/KllHeapItemsSketch.java

@@ -111,7 +111,7 @@ final class KllHeapItemsSketch<T> extends KllItemsSketch<T> {
       final Comparator<? super T> comparator,
       final ArrayOfItemsSerDe<T> serDe) {
     super(SketchStructure.UPDATABLE, comparator, serDe);
-    final KllMemorySegmentValidate segVal = new KllMemorySegmentValidate(srcSeg, SketchType.ITEMS_SKETCH, serDe);
+    final KllMemorySegmentValidate segVal = new KllMemorySegmentValidate(srcSeg, SketchType.KLL_ITEMS_SKETCH, serDe);
     k = segVal.k;
     m = segVal.m;
     levelsArr = segVal.levelsArr;