Deploying to gh-pages from @ b16605c 🚀

Author: leerho

docs/main/index-all.html

@@ -8416,9 +8416,13 @@ <h2 class="title" id="I:W">W</h2>
 <div class="block">Returns a single weight from the samples contained in the sketch.</div>
 </dd>
 <dt><a href="org/apache/datasketches/theta/CompactSketch.html#wrap(byte%5B%5D)" class="member-name-link">wrap(byte[])</a> - Static method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a></dt>
-<dd>&nbsp;</dd>
+<dd>
+<div class="block">Wrap takes the sketch image in the given Memory and refers to it directly.</div>
+</dd>
 <dt><a href="org/apache/datasketches/theta/CompactSketch.html#wrap(byte%5B%5D,long)" class="member-name-link">wrap(byte[], long)</a> - Static method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a></dt>
-<dd>&nbsp;</dd>
+<dd>
+<div class="block">Wrap takes the sketch image in the given Memory and refers to it directly.</div>
+</dd>
 <dt><a href="org/apache/datasketches/filters/bloomfilter/BloomFilter.html#wrap(org.apache.datasketches.memory.Memory)" class="member-name-link">wrap(Memory)</a> - Static method in class org.apache.datasketches.filters.bloomfilter.<a href="org/apache/datasketches/filters/bloomfilter/BloomFilter.html" title="class in org.apache.datasketches.filters.bloomfilter">BloomFilter</a></dt>
 <dd>
 <div class="block">Wraps the given Memory into this filter class.</div>

docs/main/org/apache/datasketches/theta/CompactSketch.html

@@ -184,11 +184,15 @@ <h2>Method Summary</h2>
 </div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a></code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#wrap(byte%5B%5D)" class="member-name-link">wrap</a><wbr>(byte[]&nbsp;bytes)</code></div>
-<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">&nbsp;</div>
+<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
+<div class="block">Wrap takes the sketch image in the given Memory and refers to it directly.</div>
+</div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a></code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#wrap(byte%5B%5D,long)" class="member-name-link">wrap</a><wbr>(byte[]&nbsp;bytes,
  long&nbsp;expectedSeed)</code></div>
-<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">&nbsp;</div>
+<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
+<div class="block">Wrap takes the sketch image in the given Memory and refers to it directly.</div>
+</div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a></code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#wrap(org.apache.datasketches.memory.Memory)" class="member-name-link">wrap</a><wbr>(org.apache.datasketches.memory.Memory&nbsp;srcMem)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
@@ -348,13 +352,61 @@ <h3>wrap</h3>
 <section class="detail" id="wrap(byte[])">
 <h3>wrap</h3>
 <div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a></span>&nbsp;<span class="element-name">wrap</span><wbr><span class="parameters">(byte[]&nbsp;bytes)</span></div>
+<div class="block">Wrap takes the sketch image in the given Memory and refers to it directly.
+ There is no data copying onto the java heap.
+ The wrap operation enables fast read-only merging and access to all the public read-only API.
+
+ <p>Only "Direct" Serialization Version 3 (i.e, OpenSource) sketches that have
+ been explicitly stored as direct sketches can be wrapped.
+ Wrapping earlier serial version sketches will result in a heapify operation.
+ These early versions were never designed to "wrap".</p>
+
+ <p>Wrapping any subclass of this class that is empty or contains only a single item will
+ result in heapified forms of empty and single item sketch respectively.
+ This is actually faster and consumes less overall memory.</p>
+
+ <p>This method checks if the DEFAULT_UPDATE_SEED was used to create the source Memory image.
+ Note that SerialVersion 1 sketches cannot be checked as they don't have a seedHash field,
+ so the resulting heapified CompactSketch will be given the hash of DEFAULT_UPDATE_SEED.</p></div>
+<dl class="notes">
+<dt>Parameters:</dt>
+<dd><code>bytes</code> - a byte array image of a Sketch that was created using the DEFAULT_UPDATE_SEED.
+ <a href="../../../../resources/dictionary.html#mem">See Memory</a></dd>
+<dt>Returns:</dt>
+<dd>a CompactSketch backed by the given Memory except as above.</dd>
+</dl>
 </section>
 </li>
 <li>
 <section class="detail" id="wrap(byte[],long)">
 <h3>wrap</h3>
 <div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a></span>&nbsp;<span class="element-name">wrap</span><wbr><span class="parameters">(byte[]&nbsp;bytes,
  long&nbsp;expectedSeed)</span></div>
