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 b17ff090 Deploying to gh-pages from @
apache/datasketches-java@2dd1d5e62701f439bebe4e51863e14e5a29a2f2f 🚀
b17ff090 is described below
commit b17ff090044adbc96a6859bc161f4b9be2b238db
Author: AlexanderSaydakov <[email protected]>
AuthorDate: Mon Feb 3 19:26:00 2025 +0000
Deploying to gh-pages from @
apache/datasketches-java@2dd1d5e62701f439bebe4e51863e14e5a29a2f2f 🚀
---
docs/main/index-all.html | 2 +
docs/main/member-search-index.js | 2 +-
.../apache/datasketches/theta/CompactSketch.html | 61 ++++++++++++++--------
3 files changed, 43 insertions(+), 22 deletions(-)
diff --git a/docs/main/index-all.html b/docs/main/index-all.html
index 1b466f1a..3484eb14 100644
--- a/docs/main/index-all.html
+++ b/docs/main/index-all.html
@@ -1977,6 +1977,8 @@ loadScripts(document, 'script');</script>
<dd> </dd>
<dt><a
href="org/apache/datasketches/sampling/SampleSubsetSummary.html#getEstimate()"
class="member-name-link">getEstimate()</a> - Method in class
org.apache.datasketches.sampling.<a
href="org/apache/datasketches/sampling/SampleSubsetSummary.html" title="class
in org.apache.datasketches.sampling">SampleSubsetSummary</a></dt>
<dd> </dd>
+<dt><a href="org/apache/datasketches/theta/CompactSketch.html#getEstimate()"
class="member-name-link">getEstimate()</a> - 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>
<dt><a href="org/apache/datasketches/theta/Sketch.html#getEstimate()"
class="member-name-link">getEstimate()</a> - Method in class
org.apache.datasketches.theta.<a
href="org/apache/datasketches/theta/Sketch.html" title="class in
org.apache.datasketches.theta">Sketch</a></dt>
<dd>
<div class="block">Gets the unique count estimate.</div>
diff --git a/docs/main/member-search-index.js b/docs/main/member-search-index.js
index bc970de8..165e21f7 100644
--- a/docs/main/member-search-index.js
+++ b/docs/main/member-search-index.js
@@ -1 +1 @@
-memberSearchIndex =
[{"p":"org.apache.datasketches.common","c":"Family","l":"A_NOT_B"},{"p":"org.apache.datasketches.common","c":"Family","l":"ALPHA"},{"p":"org.apache.datasketches.tuple.adouble","c":"DoubleSummary.Mode","l":"AlwaysOne"},{"p":"org.apache.datasketches.tuple.aninteger","c":"IntegerSummary.Mode","l":"AlwaysOne"},{"p":"org.apache.datasketches.theta","c":"AnotB","l":"AnotB()","u":"%3Cinit%3E()"},{"p":"org.apache.datasketches.tuple","c":"AnotB","l":"AnotB()","u":"%3Cinit%3E()"
[...]
\ No newline at end of file
+memberSearchIndex =
[{"p":"org.apache.datasketches.common","c":"Family","l":"A_NOT_B"},{"p":"org.apache.datasketches.common","c":"Family","l":"ALPHA"},{"p":"org.apache.datasketches.tuple.adouble","c":"DoubleSummary.Mode","l":"AlwaysOne"},{"p":"org.apache.datasketches.tuple.aninteger","c":"IntegerSummary.Mode","l":"AlwaysOne"},{"p":"org.apache.datasketches.theta","c":"AnotB","l":"AnotB()","u":"%3Cinit%3E()"},{"p":"org.apache.datasketches.tuple","c":"AnotB","l":"AnotB()","u":"%3Cinit%3E()"
[...]
\ No newline at end of file
diff --git a/docs/main/org/apache/datasketches/theta/CompactSketch.html
b/docs/main/org/apache/datasketches/theta/CompactSketch.html
index 4eba8551..e94ba6c3 100644
--- a/docs/main/org/apache/datasketches/theta/CompactSketch.html
+++ b/docs/main/org/apache/datasketches/theta/CompactSketch.html
@@ -137,41 +137,46 @@ loadScripts(document, 'script');</script>
<div class="block">Returns the number of storage bytes required for this
Sketch if its current state were
compacted.</div>
</div>
-<div class="col-first even-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4"><code><a
href="../common/Family.html" title="enum class in
org.apache.datasketches.common">Family</a></code></div>
-<div class="col-second even-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4"><code><a
href="#getFamily()" class="member-name-link">getFamily</a>()</code></div>
+<div class="col-first even-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div>
+<div class="col-second even-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4"><code><a
href="#getEstimate()" class="member-name-link">getEstimate</a>()</code></div>
<div class="col-last even-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4">
+<div class="block">Gets the unique count estimate.</div>
+</div>
+<div class="col-first odd-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4"><code><a
href="../common/Family.html" title="enum class in
org.apache.datasketches.common">Family</a></code></div>
+<div class="col-second odd-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4"><code><a
href="#getFamily()" class="member-name-link">getFamily</a>()</code></div>
+<div class="col-last odd-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Returns the Family that this sketch belongs to</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="#heapify(org.apache.datasketches.memory.Memory)"
class="member-name-link">heapify</a><wbr>(org.apache.datasketches.memory.Memory srcMem)</code></div>
-<div class="col-last odd-row-color method-summary-table
method-summary-table-tab1 method-summary-table-tab4">
+<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="#heapify(org.apache.datasketches.memory.Memory)"
class="member-name-link">heapify</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">
<div class="block">Heapify takes a CompactSketch image in Memory and
instantiates an on-heap CompactSketch.</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="#heapify(org.apache.datasketches.memory.Memory,long)"
class="member-name-link">heapify</a><wbr>(org.apache.datasketches.memory.Memory srcMem,
+<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="#heapify(org.apache.datasketches.memory.Memory,long)"
class="member-name-link">heapify</a><wbr>(org.apache.datasketches.memory.Memory srcMem,
long expectedSeed)</code></div>
-<div class="col-last even-row-color method-summary-table
method-summary-table-tab1 method-summary-table-tab4">
+<div class="col-last odd-row-color method-summary-table
method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Heapify takes a CompactSketch image in Memory and
instantiates an on-heap CompactSketch.</div>
</div>
-<div class="col-first odd-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
-<div class="col-second odd-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4"><code><a
href="#isCompact()" class="member-name-link">isCompact</a>()</code></div>
-<div class="col-last odd-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4">
+<div class="col-first even-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
+<div class="col-second even-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4"><code><a
href="#isCompact()" class="member-name-link">isCompact</a>()</code></div>
+<div class="col-last even-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Returns true if this sketch is in compact form.</div>
</div>
-<div class="col-first even-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4"><code>byte[]</code></div>
-<div class="col-second even-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4"><code><a
href="#toByteArrayCompressed()"
class="member-name-link">toByteArrayCompressed</a>()</code></div>
-<div class="col-last even-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4">
+<div class="col-first odd-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4"><code>byte[]</code></div>
+<div class="col-second odd-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4"><code><a
href="#toByteArrayCompressed()"
class="member-name-link">toByteArrayCompressed</a>()</code></div>
+<div class="col-last odd-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4">
<div class="block">gets the sketch as a compressed byte array</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(org.apache.datasketches.memory.Memory)"
class="member-name-link">wrap</a><wbr>(org.apache.datasketches.memory.Memory srcMem)</code></div>
-<div class="col-last odd-row-color method-summary-table
method-summary-table-tab1 method-summary-table-tab4">
+<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">
<div class="block">Wrap takes the CompactSketch image in 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,long)"
class="member-name-link">wrap</a><wbr>(org.apache.datasketches.memory.Memory srcMem,
+<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(org.apache.datasketches.memory.Memory,long)"
class="member-name-link">wrap</a><wbr>(org.apache.datasketches.memory.Memory srcMem,
long expectedSeed)</code></div>
-<div class="col-last even-row-color method-summary-table
method-summary-table-tab1 method-summary-table-tab4">
+<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>
@@ -179,7 +184,7 @@ loadScripts(document, 'script');</script>
</div>
<div class="inherited-list">
<h3
id="methods-inherited-from-class-org.apache.datasketches.theta.Sketch">Methods
inherited from class org.apache.datasketches.theta.<a href="Sketch.html"
title="class in org.apache.datasketches.theta">Sketch</a></h3>
-<code><a href="Sketch.html#compact()">compact</a>, <a
href="Sketch.html#getCompactSketchMaxBytes(int)">getCompactSketchMaxBytes</a>,
<a
href="Sketch.html#getCountLessThanThetaLong(long)">getCountLessThanThetaLong</a>,
<a href="Sketch.html#getCurrentBytes()">getCurrentBytes</a>, <a
href="Sketch.html#getEstimate()">getEstimate</a>, <a
href="Sketch.html#getLowerBound(int)">getLowerBound</a>, <a
href="Sketch.html#getMaxCompactSketchBytes(int)">getMaxCompactSketchBytes</a>,
<a href="Sketch.ht [...]
+<code><a href="Sketch.html#compact()">compact</a>, <a
href="Sketch.html#getCompactSketchMaxBytes(int)">getCompactSketchMaxBytes</a>,
<a
href="Sketch.html#getCountLessThanThetaLong(long)">getCountLessThanThetaLong</a>,
<a href="Sketch.html#getCurrentBytes()">getCurrentBytes</a>, <a
href="Sketch.html#getLowerBound(int)">getLowerBound</a>, <a
href="Sketch.html#getMaxCompactSketchBytes(int)">getMaxCompactSketchBytes</a>,
<a href="Sketch.html#getMaxUpdateSketchBytes(int)">getMaxUpdateSketchBy [...]
<div class="inherited-list">
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from
class java.lang.<a
href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html";
title="class or interface in java.lang" class="external-link">Object</a></h3>
<code><a
href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)"
title="class or interface in java.lang" class="external-link">equals</a>, <a
href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()"
title="class or interface in java.lang" class="external-link">getClass</a>, <a
href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()"
title="cla [...]
@@ -402,6 +407,20 @@ loadScripts(document, 'script');</script>
</section>
</li>
<li>
+<section class="detail" id="getEstimate()">
+<h3>getEstimate</h3>
+<div class="member-signature"><span class="modifiers">public</span> <span
class="return-type">double</span> <span
class="element-name">getEstimate</span>()</div>
+<div class="block"><span class="descfrm-type-label">Description copied from
class: <code><a
href="Sketch.html#getEstimate()">Sketch</a></code></span></div>
+<div class="block">Gets the unique count estimate.</div>
+<dl class="notes">
+<dt>Specified by:</dt>
+<dd><code><a href="Sketch.html#getEstimate()">getEstimate</a></code> in
class <code><a href="Sketch.html" title="class in
org.apache.datasketches.theta">Sketch</a></code></dd>
+<dt>Returns:</dt>
+<dd>the sketch's best estimate of the cardinality of the input stream.</dd>
+</dl>
+</section>
+</li>
+<li>
<section class="detail" id="toByteArrayCompressed()">
<h3>toByteArrayCompressed</h3>
<div class="member-signature"><span class="modifiers">public</span> <span
class="return-type">byte[]</span> <span
class="element-name">toByteArrayCompressed</span>()</div>
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
