Improve & correct Javadocs

Add some missing methods.

Author: leerho

.github/workflows/auto-jdk-matrix.yml

@@ -20,7 +20,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        jdk: [ 21 ]
+        jdk: [ 24 ]
 
     env:
       JDK_VERSION: ${{ matrix.jdk }}

.github/workflows/auto-os-matrix.yml

@@ -21,7 +21,7 @@ jobs:
       fail-fast: false
 
       matrix:
-        jdk: [ 21 ]
+        jdk: [ 24 ]
         os: [ windows-latest, ubuntu-latest, macos-latest ]
         include:
           - os: windows-latest

.github/workflows/check_cpp_files.yml

@@ -27,7 +27,7 @@ jobs:
       - name: Setup Java
         uses: actions/setup-java@v4
         with:
-          java-version: '21'
+          java-version: '24'
           distribution: 'temurin'
 
       - name: Configure C++ build

.github/workflows/codeql-analysis.yml

@@ -35,7 +35,7 @@ jobs:
         with:
           distribution: 'temurin'
           cache: 'maven'
-          java-version: '21'
+          java-version: '24'
 
       - name: Initialize CodeQL
         uses: github/codeql-action/init@v3

.github/workflows/javadoc.yml

@@ -16,7 +16,7 @@ jobs:
       - name: Setup Java
         uses: actions/setup-java@v4
         with:
-          java-version: '21'
+          java-version: '24'
           distribution: 'temurin'
 
       - name: Echo Java Version

src/main/java/org/apache/datasketches/quantiles/DoublesUnionImpl.java

@@ -20,6 +20,7 @@
 package org.apache.datasketches.quantiles;
 
 import static org.apache.datasketches.common.Util.LS;
+import static org.apache.datasketches.quantiles.ClassicUtil.checkIsMemorySegmentCompact;
 import static org.apache.datasketches.quantiles.DoublesUtil.copyToHeap;
 
 import java.lang.foreign.MemorySegment;