+<div class="block">Wrap takes the sketch image in the given Memory and refers to it directly.
+ There is no data copying onto the java heap.
+ The wrap operation enables fast read-only merging and access to all the public read-only API.
+
+ <p>Only "Direct" Serialization Version 3 (i.e, OpenSource) sketches that have
+ been explicitly stored as direct sketches can be wrapped.
+ Wrapping earlier serial version sketches will result in a heapify operation.
+ These early versions were never designed to "wrap".</p>
+
+ <p>Wrapping any subclass of this class that is empty or contains only a single item will
+ result in heapified forms of empty and single item sketch respectively.
+ This is actually faster and consumes less overall memory.</p>
+
+ <p>This method checks if the given expectedSeed was used to create the source Memory image.
+ Note that SerialVersion 1 sketches cannot be checked as they don't have a seedHash field,
+ so the resulting heapified CompactSketch will be given the hash of the expectedSeed.</p></div>
+<dl class="notes">
+<dt>Parameters:</dt>
+<dd><code>bytes</code> - a byte array image of a Sketch that was created using the given expectedSeed.
+ <a href="../../../../resources/dictionary.html#mem">See Memory</a></dd>
+<dd><code>expectedSeed</code> - the seed used to validate the given Memory image.
+ <a href="../../../../resources/dictionary.html#seed">See Update Hash Seed</a>.</dd>
+<dt>Returns:</dt>
+<dd>a CompactSketch backed by the given Memory except as above.</dd>
+</dl>
 </section>
 </li>
 <li>

docs/main/org/apache/datasketches/theta/class-use/CompactSketch.html

@@ -198,11 +198,15 @@ <h2>Uses of <a href="../CompactSketch.html" title="class in org.apache.datasketc
 </div>
 <div class="col-first even-row-color"><code>static <a href="../CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a></code></div>
 <div class="col-second even-row-color"><span class="type-name-label">CompactSketch.</span><code><a href="../CompactSketch.html#wrap(byte%5B%5D)" class="member-name-link">wrap</a><wbr>(byte[]&nbsp;bytes)</code></div>
-<div class="col-last even-row-color">&nbsp;</div>
+<div class="col-last even-row-color">
+<div class="block">Wrap takes the sketch image in the given Memory and refers to it directly.</div>
+</div>
 <div class="col-first odd-row-color"><code>static <a href="../CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a></code></div>
 <div class="col-second odd-row-color"><span class="type-name-label">CompactSketch.</span><code><a href="../CompactSketch.html#wrap(byte%5B%5D,long)" class="member-name-link">wrap</a><wbr>(byte[]&nbsp;bytes,
  long&nbsp;expectedSeed)</code></div>
-<div class="col-last odd-row-color">&nbsp;</div>
+<div class="col-last odd-row-color">
+<div class="block">Wrap takes the sketch image in the given Memory and refers to it directly.</div>
+</div>
 <div class="col-first even-row-color"><code>static <a href="../CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a></code></div>
 <div class="col-second even-row-color"><span class="type-name-label">CompactSketch.</span><code><a href="../CompactSketch.html#wrap(org.apache.datasketches.memory.Memory)" class="member-name-link">wrap</a><wbr>(org.apache.datasketches.memory.Memory&nbsp;srcMem)</code></div>
 <div class="col-last even-row-color">