Change name of /theta/Sketch to /theta/ThetaSketch

Author: leerho

src/main/java/org/apache/datasketches/theta/AnotB.java

@@ -92,7 +92,7 @@ public Family getFamily() {
    *
    * @param skA The incoming sketch for the first argument, <i>A</i>.
    */
-  public abstract void setA(Sketch skA);
+  public abstract void setA(ThetaSketch skA);
 
   /**
    * This is part of a multistep, stateful AnotB operation and sets the given Theta sketch as the
@@ -111,12 +111,12 @@ public Family getFamily() {
    *
    * @param skB The incoming Theta sketch for the second (or following) argument <i>B</i>.
    */
-  public abstract void notB(Sketch skB);
+  public abstract void notB(ThetaSketch skB);
 
   /**
    * Gets the result of the multistep, stateful operation AnotB that have been executed with calls
-   * to {@link #setA(Sketch)} and ({@link #notB(Sketch)} or
-   * {@link #notB(org.apache.datasketches.theta.Sketch)}).
+   * to {@link #setA(ThetaSketch)} and ({@link #notB(ThetaSketch)} or
+   * {@link #notB(org.apache.datasketches.theta.ThetaSketch)}).
    *
    * @param reset If <i>true</i>, clears this operator to the empty state after this result is
    * returned. Set this to <i>false</i> if you wish to obtain an intermediate result.
@@ -127,8 +127,8 @@ public Family getFamily() {
 
   /**
    * Gets the result of the multistep, stateful operation AnotB that have been executed with calls
-   * to {@link #setA(Sketch)} and ({@link #notB(Sketch)} or
-   * {@link #notB(org.apache.datasketches.theta.Sketch)}).
+   * to {@link #setA(ThetaSketch)} and ({@link #notB(ThetaSketch)} or
+   * {@link #notB(org.apache.datasketches.theta.ThetaSketch)}).
    *
    * @param dstOrdered If <i>true</i>, the result will be an ordered {@link CompactSketch}.
    * <a href="{@docRoot}/resources/dictionary.html#dstOrdered">See Destination Ordered</a>.
@@ -147,8 +147,8 @@ public Family getFamily() {
    * ordered CompactSketch on the heap.
    *
    * <p>This a stateless operation and has no impact on the internal state of this operator.
-   * Thus, this is not an accumulating update and does not interact with the {@link #setA(Sketch)},
-   * {@link #notB(Sketch)}, {@link #getResult(boolean)}, or
+   * Thus, this is not an accumulating update and does not interact with the {@link #setA(ThetaSketch)},
+   * {@link #notB(ThetaSketch)}, {@link #getResult(boolean)}, or
    * {@link #getResult(boolean, MemorySegment, boolean)} methods.</p>
    *
    * <p>If either argument is null an exception is thrown.</p>
@@ -166,7 +166,7 @@ public Family getFamily() {
    * @param skB The incoming sketch for the second argument. It must not be null.
    * @return an ordered CompactSketch on the heap
    */
-  public CompactSketch aNotB(final Sketch skA, final Sketch skB) {
+  public CompactSketch aNotB(final ThetaSketch skA, final ThetaSketch skB) {
     return aNotB(skA, skB, true, null);
   }
 
@@ -175,8 +175,8 @@ public CompactSketch aNotB(final Sketch skA, final Sketch skB) {
    * CompactSketch.
    *
    * <p>This a stateless operation and has no impact on the internal state of this operator.
-   * Thus, this is not an accumulating update and does not interact with the {@link #setA(Sketch)},
-   * {@link #notB(Sketch)}, {@link #getResult(boolean)}, or
+   * Thus, this is not an accumulating update and does not interact with the {@link #setA(ThetaSketch)},
+   * {@link #notB(ThetaSketch)}, {@link #getResult(boolean)}, or
    * {@link #getResult(boolean, MemorySegment, boolean)} methods.</p>
    *
    * <p>If either argument is null an exception is thrown.</p>
@@ -197,7 +197,7 @@ public CompactSketch aNotB(final Sketch skA, final Sketch skB) {
    * @param dstSeg the destination MemorySegment
    * @return the result as a CompactSketch.
    */
-  public abstract CompactSketch aNotB(Sketch skA, Sketch skB, boolean dstOrdered,
+  public abstract CompactSketch aNotB(ThetaSketch skA, ThetaSketch skB, boolean dstOrdered,
       MemorySegment dstSeg);
 
 }

src/main/java/org/apache/datasketches/theta/AnotBimpl.java

@@ -65,7 +65,7 @@ private AnotBimpl(final short seedHash) {
   }
 
   @Override
-  public void setA(final Sketch skA) {
+  public void setA(final ThetaSketch skA) {
     if (skA == null) {
       reset();
       throw new SketchesArgumentException("The input argument <i>A</i> must not be null");
@@ -85,7 +85,7 @@ public void setA(final Sketch skA) {
   }
 
   @Override
-  public void notB(final Sketch skB) {
+  public void notB(final ThetaSketch skB) {
     if (empty_ || (skB == null) || skB.isEmpty()) { return; }
     //local and skB is not empty
     Util.checkSeedHashes(seedHash_, skB.getSeedHash());
@@ -113,7 +113,7 @@ public CompactSketch getResult(final boolean dstOrdered, final MemorySegment dst
   }
 
   @Override
-  public CompactSketch aNotB(final Sketch skA, final Sketch skB, final boolean dstOrdered,
+  public CompactSketch aNotB(final ThetaSketch skA, final ThetaSketch skB, final boolean dstOrdered,
       final MemorySegment dstSeg) {
     if ((skA == null) || (skB == null)) {
       throw new SketchesArgumentException("Neither argument may be null");
@@ -152,7 +152,7 @@ int getRetainedEntries() {
 
   //restricted
 
-  private static long[] getHashArrA(final Sketch skA) { //returns a new array
+  private static long[] getHashArrA(final ThetaSketch skA) { //returns a new array
     //Get skA cache as array
     final CompactSketch cskA = skA.compact(false, null); //sorting not required
     return cskA.getCache().clone();
@@ -162,7 +162,7 @@ private static long[] getResultHashArr( //returns a new array
       final long minThetaLong,
       final int countA,
       final long[] hashArrA,
-      final Sketch skB) {
+      final ThetaSketch skB) {
 
     // Rebuild or get hashtable of skB
     final long[] hashTableB; //read only
@@ -192,7 +192,7 @@ private static long[] getResultHashArr( //returns a new array
   }
 
   private static long[] convertToHashTable(
-      final Sketch sketch,
+      final ThetaSketch sketch,
       final long thetaLong,
       final double rebuildThreshold) {
     final int lgArrLongs = minLgHashTableSize(sketch.getRetainedEntries(true), rebuildThreshold);

src/main/java/org/apache/datasketches/theta/CompactSketch.java

@@ -58,7 +58,7 @@
  *
  * @author Lee Rhodes
  */
-public abstract class CompactSketch extends Sketch {
+public abstract class CompactSketch extends ThetaSketch {
 
   /**
    * Heapify takes a CompactSketch image in a MemorySegment and instantiates an on-heap CompactSketch.
@@ -303,7 +303,7 @@ public boolean isSameResource(final MemorySegment that) {
 
   @Override
   public double getEstimate() {
-    return Sketch.estimate(getThetaLong(), getRetainedEntries());
+    return ThetaSketch.estimate(getThetaLong(), getRetainedEntries());
   }
 
   /**
@@ -386,7 +386,7 @@ private byte[] toByteArrayV4() {
   }
 
   private static CompactSketch heapifyV4(final MemorySegment srcSeg, final long seed) {
-    final int preLongs = Sketch.getPreambleLongs(srcSeg);
+    final int preLongs = ThetaSketch.getPreambleLongs(srcSeg);
     final int entryBits = extractEntryBitsV4(srcSeg);
     final int numEntriesBytes = extractNumEntriesBytesV4(srcSeg);
     final short seedHash = (short) extractSeedHash(srcSeg);

src/main/java/org/apache/datasketches/theta/ConcurrentBackgroundThetaPropagation.java

@@ -40,7 +40,7 @@ final class ConcurrentBackgroundThetaPropagation implements Runnable {
   private final AtomicBoolean localPropagationInProgress;
 
   // Sketch to be propagated to shared sketch. Can be null if only a single hash is propagated
-  private final Sketch sketchIn;
+  private final ThetaSketch sketchIn;
 
   // Hash of the datum to be propagated to shared sketch. Can be ConcurrentSharedThetaSketch.NOT_SINGLE_HASH
   // if the data is propagated through a sketch.
@@ -52,7 +52,7 @@ final class ConcurrentBackgroundThetaPropagation implements Runnable {
   private final long epoch;
 
   ConcurrentBackgroundThetaPropagation(final ConcurrentSharedThetaSketch sharedThetaSketch,
-      final AtomicBoolean localPropagationInProgress, final Sketch sketchIn, final long singleHash,
+      final AtomicBoolean localPropagationInProgress, final ThetaSketch sketchIn, final long singleHash,
       final long epoch) {
     this.sharedThetaSketch = sharedThetaSketch;
     this.localPropagationInProgress = localPropagationInProgress;

src/main/java/org/apache/datasketches/theta/ConcurrentDirectQuickSelectSketch.java

@@ -207,7 +207,7 @@ public void initBgPropagationService() {
 
   @Override
   public boolean propagate(final AtomicBoolean localPropagationInProgress,
-                           final Sketch sketchIn, final long singleHash) {
+                           final ThetaSketch sketchIn, final long singleHash) {
     final long epoch = epoch_;
     if (singleHash != NOT_SINGLE_HASH                   // namely, is a single hash and
         && getRetainedEntries(false) < exactLimit_) {   // a small sketch then propagate myself (blocking)

src/main/java/org/apache/datasketches/theta/ConcurrentHeapQuickSelectSketch.java

@@ -199,7 +199,7 @@ public void initBgPropagationService() {
 
   @Override
   public boolean propagate(final AtomicBoolean localPropagationInProgress,
-                           final Sketch sketchIn, final long singleHash) {
+                           final ThetaSketch sketchIn, final long singleHash) {
     final long epoch = epoch_;
     if ((singleHash != NOT_SINGLE_HASH)                 //namely, is a single hash and
         && (getRetainedEntries(false) < exactLimit_)) { //a small sketch then propagate myself (blocking)

src/main/java/org/apache/datasketches/theta/ConcurrentSharedThetaSketch.java

@@ -86,7 +86,7 @@ static long computeExactLimit(final long k, final double error) {
    * @param singleHash a single hash value
    * @return true if propagation successfully started
    */
-  boolean propagate(final AtomicBoolean localPropagationInProgress, final Sketch sketchIn,
+  boolean propagate(final AtomicBoolean localPropagationInProgress, final ThetaSketch sketchIn,
     final long singleHash);
 
   /**

src/main/java/org/apache/datasketches/theta/DirectCompactCompressedSketch.java

@@ -74,7 +74,7 @@ public CompactSketch compact(final boolean dstOrdered, final MemorySegment dstSe
 
   @Override
   public int getCurrentBytes() {
-    final int preLongs = Sketch.getPreambleLongs(seg_);
+    final int preLongs = ThetaSketch.getPreambleLongs(seg_);
     final int entryBits = extractEntryBitsV4(seg_);
     final int numEntriesBytes = extractNumEntriesBytesV4(seg_);
     return preLongs * Long.BYTES + numEntriesBytes + wholeBytesToHoldBits(getRetainedEntries() * entryBits);
@@ -88,7 +88,7 @@ public int getRetainedEntries(final boolean valid) { //valid is only relevant fo
     // number of entries is stored using variable length encoding
     // most significant bytes with all zeros are not stored
     // one byte in the preamble has the number of non-zero bytes used
-    final int preLongs = Sketch.getPreambleLongs(seg_); // if > 1 then the second long has theta
+    final int preLongs = ThetaSketch.getPreambleLongs(seg_); // if > 1 then the second long has theta
     final int numEntriesBytes = extractNumEntriesBytesV4(seg_);
     int offsetBytes = preLongs > 1 ? START_PACKED_DATA_ESTIMATION_MODE : START_PACKED_DATA_EXACT_MODE;
     int numEntries = 0;
@@ -100,7 +100,7 @@ public int getRetainedEntries(final boolean valid) { //valid is only relevant fo
 
   @Override
   public long getThetaLong() {
-    final int preLongs = Sketch.getPreambleLongs(seg_);
+    final int preLongs = ThetaSketch.getPreambleLongs(seg_);
     return (preLongs > 1) ? extractThetaLongV4(seg_) : Long.MAX_VALUE;
   }
 
@@ -118,7 +118,7 @@ public boolean isOrdered() {
   public HashIterator iterator() {
     return new MemorySegmentCompactCompressedHashIterator(
       seg_,
-      (Sketch.getPreambleLongs(seg_) > 1 ? START_PACKED_DATA_ESTIMATION_MODE : START_PACKED_DATA_EXACT_MODE)
+      (ThetaSketch.getPreambleLongs(seg_) > 1 ? START_PACKED_DATA_ESTIMATION_MODE : START_PACKED_DATA_EXACT_MODE)
         + extractNumEntriesBytesV4(seg_),
       extractEntryBitsV4(seg_),
       getRetainedEntries()

src/main/java/org/apache/datasketches/theta/DirectCompactSketch.java

@@ -81,21 +81,21 @@ public CompactSketch compact(final boolean dstOrdered, final MemorySegment dstSe
   @Override
   public int getCurrentBytes() {
     if (checkForSingleItem(seg_)) { return 16; }
-    final int preLongs = Sketch.getPreambleLongs(seg_);
+    final int preLongs = ThetaSketch.getPreambleLongs(seg_);
     final int curCount = (preLongs == 1) ? 0 : extractCurCount(seg_);
     return (preLongs + curCount) << 3;
   }
 
   @Override
   public int getRetainedEntries(final boolean valid) { //valid is only relevant for the Alpha Sketch
     if (checkForSingleItem(seg_)) { return 1; }
-    final int preLongs = Sketch.getPreambleLongs(seg_);
+    final int preLongs = ThetaSketch.getPreambleLongs(seg_);
     return (preLongs == 1) ? 0 : extractCurCount(seg_);
   }
 
   @Override
   public long getThetaLong() {
-    final int preLongs = Sketch.getPreambleLongs(seg_);
+    final int preLongs = ThetaSketch.getPreambleLongs(seg_);
     return (preLongs > 2) ? extractThetaLong(seg_) : Long.MAX_VALUE;
   }
 
@@ -147,7 +147,7 @@ public byte[] toByteArray() {
   @Override
   long[] getCache() {
     if (checkForSingleItem(seg_)) { return new long[] { seg_.get(JAVA_LONG_UNALIGNED, 8) }; }
-    final int preLongs = Sketch.getPreambleLongs(seg_);
+    final int preLongs = ThetaSketch.getPreambleLongs(seg_);
     final int curCount = (preLongs == 1) ? 0 : extractCurCount(seg_);
     if (curCount > 0) {
       final long[] cache = new long[curCount];
@@ -159,12 +159,12 @@ long[] getCache() {
 
   @Override
   int getCompactPreambleLongs() {
-    return Sketch.getPreambleLongs(seg_);
+    return ThetaSketch.getPreambleLongs(seg_);
   }
 
   @Override
   int getCurrentPreambleLongs() {
-    return Sketch.getPreambleLongs(seg_);
+    return ThetaSketch.getPreambleLongs(seg_);
   }
 
   @Override

src/main/java/org/apache/datasketches/theta/DirectQuickSelectSketch.java

@@ -175,7 +175,7 @@ static DirectQuickSelectSketch writableWrap(
       final MemorySegment srcSeg,
       final MemorySegmentRequest mSegReq,
       final long seed) {
-    final int preambleLongs = Sketch.getPreambleLongs(srcSeg);                  //byte 0
+    final int preambleLongs = ThetaSketch.getPreambleLongs(srcSeg);                  //byte 0
     final int lgNomLongs = extractLgNomLongs(srcSeg);                   //byte 3
     final int lgArrLongs = extractLgArrLongs(srcSeg);                   //byte 4