Google Git
Sign in
apache / datasketches-website / d5f29b3e6de7df659f65c31ea2ce341dcaf8b675 / . / api / java / snapshot / apidocs / org / apache / datasketches / tuple / Sketch.html
blob: fcd9d474361a488998714f4043e05dc2f1079888 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>Sketch (datasketches-java 4.0.0 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
<script type="text/javascript" src="../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../jquery/jquery-3.6.0.min.js"></script>
<script type="text/javascript" src="../../../../jquery/jquery-ui.min.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Sketch (datasketches-java 4.0.0 API)";
}
}
catch(err) {
}
//-->
var data = {"i0":6,"i1":6,"i2":10,"i3":10,"i4":10,"i5":10,"i6":6,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":6,"i15":6,"i16":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/Sketch.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.apache.datasketches.tuple</a></div>
<h2 title="Class Sketch" class="title">Class Sketch&lt;S extends <a href="Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>&gt;</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>org.apache.datasketches.tuple.Sketch&lt;S&gt;</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>S</code> - Type of Summary</dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><code><a href="CompactSketch.html" title="class in org.apache.datasketches.tuple">CompactSketch</a></code>, <code><a href="UpdatableSketch.html" title="class in org.apache.datasketches.tuple">UpdatableSketch</a></code></dd>
</dl>
<hr>
<pre>public abstract class <span class="typeNameLabel">Sketch&lt;S extends <a href="Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>&gt;</span>
extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></pre>
<div class="block">This is an equivalent to org.apache.datasketches.theta.Sketch with
addition of a user-defined Summary object associated with every unique entry
in the sketch.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Field</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected static byte</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#PREAMBLE_LONGS">PREAMBLE_LONGS</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <a href="SummaryFactory.html" title="interface in org.apache.datasketches.tuple">SummaryFactory</a>&lt;<a href="Sketch.html" title="type parameter in Sketch">S</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#summaryFactory_">summaryFactory_</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ========== METHOD SUMMARY =========== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>abstract <a href="CompactSketch.html" title="class in org.apache.datasketches.tuple">CompactSketch</a>&lt;<a href="Sketch.html" title="type parameter in Sketch">S</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#compact()">compact</a></span>()</code></th>
<td class="colLast">
<div class="block">Converts this sketch to a CompactSketch on the Java heap.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>abstract int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCountLessThanThetaLong(long)">getCountLessThanThetaLong</a></span>&#8203;(long&nbsp;thetaLong)</code></th>
<td class="colLast">
<div class="block">Gets the number of hash values less than the given theta expressed as a long.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>double</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getEstimate()">getEstimate</a></span>()</code></th>
<td class="colLast">
<div class="block">Estimates the cardinality of the set (number of unique values presented to the sketch)</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>double</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getEstimate(int)">getEstimate</a></span>&#8203;(int&nbsp;numSubsetEntries)</code></th>
<td class="colLast">
<div class="block">Gets the estimate of the true distinct population of subset tuples represented by the count
of entries in a subset of the total retained entries of the sketch.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>double</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLowerBound(int)">getLowerBound</a></span>&#8203;(int&nbsp;numStdDev)</code></th>
<td class="colLast">
<div class="block">Gets the approximate lower error bound given the specified number of Standard Deviations.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>double</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLowerBound(int,int)">getLowerBound</a></span>&#8203;(int&nbsp;numStdDev,
int&nbsp;numSubsetEntries)</code></th>
<td class="colLast">
<div class="block">Gets the estimate of the lower bound of the true distinct population represented by the count
of entries in a subset of the total retained entries of the sketch.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>abstract int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRetainedEntries()">getRetainedEntries</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="SummaryFactory.html" title="interface in org.apache.datasketches.tuple">SummaryFactory</a>&lt;<a href="Sketch.html" title="type parameter in Sketch">S</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSummaryFactory()">getSummaryFactory</a></span>()</code></th>
<td class="colLast">
<div class="block">Gets the Summary Factory class of type S</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>double</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getTheta()">getTheta</a></span>()</code></th>
<td class="colLast">
<div class="block">Gets the value of theta as a double between zero and one</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getThetaLong()">getThetaLong</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns Theta as a long</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>double</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getUpperBound(int)">getUpperBound</a></span>&#8203;(int&nbsp;numStdDev)</code></th>
<td class="colLast">
<div class="block">Gets the approximate upper error bound given the specified number of Standard Deviations.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>double</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getUpperBound(int,int)">getUpperBound</a></span>&#8203;(int&nbsp;numStdDev,
int&nbsp;numSubsetEntries)</code></th>
<td class="colLast">
<div class="block">Gets the estimate of the upper bound of the true distinct population represented by the count
of entries in a subset of the total retained entries of the sketch.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isEmpty()">isEmpty</a></span>()</code></th>
<td class="colLast">
<div class="block"><a href="../../../../resources/dictionary.html#empty">See Empty</a></div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isEstimationMode()">isEstimationMode</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns true if the sketch is Estimation Mode (as opposed to Exact Mode).</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>abstract <a href="TupleSketchIterator.html" title="class in org.apache.datasketches.tuple">TupleSketchIterator</a>&lt;<a href="Sketch.html" title="type parameter in Sketch">S</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#iterator()">iterator</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns a SketchIterator</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>abstract byte[]</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toByteArray()">toByteArray</a></span>()</code></th>
<td class="colLast">
<div class="block">This is to serialize a sketch instance to a byte array.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toString()">toString</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang" class="externalLink">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang" class="externalLink">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang" class="externalLink">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang" class="externalLink">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang" class="externalLink">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang" class="externalLink">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang" class="externalLink">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait(long,int)" title="class or interface in java.lang" class="externalLink">wait</a></code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a id="PREAMBLE_LONGS">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>PREAMBLE_LONGS</h4>
<pre>protected static final&nbsp;byte PREAMBLE_LONGS</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.apache.datasketches.tuple.Sketch.PREAMBLE_LONGS">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="summaryFactory_">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>summaryFactory_</h4>
<pre>protected&nbsp;<a href="SummaryFactory.html" title="interface in org.apache.datasketches.tuple">SummaryFactory</a>&lt;<a href="Sketch.html" title="type parameter in Sketch">S</a> extends <a href="Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>&gt; summaryFactory_</pre>
</li>
</ul>
</li>
</ul>
</section>
<!-- ============ METHOD DETAIL ========== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="compact()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>compact</h4>
<pre class="methodSignature">public abstract&nbsp;<a href="CompactSketch.html" title="class in org.apache.datasketches.tuple">CompactSketch</a>&lt;<a href="Sketch.html" title="type parameter in Sketch">S</a>&gt;&nbsp;compact()</pre>
<div class="block">Converts this sketch to a CompactSketch on the Java heap.
<p>If this sketch is already in compact form this operation returns <i>this</i>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this sketch as a CompactSketch on the Java heap.</dd>
</dl>
</li>
</ul>
<a id="getEstimate()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEstimate</h4>
<pre class="methodSignature">public&nbsp;double&nbsp;getEstimate()</pre>
<div class="block">Estimates the cardinality of the set (number of unique values presented to the sketch)</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>best estimate of the number of unique values</dd>
</dl>
</li>
</ul>
<a id="getUpperBound(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getUpperBound</h4>
<pre class="methodSignature">public&nbsp;double&nbsp;getUpperBound&#8203;(int&nbsp;numStdDev)</pre>
<div class="block">Gets the approximate upper error bound given the specified number of Standard Deviations.
This will return getEstimate() if isEmpty() is true.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>numStdDev</code> - <a href="../../../../resources/dictionary.html#numStdDev">See Number of Standard Deviations</a></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the upper bound.</dd>
</dl>
</li>
</ul>
<a id="getLowerBound(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLowerBound</h4>
<pre class="methodSignature">public&nbsp;double&nbsp;getLowerBound&#8203;(int&nbsp;numStdDev)</pre>
<div class="block">Gets the approximate lower error bound given the specified number of Standard Deviations.
This will return getEstimate() if isEmpty() is true.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>numStdDev</code> - <a href="../../../../resources/dictionary.html#numStdDev">See Number of Standard Deviations</a></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the lower bound.</dd>
</dl>
</li>
</ul>
<a id="getEstimate(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEstimate</h4>
<pre class="methodSignature">public&nbsp;double&nbsp;getEstimate&#8203;(int&nbsp;numSubsetEntries)</pre>
<div class="block">Gets the estimate of the true distinct population of subset tuples represented by the count
of entries in a subset of the total retained entries of the sketch.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>numSubsetEntries</code> - number of entries for a chosen subset of the sketch.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the estimate of the true distinct population of subset tuples represented by the count
of entries in a subset of the total retained entries of the sketch.</dd>
</dl>
</li>
</ul>
<a id="getLowerBound(int,int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLowerBound</h4>
<pre class="methodSignature">public&nbsp;double&nbsp;getLowerBound&#8203;(int&nbsp;numStdDev,
int&nbsp;numSubsetEntries)</pre>
<div class="block">Gets the estimate of the lower bound of the true distinct population represented by the count
of entries in a subset of the total retained entries of the sketch.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>numStdDev</code> - <a href="../../../../resources/dictionary.html#numStdDev">See Number of Standard Deviations</a></dd>
<dd><code>numSubsetEntries</code> - number of entries for a chosen subset of the sketch.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the estimate of the lower bound of the true distinct population represented by the count
of entries in a subset of the total retained entries of the sketch.</dd>
</dl>
</li>
</ul>
<a id="getUpperBound(int,int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getUpperBound</h4>
<pre class="methodSignature">public&nbsp;double&nbsp;getUpperBound&#8203;(int&nbsp;numStdDev,
int&nbsp;numSubsetEntries)</pre>
<div class="block">Gets the estimate of the upper bound of the true distinct population represented by the count
of entries in a subset of the total retained entries of the sketch.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>numStdDev</code> - <a href="../../../../resources/dictionary.html#numStdDev">See Number of Standard Deviations</a></dd>
<dd><code>numSubsetEntries</code> - number of entries for a chosen subset of the sketch.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the estimate of the upper bound of the true distinct population represented by the count
of entries in a subset of the total retained entries of the sketch.</dd>
</dl>
</li>
</ul>
<a id="isEmpty()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isEmpty</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isEmpty()</pre>
<div class="block"><a href="../../../../resources/dictionary.html#empty">See Empty</a></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if empty.</dd>
</dl>
</li>
</ul>
<a id="isEstimationMode()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isEstimationMode</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isEstimationMode()</pre>
<div class="block">Returns true if the sketch is Estimation Mode (as opposed to Exact Mode).
This is true if theta &lt; 1.0 AND isEmpty() is false.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if the sketch is in estimation mode.</dd>
</dl>
</li>
</ul>
<a id="getRetainedEntries()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRetainedEntries</h4>
<pre class="methodSignature">public abstract&nbsp;int&nbsp;getRetainedEntries()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>number of retained entries</dd>
</dl>
</li>
</ul>
<a id="getCountLessThanThetaLong(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCountLessThanThetaLong</h4>
<pre class="methodSignature">public abstract&nbsp;int&nbsp;getCountLessThanThetaLong&#8203;(long&nbsp;thetaLong)</pre>
<div class="block">Gets the number of hash values less than the given theta expressed as a long.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>thetaLong</code> - the given theta as a long between zero and <i>Long.MAX_VALUE</i>.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of hash values less than the given thetaLong.</dd>
</dl>
</li>
</ul>
<a id="getSummaryFactory()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSummaryFactory</h4>
<pre class="methodSignature">public&nbsp;<a href="SummaryFactory.html" title="interface in org.apache.datasketches.tuple">SummaryFactory</a>&lt;<a href="Sketch.html" title="type parameter in Sketch">S</a>&gt;&nbsp;getSummaryFactory()</pre>
<div class="block">Gets the Summary Factory class of type S</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the Summary Factory class of type S</dd>
</dl>
</li>
</ul>
<a id="getTheta()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTheta</h4>
<pre class="methodSignature">public&nbsp;double&nbsp;getTheta()</pre>
<div class="block">Gets the value of theta as a double between zero and one</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the value of theta as a double</dd>
</dl>
</li>
</ul>
<a id="toByteArray()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toByteArray</h4>
<pre class="methodSignature">public abstract&nbsp;byte[]&nbsp;toByteArray()</pre>
<div class="block">This is to serialize a sketch instance to a byte array.
<p>As of 3.0.0, serializing an UpdatableSketch is deprecated.
This capability will be removed in a future release.
Serializing a CompactSketch is not deprecated.</p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>serialized representation of the sketch</dd>
</dl>
</li>
</ul>
<a id="iterator()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>iterator</h4>
<pre class="methodSignature">public abstract&nbsp;<a href="TupleSketchIterator.html" title="class in org.apache.datasketches.tuple">TupleSketchIterator</a>&lt;<a href="Sketch.html" title="type parameter in Sketch">S</a>&gt;&nbsp;iterator()</pre>
<div class="block">Returns a SketchIterator</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a SketchIterator</dd>
</dl>
</li>
</ul>
<a id="getThetaLong()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getThetaLong</h4>
<pre class="methodSignature">public&nbsp;long&nbsp;getThetaLong()</pre>
<div class="block">Returns Theta as a long</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Theta as a long</dd>
</dl>
</li>
</ul>
<a id="toString()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toString</h4>
<pre class="methodSignature">public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;toString()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang" class="externalLink">toString</a></code>&nbsp;in class&nbsp;<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></code></dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/Sketch.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Copyright &#169; 2015&#x2013;2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</body>
</html>