Improve javadoc wording

add simplified factory constructors to three public classes in classic
Quantiles for "wrap".

Author: leerho

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

@@ -154,6 +154,19 @@ public static DoublesSketch heapify(final MemorySegment srcSeg) {
    * Wrap this sketch around the given updatable MemorySegment image of a DoublesSketch, compact or updatable.
    *
    * @param srcSeg the given MemorySegment image of a DoublesSketch that may have data
+   * @return a sketch that wraps the given srcSeg in read-only mode.
+   */
+  public static DoublesSketch wrap(final MemorySegment srcSeg) {
+    if (checkIsMemorySegmentCompact(srcSeg)) {
+      return DirectCompactDoublesSketch.wrapInstance(srcSeg);
+    }
+    return DirectUpdateDoublesSketch.wrapInstance(srcSeg, null);
+  }
+
+  /**
+   * Wrap this sketch around the given updatable MemorySegment image of a DoublesSketch, compact or updatable.
+   *
+   * @param srcSeg the given MemorySegment image of a DoublesSketch that may have data.
    * @param mSegReq the MemorySegmentRequest used if the given MemorySegment needs to expand.
    * Otherwise, it can be null and the default MemorySegmentRequest will be used.
    * @return a sketch that wraps the given srcSeg in read-only mode.

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

@@ -60,15 +60,24 @@ public static DoublesUnion heapify(final MemorySegment srcSeg) {
   }
 
   /**
-   * Returns an updatable Union object that wraps the given MemorySegment that contains an image of a sketch.
-   * The data structures of the Union remain in the MemorySegment.
+   * Returns an updatable Union object that wraps the given MemorySegment that contains an image of a DoublesSketch.
    *
-   * @param srcSeg A MemorySegment to be used as the data structure for the sketch and will be modified.
+   * @param srcSeg A MemorySegment image of an updatable DoublesSketch to be used as the data structure for the union and will be modified.
+   * @return a Union object
+   */
+  public static DoublesUnion wrap(final MemorySegment srcSeg) {
+    return DoublesUnionImpl.wrapInstance(srcSeg, null);
+  }
+
+  /**
+   * Returns an updatable Union object that wraps the given MemorySegment that contains an image of a DoublesSketch.
+   *
+   * @param srcSeg A MemorySegment sketch 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.
    * Otherwise, it can be null and the default MemorySegmentRequest will be used.
    * @return a Union object
    */
-  public static DoublesUnion writableWrap(final MemorySegment srcSeg, final MemorySegmentRequest mSegReq) {
+  public static DoublesUnion wrap(final MemorySegment srcSeg, final MemorySegmentRequest mSegReq) {
     return DoublesUnionImpl.wrapInstance(srcSeg, mSegReq);
   }
 

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

@@ -114,7 +114,7 @@ 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.
    *
-   * @param srcSeg A writable MemorySegment image of a updatable DoublesSketch to be used as data for the union.
+   * @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.
    * Otherwise, it can be null and the default MemorySegmentRequest will be used.
    * @return a Union object

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

@@ -33,6 +33,16 @@ public abstract class UpdateDoublesSketch extends DoublesSketch {
     super(k);
   }
 
+  /**
+   * Wrap this sketch around the given MemorySegment image of an UpdateDoublesSketch.
+   *
+   * @param srcSeg the given MemorySegment image of an UpdateDoublesSketch and must not be null.
+   * @return a sketch that wraps the given srcSeg
+   */
+  public static UpdateDoublesSketch wrap(final MemorySegment srcSeg) {
+    return DirectUpdateDoublesSketch.wrapInstance(srcSeg, null);
+  }
+
   /**
    * Wrap this sketch around the given MemorySegment image of an UpdateDoublesSketch.
    *

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

@@ -226,7 +226,7 @@ public void wrapUnionFromHeap() {
     s1.update(2);
     final MemorySegment seg = MemorySegment.ofArray(s1.toByteArray(false)).asReadOnly();
     try {
-      final DoublesUnion u = DoublesUnion.writableWrap(seg, null);
+      final DoublesUnion u = DoublesUnion.wrap(seg, null);
     } catch (final SketchesReadOnlyException e) {
       //expected
     }
@@ -239,7 +239,7 @@ public void wrapUnionFromCompact() {
     s1.update(1);
     s1.update(2);
     final MemorySegment seg = MemorySegment.ofArray(s1.toByteArray(true));
-    DoublesUnion.writableWrap(seg, null); //not from compact
+    DoublesUnion.wrap(seg, null); //not from compact
     fail();
   }
 

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

@@ -685,7 +685,7 @@ public void checkWrapInstance() {
 
     final byte[] byteArr = sketch.toByteArray(false);
     final MemorySegment seg = MemorySegment.ofArray(byteArr);
-    final DoublesUnion union = DoublesUnion.writableWrap(seg, null);
+    final DoublesUnion union = DoublesUnion.wrap(seg, null);
     Assert.assertFalse(union.isEmpty());
     assertTrue(union.hasMemorySegment());
     assertFalse(union.isOffHeap());