Clean up.

Corrected random cases of "mem" variables that should have been
refactored to "seg".

Author: leerho

src/main/java/org/apache/datasketches/cpc/CompressedState.java

@@ -137,55 +137,55 @@ static CompressedState importFromSegment(final MemorySegment seg) {
         break;
       }
       case SPARSE_HYBRID_MERGED : {
-        //state.fiCol = getFiCol(mem);
+        //state.fiCol = getFiCol(seg;
         state.numCoupons = getNumCoupons(seg);
         state.numCsv = (int) state.numCoupons; //only true for sparse_hybrid
         state.csvLengthInts = getSvLengthInts(seg);
-        //state.cwLength = getCwLength(mem);
-        //state.kxp = getKxP(mem);
-        //state.hipEstAccum = getHipAccum(mem);
+        //state.cwLength = getCwLength(seg;
+        //state.kxp = getKxP(seg;
+        //state.hipEstAccum = getHipAccum(seg;
         checkCapacity(seg.byteSize(), state.getRequiredSerializedBytes());
-        //state.cwStream = getCwStream(mem);
+        //state.cwStream = getCwStream(seg;
         state.csvStream = getSvStream(seg);
         break;
       }
       case SPARSE_HYBRID_HIP : {
-        //state.fiCol = getFiCol(mem);
+        //state.fiCol = getFiCol(seg;
         state.numCoupons = getNumCoupons(seg);
         state.numCsv = (int) state.numCoupons; //only true for sparse_hybrid
         state.csvLengthInts = getSvLengthInts(seg);
-        //state.cwLength = getCwLength(mem);
+        //state.cwLength = getCwLength(seg;
         state.kxp = getKxP(seg);
         state.hipEstAccum = getHipAccum(seg);
         checkCapacity(seg.byteSize(), state.getRequiredSerializedBytes());
-        //state.cwStream = getCwStream(mem);
+        //state.cwStream = getCwStream(seg;
         state.csvStream = getSvStream(seg);
         break;
       }
       case PINNED_SLIDING_MERGED_NOSV : {
         state.fiCol = getFiCol(seg);
         state.numCoupons = getNumCoupons(seg);
-        //state.numCsv = getNumCsv(mem);
-        //state.csvLength = getCsvLength(mem);
+        //state.numCsv = getNumCsv(seg;
+        //state.csvLength = getCsvLength(seg;
         state.cwLengthInts = getWLengthInts(seg);
-        //state.kxp = getKxP(mem);
-        //state.hipEstAccum = getHipAccum(mem);
+        //state.kxp = getKxP(seg;
+        //state.hipEstAccum = getHipAccum(seg;
         checkCapacity(seg.byteSize(), state.getRequiredSerializedBytes());
         state.cwStream = getWStream(seg);
-        //state.csvStream = getCsvStream(mem);
+        //state.csvStream = getCsvStream(seg;
         break;
       }
       case PINNED_SLIDING_HIP_NOSV : {
         state.fiCol = getFiCol(seg);
         state.numCoupons = getNumCoupons(seg);
-        //state.numCsv = getNumCsv(mem);
-        //state.csvLength = getCsvLength(mem);
+        //state.numCsv = getNumCsv(seg;
+        //state.csvLength = getCsvLength(seg;
         state.cwLengthInts = getWLengthInts(seg);
         state.kxp = getKxP(seg);
         state.hipEstAccum = getHipAccum(seg);
         checkCapacity(seg.byteSize(), state.getRequiredSerializedBytes());
         state.cwStream = getWStream(seg);
-        //state.csvStream = getCsvStream(mem);
+        //state.csvStream = getCsvStream(seg;
         break;
       }
       case PINNED_SLIDING_MERGED : {
@@ -194,8 +194,8 @@ static CompressedState importFromSegment(final MemorySegment seg) {
         state.numCsv = getNumSv(seg);
         state.csvLengthInts = getSvLengthInts(seg);
         state.cwLengthInts = getWLengthInts(seg);
-        //state.kxp = getKxP(mem);
-        //state.hipEstAccum = getHipAccum(mem);
+        //state.kxp = getKxP(seg;
+        //state.hipEstAccum = getHipAccum(seg;
         checkCapacity(seg.byteSize(), state.getRequiredSerializedBytes());
         state.cwStream = getWStream(seg);
         state.csvStream = getSvStream(seg);

src/main/java/org/apache/datasketches/frequencies/PreambleUtil.java

@@ -253,7 +253,7 @@ static long checkPreambleSize(final MemorySegment seg) {
   private static void throwNotBigEnough(final long cap, final int required) {
     throw new SketchesArgumentException(
         "Possible Corruption: "
-            + "Size of byte array or Memory not large enough for Preamble: Size: " + cap
+            + "Size of byte array or MemorySegment not large enough for Preamble: Size: " + cap
             + ", Required: " + required);
   }
 

src/main/java/org/apache/datasketches/hll/DirectHllArray.java

@@ -68,7 +68,7 @@ private static int checkSegCompactFlag(final MemorySegment wseg, final int lgCon
     return lgConfigK;
   }
 
-  //Memory must be already initialized and may have data. Writable, must not be Compact.
+  //MemorySegment must be already initialized and may have data. Writable, must not be Compact.
   DirectHllArray(final int lgConfigK, final TgtHllType tgtHllType, final MemorySegment wseg) {
     super(checkSegCompactFlag(wseg, lgConfigK), tgtHllType, CurMode.HLL);
     this.wseg = wseg;
@@ -78,7 +78,7 @@ private static int checkSegCompactFlag(final MemorySegment wseg, final int lgCon
     insertEmptyFlag(wseg, false);
   }
 
-  //Memory must already be initialized and should have data. Read-only. May be Compact or not
+  //MemorySegment must already be initialized and should have data. Read-only. May be Compact or not
   DirectHllArray(final int lgConfigK, final TgtHllType tgtHllType, final MemorySegment seg, final boolean readOnly) {
     super(lgConfigK, tgtHllType, CurMode.HLL);
     wseg = null;

src/main/java/org/apache/datasketches/hll/HllUtil.java

@@ -84,7 +84,7 @@ static int checkLgK(final int lgK) {
   static void checkSegSize(final long minBytes, final long capBytes) {
     if (capBytes < minBytes) {
       throw new SketchesArgumentException(
-          "Given WritableMemory is not large enough: " + capBytes);
+          "Given MemorySegment is not large enough: " + capBytes);
     }
   }
 

src/main/java/org/apache/datasketches/hll/IntMemorySegmentPairIterator.java

@@ -25,7 +25,7 @@
 import java.lang.foreign.MemorySegment;
 
 /**
- * Iterates within a given Memory extracting integer pairs.
+ * Iterates within a given MemorySegment extracting integer pairs.
  *
  * @author Lee Rhodes
  */

src/main/java/org/apache/datasketches/hll/package-info.java

@@ -34,8 +34,8 @@
  *
  * <p>Accuracy for very small streams can be important because Big Data is often fragmented into millions of smaller
  * streams (or segments) that inevitably are power-law distributed in size. If you are sketching all these fragments,
- * as a general rule, more than 80% of your sketches will be very small, 20% will be much larger, and only a few very
- * large in cardinality.
+ * as a general rule, more than 80% of your sketches will be very small, 20% will be much larger, and only a few will
+ * be very large in cardinality.</p>
  *
  * <h4>HIP / Martingale Estimator</h4>
  * When obtaining a cardinality estimate, the sketch automatically determines if it was the result of the capture of
@@ -96,7 +96,7 @@
  * terms of update time, but has the smallest storage footprint of about <i>K/2 * 1.03</i> bytes.
  *
  * <h3>Off-Heap Operation</h3>
- * This HLL sketch also offers the capability of operating off-heap. Given a <i>WritableMemory[5]</i> object
+ * This HLL sketch also offers the capability of operating off-heap. Given a <i>MemorySegment[5]</i> object
  * created by the user, the sketch will perform all of its updates and internal phase transitions
  * in that object, which can actually reside either on-heap or off-heap based on how it was
  * configured. In large systems that must update and union many millions of sketches, having the
@@ -146,9 +146,8 @@
 <i>Back to the Future: an Even More Nearly Optimal Cardinality Estimation Algorithm.</i></a>
  * arXiv 1708.06839, August 22, 2017, Yahoo Research.
  *
- * <p>[5] Memory Component,
- * <a href="https://datasketches.apache.org/docs/Memory/MemoryComponent.html">
-<i>DataSketches Memory Component</i></a>
+ * <p>[5] MemorySegment Component, See
+ * <a href="https://openjdk.org/jeps/454"><i>JEP 454: Foreign Function & Memory API</i></a>
  *
  * <p>[6] MacBook Pro 2.3 GHz 8-Core Intel Core i9
  *

src/main/java/org/apache/datasketches/thetacommon/HashOperations.java

@@ -229,18 +229,18 @@ public static int hashSearchMemorySegment(final MemorySegment seg, final int lgA
    * @param lgArrLongs The log_base2(hashTable.length.
    * <a href="{@docRoot}/resources/dictionary.html#lgArrLongs">See lgArrLongs</a>.
    * @param hash value that must not be zero and will be inserted into the array into an empty slot.
-   * @param memOffsetBytes offset in the writable <i>MemorySegment</i> where the hashTable starts
+   * @param segOffsetBytes offset in the writable <i>MemorySegment</i> where the hashTable starts
    * @return index of insertion.  Always positive or zero.
    */
   public static int hashInsertOnlyMemorySegment(final MemorySegment wseg, final int lgArrLongs,
-      final long hash, final int memOffsetBytes) {
+      final long hash, final int segOffsetBytes) {
     final int arrayMask = (1 << lgArrLongs) - 1; // current Size -1
     final int stride = getStride(hash, lgArrLongs);
     int curProbe = (int) (hash & arrayMask);
     // search for duplicate or zero
     final int loopIndex = curProbe;
     do {
-      final int curProbeOffsetBytes = (curProbe << 3) + memOffsetBytes;
+      final int curProbeOffsetBytes = (curProbe << 3) + segOffsetBytes;
       final long curArrayHash = wseg.get(JAVA_LONG_UNALIGNED, curProbeOffsetBytes);
       if (curArrayHash == EMPTY) {
         wseg.set(JAVA_LONG_UNALIGNED, curProbeOffsetBytes, hash);
@@ -262,18 +262,18 @@ public static int hashInsertOnlyMemorySegment(final MemorySegment wseg, final in
    * <a href="{@docRoot}/resources/dictionary.html#lgArrLongs">See lgArrLongs</a>.
    * @param hash The hash value to be potentially inserted into an empty slot only if it is not
    * a duplicate of any other hash value in the table. It must not be zero.
-   * @param memOffsetBytes offset in the writable <i>MemorySegment</i> where the hash array starts
+   * @param segOffsetBytes offset in the writable <i>MemorySegment</i> where the hash array starts
    * @return index &ge; 0 if found (duplicate); &lt; 0 if inserted, inserted at -(index + 1).
    */
   public static int hashSearchOrInsertMemorySegment(final MemorySegment wseg, final int lgArrLongs,
-      final long hash, final int memOffsetBytes) {
+      final long hash, final int segOffsetBytes) {
     final int arrayMask = (1 << lgArrLongs) - 1; // current Size -1
     final int stride = getStride(hash, lgArrLongs);
     int curProbe = (int) (hash & arrayMask);
     // search for duplicate or zero
     final int loopIndex = curProbe;
     do {
-      final int curProbeOffsetBytes = (curProbe << 3) + memOffsetBytes;
+      final int curProbeOffsetBytes = (curProbe << 3) + segOffsetBytes;
       final long curArrayHash = wseg.get(JAVA_LONG_UNALIGNED, curProbeOffsetBytes);
       if (curArrayHash == EMPTY) {
         wseg.set(JAVA_LONG_UNALIGNED, curProbeOffsetBytes, hash);

src/test/java/org/apache/datasketches/cpc/CompressedStateTest.java

@@ -65,7 +65,7 @@ private void updateStateUnion(final CpcSketch sk) {
   }
 
   @Test
-  public void checkLoadMemory() {
+  public void checkLoadMemorySegment() {
     printf("%8s %8s %10s %35s\n", "vIn", "c", "Flavor", "Format");
     final CpcSketch sk = new CpcSketch(lgK);
     final int k = 1 << lgK;

src/test/java/org/apache/datasketches/filters/bloomfilter/DirectBitArrayRTest.java

@@ -37,7 +37,7 @@
 
 public class DirectBitArrayRTest {
 
-  private static MemorySegment bitArrayToMemory(final HeapBitArray ba) {
+  private static MemorySegment bitArrayToMemorySegment(final HeapBitArray ba) {
     // assumes we're using small enough an array to test that
     // size can be measured with an int
     final int numBytes = (int) ba.getSerializedSizeBytes();
@@ -53,7 +53,7 @@ public void createBitArrayTest() {
     final HeapBitArray hba = new HeapBitArray(119);
     assertTrue(hba.isEmpty());
 
-    final MemorySegment seg = bitArrayToMemory(hba);
+    final MemorySegment seg = bitArrayToMemorySegment(hba);
     final DirectBitArrayR dba = DirectBitArrayR.wrap(seg, hba.isEmpty());
     assertTrue(dba.isEmpty());
     assertEquals(dba.getCapacity(), 128); // nearest multiple of 64
@@ -92,7 +92,7 @@ public void basicOperationTest() {
     assertTrue(hba.getBit(68));
     assertFalse(hba.isEmpty());
 
-    final MemorySegment seg = bitArrayToMemory(hba);
+    final MemorySegment seg = bitArrayToMemorySegment(hba);
     final DirectBitArrayR dba = DirectBitArrayR.wrap(seg, hba.isEmpty());
     assertEquals(dba.getNumBitsSet(), 6);
     assertTrue(dba.getBit(68));
@@ -118,7 +118,7 @@ public void countBitsWhenDirty() {
     assertTrue(hba.getBit(68));
     assertFalse(hba.isEmpty());
 
-    final MemorySegment seg = bitArrayToMemory(hba);
+    final MemorySegment seg = bitArrayToMemorySegment(hba);
     final DirectBitArrayR dba = DirectBitArrayR.wrap(seg, hba.isEmpty());
     assertEquals(dba.getNumBitsSet(), 6);
     assertTrue(dba.getBit(68));
@@ -130,7 +130,7 @@ public void countBitsWhenDirty() {
   public void bitAddressOutOfBoundsEmptyTest() {
     final int numBits = 256;
     final HeapBitArray hba = new HeapBitArray(numBits);
-    final MemorySegment seg = bitArrayToMemory(hba);
+    final MemorySegment seg = bitArrayToMemorySegment(hba);
     final DirectBitArrayR dba = DirectBitArrayR.wrap(seg, hba.isEmpty());
     assertFalse(dba.getBit(19));   // in range
     assertFalse(dba.getBit(-10));        // out of bounds
@@ -145,7 +145,7 @@ public void bitAddressOutOfBoundsNonEmptyTest() {
       hba.getAndSetBit(i);
     }
 
-    final MemorySegment seg = bitArrayToMemory(hba);
+    final MemorySegment seg = bitArrayToMemorySegment(hba);
     final DirectBitArrayR dba = DirectBitArrayR.wrap(seg, hba.isEmpty());
     assertThrows(IndexOutOfBoundsException.class, () -> dba.getBit(-10));
     assertThrows(IndexOutOfBoundsException.class, () -> dba.getBit(2048));
@@ -159,7 +159,7 @@ public void checkInvalidMethods() {
       hba.getAndSetBit(i);
     }
 
-    final MemorySegment seg = bitArrayToMemory(hba);
+    final MemorySegment seg = bitArrayToMemorySegment(hba);
     final DirectBitArrayR dba = DirectBitArrayR.wrap(seg, hba.isEmpty());
 
     // all of these try to modify a read-only MemorySegment

src/test/java/org/apache/datasketches/hll/CouponListTest.java

@@ -145,7 +145,7 @@ private static void toByteArrayHeapify(final int lgK) {
   }
 
   @Test
-  public void checkGetMemory() {
+  public void checkGetMemorySegment() {
     final HllSketch sk1 = new HllSketch(4);
     final AbstractCoupons absCoup = (AbstractCoupons) sk1.hllSketchImpl;
     assertNull(absCoup.getMemorySegment());