This is an automated email from the ASF dual-hosted git repository.
github-bot pushed a commit to branch gh-pages
in repository https://gitbox.apache.org/repos/asf/datasketches-java.git
The following commit(s) were added to refs/heads/gh-pages by this push:
new 1ce8e1f8 Deploying to gh-pages from @
apache/datasketches-java@b16605caf35df0a7ba85ba8e3ccb61695a8f76f9 🚀
1ce8e1f8 is described below
commit 1ce8e1f8af4f82f3bbd075262e90753b6576ce9e
Author: leerho <[email protected]>
AuthorDate: Tue Feb 25 22:10:55 2025 +0000
Deploying to gh-pages from @
apache/datasketches-java@b16605caf35df0a7ba85ba8e3ccb61695a8f76f9 🚀
---
docs/main/index-all.html | 8 +++-
.../apache/datasketches/theta/CompactSketch.html | 56 +++++++++++++++++++++-
.../theta/class-use/CompactSketch.html | 8 +++-
3 files changed, 66 insertions(+), 6 deletions(-)
diff --git a/docs/main/index-all.html b/docs/main/index-all.html
index a51eaeac..aeb4084d 100644
--- a/docs/main/index-all.html
+++ b/docs/main/index-all.html
@@ -8416,9 +8416,13 @@ the order they are declared.</div>
<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> </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> </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>
diff --git a/docs/main/org/apache/datasketches/theta/CompactSketch.html
b/docs/main/org/apache/datasketches/theta/CompactSketch.html
index d5ae7a4c..078974c6 100644
--- a/docs/main/org/apache/datasketches/theta/CompactSketch.html
+++ b/docs/main/org/apache/datasketches/theta/CompactSketch.html
@@ -184,11 +184,15 @@ loadScripts(document, 'script');</script>
</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[] bytes)</code></div>
-<div class="col-last even-row-color method-summary-table
method-summary-table-tab1 method-summary-table-tab4"> </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[] bytes,
long expectedSeed)</code></div>
-<div class="col-last odd-row-color method-summary-table
method-summary-table-tab1 method-summary-table-tab4"> </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 srcMem)</code></div>
<div class="col-last even-row-color method-summary-table
method-summary-table-tab1 method-summary-table-tab4">
@@ -348,6 +352,29 @@ loadScripts(document, 'script');</script>
<section class="detail" id="wrap(byte[])">
<h3>wrap</h3>
<div class="member-signature"><span class="modifiers">public
static</span> <span class="return-type"><a href="CompactSketch.html"
title="class in
org.apache.datasketches.theta">CompactSketch</a></span> <span
class="element-name">wrap</span><wbr><span
class="parameters">(byte[] 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>
@@ -355,6 +382,31 @@ loadScripts(document, 'script');</script>
<h3>wrap</h3>
<div class="member-signature"><span class="modifiers">public
static</span> <span class="return-type"><a href="CompactSketch.html"
title="class in
org.apache.datasketches.theta">CompactSketch</a></span> <span
class="element-name">wrap</span><wbr><span
class="parameters">(byte[] bytes,
long 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>
diff --git
a/docs/main/org/apache/datasketches/theta/class-use/CompactSketch.html
b/docs/main/org/apache/datasketches/theta/class-use/CompactSketch.html
index 5741c05f..a81a4385 100644
--- a/docs/main/org/apache/datasketches/theta/class-use/CompactSketch.html
+++ b/docs/main/org/apache/datasketches/theta/class-use/CompactSketch.html
@@ -198,11 +198,15 @@ loadScripts(document, 'script');</script>
</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[] bytes)</code></div>
-<div class="col-last even-row-color"> </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[] bytes,
long expectedSeed)</code></div>
-<div class="col-last odd-row-color"> </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 srcMem)</code></div>
<div class="col-last even-row-color">
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