@@ -111,8 +112,8 @@ static DoublesUnionImpl heapifyInstance(final MemorySegment srcSeg) {
   }
 
   /**
-   * Returns an updatable Union object that wraps the data of the given MemorySegment
-   * image of a updatable DoublesSketch. The data of the Union will remain in the MemorySegment.
+   * Returns an Union object that wraps the data of the given MemorySegment image of a UpdateDoublesSketch.
+   * The data of the Union will remain in the MemorySegment.
    *
    * @param srcSeg A MemorySegment image of an updatable DoublesSketch to be used as the data structure for the union and will be modified.
    * @param mSegReq the MemorySegmentRequest used if the given MemorySegment needs to expand.
@@ -138,7 +139,12 @@ public void union(final DoublesSketch sketchIn) {
   @Override
   public void union(final MemorySegment seg) {
     Objects.requireNonNull(seg);
-    gadget_ = updateLogic(maxK_, gadget_, DoublesSketch.writableWrap(seg, null));
+    if (checkIsMemorySegmentCompact(seg)) {
+      gadget_ = updateLogic(maxK_, gadget_, DoublesSketch.wrap(seg));
+    } else {
+      gadget_ = updateLogic(maxK_, gadget_, DoublesSketch.writableWrap(seg, null));
+    }
+
     gadget_.doublesSV = null;
   }
 

src/test/java/org/apache/datasketches/quantiles/DirectCompactDoublesSketchTest.java

@@ -97,7 +97,7 @@ public void wrapEmptyCompactSketch() {
     final CompactDoublesSketch s1 = DoublesSketch.builder().build().compact();
     final MemorySegment seg
             = MemorySegment.ofBuffer(ByteBuffer.wrap(s1.toByteArray()).order(ByteOrder.nativeOrder()));
-    final DoublesSketch s2 = DoublesSketch.wrap(seg, MemorySegmentRequest.DEFAULT);
+    final DoublesSketch s2 = DoublesSketch.wrap(seg);
     assertTrue(s2.isEmpty());
     assertEquals(s2.getN(), 0);
     assertTrue(Double.isNaN(s2.isEmpty() ? Double.NaN : s2.getMinItem()));

src/test/java/org/apache/datasketches/quantiles/DirectUpdateDoublesSketchTest.java

@@ -230,7 +230,7 @@ public void serializeDeserialize() {
 
     final byte[] arr2 = sketch2.toByteArray(false);
     assertEquals(arr2.length, sketch2.getSerializedSizeBytes());
-    final DoublesSketch sketch3 = DoublesSketch.wrap(MemorySegment.ofArray(arr2), null);
+    final DoublesSketch sketch3 = DoublesSketch.writableWrap(MemorySegment.ofArray(arr2), null);
     assertEquals(sketch3.getMinItem(), 0.0);
     assertEquals(sketch3.getMaxItem(), 1999.0);
     assertEquals(sketch3.getQuantile(0.5), 1000.0, 10.0);

src/test/java/org/apache/datasketches/quantiles/DoublesMiscTest.java

@@ -44,7 +44,7 @@ public void wrapAndUpdating() {
     Assert.assertEquals(bytes.length, curBytes);
     //convert to MemorySegment
     final MemorySegment seg = MemorySegment.ofArray(bytes);
-    final UpdateDoublesSketch sk2 = (UpdateDoublesSketch) DoublesSketch.wrap(seg, null);
+    final UpdateDoublesSketch sk2 = (UpdateDoublesSketch) DoublesSketch.writableWrap(seg, null);
     assertEquals(seg.byteSize(), curBytes);
     sk2.update(3);
     sk2.update(4);
@@ -60,10 +60,8 @@ public void wrapCompactSketch() {
     final UpdateDoublesSketch s1 = DoublesSketch.builder().build();
     s1.update(1);
     s1.update(2);
-    //MemorySegment seg = MemorySegment.ofArray(ByteBuffer.wrap(s1.compact().toByteArray())
-    // .asReadOnlyBuffer().order(ByteOrder.nativeOrder())););
     final MemorySegment seg = MemorySegment.ofArray(s1.compact().toByteArray());
-    final DoublesSketch s2 = DoublesSketch.wrap(seg, null); // compact, so this is ok
+    final DoublesSketch s2 = DoublesSketch.wrap(seg); // compact, so this is ok
     assertEquals(s2.getMinItem(), 1.0);
     assertEquals(s2.getMaxItem(), 2.0);
     assertEquals(s2.getN(), 2);
@@ -123,7 +121,7 @@ public void heapifyEmptyCompactSketch() {
   public void wrapEmptyUpdateSketch() {
     final UpdateDoublesSketch s1 = DoublesSketch.builder().build();
     final MemorySegment seg = MemorySegment.ofArray(s1.toByteArray()).asReadOnly();
-    final UpdateDoublesSketch s2 = (UpdateDoublesSketch) DoublesSketch.wrap(seg, null);
+    final UpdateDoublesSketch s2 = (UpdateDoublesSketch) DoublesSketch.writableWrap(seg, null);
     assertTrue(s2.isEmpty());
 
     // ensure the various put calls fail
@@ -189,7 +187,7 @@ public void wrapEmptyUpdateSketch() {
   public void wrapEmptyCompactSketch() {
     final UpdateDoublesSketch s1 = DoublesSketch.builder().build();
     final MemorySegment seg = MemorySegment.ofArray(s1.compact().toByteArray());
-    final DoublesSketch s2 = DoublesSketch.wrap(seg, null); // compact, so this is ok
+    final DoublesSketch s2 = DoublesSketch.wrap(seg); // compact, so this is ok
     Assert.assertTrue(s2.isEmpty());
   }
 
@@ -207,7 +205,7 @@ public void heapifyUnionFromSparse() {
   }
 
   @Test
-  public void heapifyUnionFromCompact() {
+  public void initializeUnionFromCompactSegment() {
     final UpdateDoublesSketch s1 = DoublesSketch.builder().build();
     s1.update(1);
     s1.update(2);
@@ -219,6 +217,19 @@ public void heapifyUnionFromCompact() {
     Assert.assertEquals(s2.getMaxItem(), 3.0);
   }
 
+  @Test
+  public void unionFromUpdatableSegment() {
+    final UpdateDoublesSketch s1 = DoublesSketch.builder().build();
+    s1.update(1);
+    s1.update(2);
+    final MemorySegment seg = MemorySegment.ofArray(s1.toByteArray(false));
+    final DoublesUnion u = DoublesUnion.wrap(seg);
+    u.update(3);
+    final DoublesSketch s2 = u.getResult();
+    Assert.assertEquals(s2.getMinItem(), 1.0);
+    Assert.assertEquals(s2.getMaxItem(), 3.0);
+  }
+
   @Test
   public void wrapUnionFromHeap() {
     final UpdateDoublesSketch s1 = DoublesSketch.builder().build();
@@ -239,7 +250,7 @@ public void wrapUnionFromCompact() {
     s1.update(1);
     s1.update(2);
     final MemorySegment seg = MemorySegment.ofArray(s1.toByteArray(true));
-    DoublesUnion.wrap(seg, null); //not from compact
+    DoublesUnion.wrap(seg, null); //compact seg
     fail();
   }
 

src/test/java/org/apache/datasketches/quantiles/DoublesSketchTest.java

@@ -43,7 +43,7 @@ public void heapToDirect() {
     for (int i = 0; i < 1000; i++) {
       heapSketch.update(i);
     }
-    final DoublesSketch directSketch = DoublesSketch.wrap(MemorySegment.ofArray(heapSketch.toByteArray(false)), null);
+    final DoublesSketch directSketch = DoublesSketch.writableWrap(MemorySegment.ofArray(heapSketch.toByteArray(false)), null);
 
     assertEquals(directSketch.getMinItem(), 0.0);
     assertEquals(directSketch.getMaxItem(), 999.0);