Google Git
Sign in
apache / datasketches / d3adc1a60d93e5399c063ea3ed5ef18960ddb98d / . / api / core / snapshot / apidocs / com / yahoo / sketches / theta / SingleItemSketch.html
blob: b235a238480f4f6a2a6e09851252648f7d545785 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_162) on Thu Mar 14 13:13:09 PDT 2019 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>SingleItemSketch (com.yahoo.datasketches:sketches-core 0.13.1-SNAPSHOT API)</title>
<meta name="date" content="2019-03-14">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="SingleItemSketch (com.yahoo.datasketches:sketches-core 0.13.1-SNAPSHOT API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9,"i5":9,"i6":9,"i7":9,"i8":9,"i9":9,"i10":9,"i11":9,"i12":9,"i13":9,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":9,"i23":9,"i24":10,"i25":10,"i26":10,"i27":10,"i28":10};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/SingleItemSketch.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">
<li><a href="../../../../com/yahoo/sketches/theta/SetOperationBuilder.html" title="class in com.yahoo.sketches.theta"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../com/yahoo/sketches/theta/Sketch.html" title="class in com.yahoo.sketches.theta"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/yahoo/sketches/theta/SingleItemSketch.html" target="_top">Frames</a></li>
<li><a href="SingleItemSketch.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></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>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&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>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">com.yahoo.sketches.theta</div>
<h2 title="Class SingleItemSketch" class="title">Class SingleItemSketch</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">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../com/yahoo/sketches/theta/Sketch.html" title="class in com.yahoo.sketches.theta">com.yahoo.sketches.theta.Sketch</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../com/yahoo/sketches/theta/CompactSketch.html" title="class in com.yahoo.sketches.theta">com.yahoo.sketches.theta.CompactSketch</a></li>
<li>
<ul class="inheritance">
<li>com.yahoo.sketches.theta.SingleItemSketch</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public final class <span class="typeNameLabel">SingleItemSketch</span>
extends <a href="../../../../com/yahoo/sketches/theta/CompactSketch.html" title="class in com.yahoo.sketches.theta">CompactSketch</a></pre>
<dl>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>Lee Rhodes</dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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="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="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>static <a href="../../../../com/yahoo/sketches/theta/SingleItemSketch.html" title="class in com.yahoo.sketches.theta">SingleItemSketch</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/yahoo/sketches/theta/SingleItemSketch.html#create-byte:A-">create</a></span>(byte[]&nbsp;data)</code>
<div class="block">Create this sketch with the given byte array.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static <a href="../../../../com/yahoo/sketches/theta/SingleItemSketch.html" title="class in com.yahoo.sketches.theta">SingleItemSketch</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/yahoo/sketches/theta/SingleItemSketch.html#create-byte:A-long-">create</a></span>(byte[]&nbsp;data,
long&nbsp;seed)</code>
<div class="block">Create this sketch with the given byte array and a seed.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>static <a href="../../../../com/yahoo/sketches/theta/SingleItemSketch.html" title="class in com.yahoo.sketches.theta">SingleItemSketch</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/yahoo/sketches/theta/SingleItemSketch.html#create-char:A-">create</a></span>(char[]&nbsp;data)</code>
<div class="block">Create this sketch with the given char array.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>static <a href="../../../../com/yahoo/sketches/theta/SingleItemSketch.html" title="class in com.yahoo.sketches.theta">SingleItemSketch</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/yahoo/sketches/theta/SingleItemSketch.html#create-char:A-long-">create</a></span>(char[]&nbsp;data,
long&nbsp;seed)</code>
<div class="block">Create this sketch with the given char array and a seed.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>static <a href="../../../../com/yahoo/sketches/theta/SingleItemSketch.html" title="class in com.yahoo.sketches.theta">SingleItemSketch</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/yahoo/sketches/theta/SingleItemSketch.html#create-double-">create</a></span>(double&nbsp;datum)</code>
<div class="block">Create this sketch with the given double (or float) datum.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>static <a href="../../../../com/yahoo/sketches/theta/SingleItemSketch.html" title="class in com.yahoo.sketches.theta">SingleItemSketch</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/yahoo/sketches/theta/SingleItemSketch.html#create-double-long-">create</a></span>(double&nbsp;datum,
long&nbsp;seed)</code>
<div class="block">Create this sketch with the given double (or float) datum and a seed.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>static <a href="../../../../com/yahoo/sketches/theta/SingleItemSketch.html" title="class in com.yahoo.sketches.theta">SingleItemSketch</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/yahoo/sketches/theta/SingleItemSketch.html#create-int:A-">create</a></span>(int[]&nbsp;data)</code>
<div class="block">Create this sketch with the given integer array.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>static <a href="../../../../com/yahoo/sketches/theta/SingleItemSketch.html" title="class in com.yahoo.sketches.theta">SingleItemSketch</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/yahoo/sketches/theta/SingleItemSketch.html#create-int:A-long-">create</a></span>(int[]&nbsp;data,
long&nbsp;seed)</code>
<div class="block">Create this sketch with the given integer array and a seed.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>static <a href="../../../../com/yahoo/sketches/theta/SingleItemSketch.html" title="class in com.yahoo.sketches.theta">SingleItemSketch</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/yahoo/sketches/theta/SingleItemSketch.html#create-long-">create</a></span>(long&nbsp;datum)</code>
<div class="block">Create this sketch with a long.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>static <a href="../../../../com/yahoo/sketches/theta/SingleItemSketch.html" title="class in com.yahoo.sketches.theta">SingleItemSketch</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/yahoo/sketches/theta/SingleItemSketch.html#create-long:A-">create</a></span>(long[]&nbsp;data)</code>
<div class="block">Create this sketch with the given long array.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>static <a href="../../../../com/yahoo/sketches/theta/SingleItemSketch.html" title="class in com.yahoo.sketches.theta">SingleItemSketch</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/yahoo/sketches/theta/SingleItemSketch.html#create-long:A-long-">create</a></span>(long[]&nbsp;data,
long&nbsp;seed)</code>
<div class="block">Create this sketch with the given long array and a seed.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>static <a href="../../../../com/yahoo/sketches/theta/SingleItemSketch.html" title="class in com.yahoo.sketches.theta">SingleItemSketch</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/yahoo/sketches/theta/SingleItemSketch.html#create-long-long-">create</a></span>(long&nbsp;datum,
long&nbsp;seed)</code>
<div class="block">Create this sketch with a long and a seed.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>static <a href="../../../../com/yahoo/sketches/theta/SingleItemSketch.html" title="class in com.yahoo.sketches.theta">SingleItemSketch</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/yahoo/sketches/theta/SingleItemSketch.html#create-java.lang.String-">create</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;datum)</code>
<div class="block">Create this sketch with the given String.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>static <a href="../../../../com/yahoo/sketches/theta/SingleItemSketch.html" title="class in com.yahoo.sketches.theta">SingleItemSketch</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/yahoo/sketches/theta/SingleItemSketch.html#create-java.lang.String-long-">create</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;datum,
long&nbsp;seed)</code>
<div class="block">Create this sketch with the given String and a seed.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/yahoo/sketches/theta/SingleItemSketch.html#getCountLessThanTheta-double-">getCountLessThanTheta</a></span>(double&nbsp;theta)</code>
<div class="block">Gets the number of hash values less than the given theta.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/yahoo/sketches/theta/SingleItemSketch.html#getCurrentBytes-boolean-">getCurrentBytes</a></span>(boolean&nbsp;compact)</code>
<div class="block">Returns the number of storage bytes required for this Sketch in its current state.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/yahoo/sketches/theta/SingleItemSketch.html#getEstimate--">getEstimate</a></span>()</code>
<div class="block">Gets the unique count estimate.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/yahoo/sketches/theta/SingleItemSketch.html#getLowerBound-int-">getLowerBound</a></span>(int&nbsp;numStdDev)</code>
<div class="block">Gets the approximate lower error bound given the specified number of Standard Deviations.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/yahoo/sketches/theta/SingleItemSketch.html#getRetainedEntries-boolean-">getRetainedEntries</a></span>(boolean&nbsp;valid)</code>
<div class="block">Returns the number of entries that have been retained by the sketch.</div>
</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/yahoo/sketches/theta/SingleItemSketch.html#getThetaLong--">getThetaLong</a></span>()</code>
<div class="block">Gets the value of theta as a long</div>
</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/yahoo/sketches/theta/SingleItemSketch.html#getUpperBound-int-">getUpperBound</a></span>(int&nbsp;numStdDev)</code>
<div class="block">Gets the approximate upper error bound given the specified number of Standard Deviations.</div>
</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/yahoo/sketches/theta/SingleItemSketch.html#hasMemory--">hasMemory</a></span>()</code>
<div class="block">Returns true if this sketch's data structure is backed by Memory or WritableMemory.</div>
</td>
</tr>
<tr id="i22" class="altColor">
<td class="colFirst"><code>static <a href="../../../../com/yahoo/sketches/theta/SingleItemSketch.html" title="class in com.yahoo.sketches.theta">SingleItemSketch</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/yahoo/sketches/theta/SingleItemSketch.html#heapify-com.yahoo.memory.Memory-">heapify</a></span>(com.yahoo.memory.Memory&nbsp;mem)</code>
<div class="block">Creates a SingleItemSketch on the heap given a Memory and assumes the DEFAULT_UPDATE_SEED.</div>
</td>
</tr>
<tr id="i23" class="rowColor">
<td class="colFirst"><code>static <a href="../../../../com/yahoo/sketches/theta/SingleItemSketch.html" title="class in com.yahoo.sketches.theta">SingleItemSketch</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/yahoo/sketches/theta/SingleItemSketch.html#heapify-com.yahoo.memory.Memory-long-">heapify</a></span>(com.yahoo.memory.Memory&nbsp;mem,
long&nbsp;seed)</code>
<div class="block">Creates a SingleItemSketch on the heap given a Memory.</div>
</td>
</tr>
<tr id="i24" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/yahoo/sketches/theta/SingleItemSketch.html#isDirect--">isDirect</a></span>()</code>
<div class="block">Returns true if the this sketch's internal data structure is backed by direct (off-heap)
Memory.</div>
</td>
</tr>
<tr id="i25" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/yahoo/sketches/theta/SingleItemSketch.html#isEmpty--">isEmpty</a></span>()</code>
<div class="block"><a href="../../../../resources/dictionary.html#empty">See Empty</a></div>
</td>
</tr>
<tr id="i26" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/yahoo/sketches/theta/SingleItemSketch.html#isOrdered--">isOrdered</a></span>()</code>
<div class="block">Returns true if internal cache is ordered</div>
</td>
</tr>
<tr id="i27" class="rowColor">
<td class="colFirst"><code><a href="../../../../com/yahoo/sketches/theta/HashIterator.html" title="interface in com.yahoo.sketches.theta">HashIterator</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/yahoo/sketches/theta/SingleItemSketch.html#iterator--">iterator</a></span>()</code>
<div class="block">Returns a HashIterator that can be used to iterate over the retained hash values of the
Theta sketch.</div>
</td>
</tr>
<tr id="i28" class="altColor">
<td class="colFirst"><code>byte[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/yahoo/sketches/theta/SingleItemSketch.html#toByteArray--">toByteArray</a></span>()</code>
<div class="block">Serialize this sketch to a byte array form.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.com.yahoo.sketches.theta.CompactSketch">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;com.yahoo.sketches.theta.<a href="../../../../com/yahoo/sketches/theta/CompactSketch.html" title="class in com.yahoo.sketches.theta">CompactSketch</a></h3>
<code><a href="../../../../com/yahoo/sketches/theta/CompactSketch.html#compact--">compact</a>, <a href="../../../../com/yahoo/sketches/theta/CompactSketch.html#compact-boolean-com.yahoo.memory.WritableMemory-">compact</a>, <a href="../../../../com/yahoo/sketches/theta/CompactSketch.html#getFamily--">getFamily</a>, <a href="../../../../com/yahoo/sketches/theta/CompactSketch.html#isCompact--">isCompact</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.com.yahoo.sketches.theta.Sketch">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;com.yahoo.sketches.theta.<a href="../../../../com/yahoo/sketches/theta/Sketch.html" title="class in com.yahoo.sketches.theta">Sketch</a></h3>
<code><a href="../../../../com/yahoo/sketches/theta/Sketch.html#getMaxCompactSketchBytes-int-">getMaxCompactSketchBytes</a>, <a href="../../../../com/yahoo/sketches/theta/Sketch.html#getMaxUpdateSketchBytes-int-">getMaxUpdateSketchBytes</a>, <a href="../../../../com/yahoo/sketches/theta/Sketch.html#getRetainedEntries--">getRetainedEntries</a>, <a href="../../../../com/yahoo/sketches/theta/Sketch.html#getSerializationVersion-com.yahoo.memory.Memory-">getSerializationVersion</a>, <a href="../../../../com/yahoo/sketches/theta/Sketch.html#getTheta--">getTheta</a>, <a href="../../../../com/yahoo/sketches/theta/Sketch.html#isEstimationMode--">isEstimationMode</a>, <a href="../../../../com/yahoo/sketches/theta/Sketch.html#isSameResource-com.yahoo.memory.Memory-">isSameResource</a>, <a href="../../../../com/yahoo/sketches/theta/Sketch.html#toString--">toString</a>, <a href="../../../../com/yahoo/sketches/theta/Sketch.html#toString-boolean-boolean-int-boolean-">toString</a>, <a href="../../../../com/yahoo/sketches/theta/Sketch.html#toString-byte:A-">toString</a>, <a href="../../../../com/yahoo/sketches/theta/Sketch.html#toString-com.yahoo.memory.Memory-">toString</a>, <a href="../../../../com/yahoo/sketches/theta/Sketch.html#wrap-com.yahoo.memory.Memory-">wrap</a>, <a href="../../../../com/yahoo/sketches/theta/Sketch.html#wrap-com.yahoo.memory.Memory-long-">wrap</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="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">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">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">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">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">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">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">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">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">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">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">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="heapify-com.yahoo.memory.Memory-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>heapify</h4>
<pre>public static&nbsp;<a href="../../../../com/yahoo/sketches/theta/SingleItemSketch.html" title="class in com.yahoo.sketches.theta">SingleItemSketch</a>&nbsp;heapify(com.yahoo.memory.Memory&nbsp;mem)</pre>
<div class="block">Creates a SingleItemSketch on the heap given a Memory and assumes the DEFAULT_UPDATE_SEED.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>mem</code> - the Memory to be heapified. It must be a least 16 bytes.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a SingleItemSketch</dd>
</dl>
</li>
</ul>
<a name="heapify-com.yahoo.memory.Memory-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>heapify</h4>
<pre>public static&nbsp;<a href="../../../../com/yahoo/sketches/theta/SingleItemSketch.html" title="class in com.yahoo.sketches.theta">SingleItemSketch</a>&nbsp;heapify(com.yahoo.memory.Memory&nbsp;mem,
long&nbsp;seed)</pre>
<div class="block">Creates a SingleItemSketch on the heap given a Memory.
Checks the seed hash of the given Memory against a hash of the given seed.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>mem</code> - the Memory to be heapified</dd>
<dd><code>seed</code> - a given hash seed</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a SingleItemSketch</dd>
</dl>
</li>
</ul>
<a name="create-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>create</h4>
<pre>public static&nbsp;<a href="../../../../com/yahoo/sketches/theta/SingleItemSketch.html" title="class in com.yahoo.sketches.theta">SingleItemSketch</a>&nbsp;create(long&nbsp;datum)</pre>
<div class="block">Create this sketch with a long.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>datum</code> - The given long datum.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a SingleItemSketch</dd>
</dl>
</li>
</ul>
<a name="create-double-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>create</h4>
<pre>public static&nbsp;<a href="../../../../com/yahoo/sketches/theta/SingleItemSketch.html" title="class in com.yahoo.sketches.theta">SingleItemSketch</a>&nbsp;create(double&nbsp;datum)</pre>
<div class="block">Create this sketch with the given double (or float) datum.
The double will be converted to a long using Double.doubleToLongBits(datum),
which normalizes all NaN values to a single NaN representation.
Plus and minus zero will be normalized to plus zero.
The special floating-point values NaN and +/- Infinity are treated as distinct.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>datum</code> - The given double datum.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a SingleItemSketch</dd>
</dl>
</li>
</ul>
<a name="create-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>create</h4>
<pre>public static&nbsp;<a href="../../../../com/yahoo/sketches/theta/SingleItemSketch.html" title="class in com.yahoo.sketches.theta">SingleItemSketch</a>&nbsp;create(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;datum)</pre>
<div class="block">Create this sketch with the given String.
The string is converted to a byte array using UTF8 encoding.
If the string is null or empty no create attempt is made and the method returns null.
<p>Note: this will not produce the same hash values as the <a href="../../../../com/yahoo/sketches/theta/SingleItemSketch.html#create-char:A-"><code>create(char[])</code></a>
method and will generally be a little slower depending on the complexity of the UTF8 encoding.
</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>datum</code> - The given String.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a SingleItemSketch or null</dd>
</dl>
</li>
</ul>
<a name="create-byte:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>create</h4>
<pre>public static&nbsp;<a href="../../../../com/yahoo/sketches/theta/SingleItemSketch.html" title="class in com.yahoo.sketches.theta">SingleItemSketch</a>&nbsp;create(byte[]&nbsp;data)</pre>
<div class="block">Create this sketch with the given byte array.
If the byte array is null or empty no create attempt is made and the method returns null.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>data</code> - The given byte array.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a SingleItemSketch or null</dd>
</dl>
</li>
</ul>
<a name="create-char:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>create</h4>
<pre>public static&nbsp;<a href="../../../../com/yahoo/sketches/theta/SingleItemSketch.html" title="class in com.yahoo.sketches.theta">SingleItemSketch</a>&nbsp;create(char[]&nbsp;data)</pre>
<div class="block">Create this sketch with the given char array.
If the char array is null or empty no create attempt is made and the method returns null.
<p>Note: this will not produce the same output hash values as the <a href="../../../../com/yahoo/sketches/theta/SingleItemSketch.html#create-java.lang.String-"><code>create(String)</code></a>
method but will be a little faster as it avoids the complexity of the UTF8 encoding.</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>data</code> - The given char array.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a SingleItemSketch or null</dd>
</dl>
</li>
</ul>
<a name="create-int:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>create</h4>
<pre>public static&nbsp;<a href="../../../../com/yahoo/sketches/theta/SingleItemSketch.html" title="class in com.yahoo.sketches.theta">SingleItemSketch</a>&nbsp;create(int[]&nbsp;data)</pre>
<div class="block">Create this sketch with the given integer array.
If the integer array is null or empty no create attempt is made and the method returns null.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>data</code> - The given int array.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a SingleItemSketch or null</dd>
</dl>
</li>
</ul>
<a name="create-long:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>create</h4>
<pre>public static&nbsp;<a href="../../../../com/yahoo/sketches/theta/SingleItemSketch.html" title="class in com.yahoo.sketches.theta">SingleItemSketch</a>&nbsp;create(long[]&nbsp;data)</pre>
<div class="block">Create this sketch with the given long array.
If the long array is null or empty no create attempt is made and the method returns null.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>data</code> - The given long array.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a SingleItemSketch or null</dd>
</dl>
</li>
</ul>
<a name="create-long-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>create</h4>
<pre>public static&nbsp;<a href="../../../../com/yahoo/sketches/theta/SingleItemSketch.html" title="class in com.yahoo.sketches.theta">SingleItemSketch</a>&nbsp;create(long&nbsp;datum,
long&nbsp;seed)</pre>
<div class="block">Create this sketch with a long and a seed.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>datum</code> - The given long datum.</dd>
<dd><code>seed</code> - used to hash the given value.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a SingleItemSketch</dd>
</dl>
</li>
</ul>
<a name="create-double-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>create</h4>
<pre>public static&nbsp;<a href="../../../../com/yahoo/sketches/theta/SingleItemSketch.html" title="class in com.yahoo.sketches.theta">SingleItemSketch</a>&nbsp;create(double&nbsp;datum,
long&nbsp;seed)</pre>
<div class="block">Create this sketch with the given double (or float) datum and a seed.
The double will be converted to a long using Double.doubleToLongBits(datum),
which normalizes all NaN values to a single NaN representation.
Plus and minus zero will be normalized to plus zero.
The special floating-point values NaN and +/- Infinity are treated as distinct.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>datum</code> - The given double datum.</dd>
<dd><code>seed</code> - used to hash the given value.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a SingleItemSketch</dd>
</dl>
</li>
</ul>
<a name="create-java.lang.String-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>create</h4>
<pre>public static&nbsp;<a href="../../../../com/yahoo/sketches/theta/SingleItemSketch.html" title="class in com.yahoo.sketches.theta">SingleItemSketch</a>&nbsp;create(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;datum,
long&nbsp;seed)</pre>
<div class="block">Create this sketch with the given String and a seed.
The string is converted to a byte array using UTF8 encoding.
If the string is null or empty no create attempt is made and the method returns null.
<p>Note: this will not produce the same output hash values as the <a href="../../../../com/yahoo/sketches/theta/SingleItemSketch.html#create-char:A-"><code>create(char[])</code></a>
method and will generally be a little slower depending on the complexity of the UTF8 encoding.
</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>datum</code> - The given String.</dd>
<dd><code>seed</code> - used to hash the given value.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a SingleItemSketch or null</dd>
</dl>
</li>
</ul>
<a name="create-byte:A-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>create</h4>
<pre>public static&nbsp;<a href="../../../../com/yahoo/sketches/theta/SingleItemSketch.html" title="class in com.yahoo.sketches.theta">SingleItemSketch</a>&nbsp;create(byte[]&nbsp;data,
long&nbsp;seed)</pre>
<div class="block">Create this sketch with the given byte array and a seed.
If the byte array is null or empty no create attempt is made and the method returns null.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>data</code> - The given byte array.</dd>
<dd><code>seed</code> - used to hash the given value.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a SingleItemSketch or null</dd>
</dl>
</li>
</ul>
<a name="create-char:A-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>create</h4>
<pre>public static&nbsp;<a href="../../../../com/yahoo/sketches/theta/SingleItemSketch.html" title="class in com.yahoo.sketches.theta">SingleItemSketch</a>&nbsp;create(char[]&nbsp;data,
long&nbsp;seed)</pre>
<div class="block">Create this sketch with the given char array and a seed.
If the char array is null or empty no create attempt is made and the method returns null.
<p>Note: this will not produce the same output hash values as the <a href="../../../../com/yahoo/sketches/theta/SingleItemSketch.html#create-java.lang.String-"><code>create(String)</code></a>
method but will be a little faster as it avoids the complexity of the UTF8 encoding.</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>data</code> - The given char array.</dd>
<dd><code>seed</code> - used to hash the given value.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a SingleItemSketch or null</dd>
</dl>
</li>
</ul>
<a name="create-int:A-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>create</h4>
<pre>public static&nbsp;<a href="../../../../com/yahoo/sketches/theta/SingleItemSketch.html" title="class in com.yahoo.sketches.theta">SingleItemSketch</a>&nbsp;create(int[]&nbsp;data,
long&nbsp;seed)</pre>
<div class="block">Create this sketch with the given integer array and a seed.
If the integer array is null or empty no create attempt is made and the method returns null.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>data</code> - The given int array.</dd>
<dd><code>seed</code> - used to hash the given value.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a SingleItemSketch or null</dd>
</dl>
</li>
</ul>
<a name="create-long:A-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>create</h4>
<pre>public static&nbsp;<a href="../../../../com/yahoo/sketches/theta/SingleItemSketch.html" title="class in com.yahoo.sketches.theta">SingleItemSketch</a>&nbsp;create(long[]&nbsp;data,
long&nbsp;seed)</pre>
<div class="block">Create this sketch with the given long array and a seed.
If the long array is null or empty no create attempt is made and the method returns null.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>data</code> - The given long array.</dd>
<dd><code>seed</code> - used to hash the given value.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a SingleItemSketch or null</dd>
</dl>
</li>
</ul>
<a name="getCountLessThanTheta-double-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCountLessThanTheta</h4>
<pre>public&nbsp;int&nbsp;getCountLessThanTheta(double&nbsp;theta)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../com/yahoo/sketches/theta/Sketch.html#getCountLessThanTheta-double-">Sketch</a></code></span></div>
<div class="block">Gets the number of hash values less than the given theta.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../com/yahoo/sketches/theta/Sketch.html#getCountLessThanTheta-double-">getCountLessThanTheta</a></code>&nbsp;in class&nbsp;<code><a href="../../../../com/yahoo/sketches/theta/Sketch.html" title="class in com.yahoo.sketches.theta">Sketch</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>theta</code> - the given theta as a double between zero and one.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of hash values less than the given theta.</dd>
</dl>
</li>
</ul>
<a name="getCurrentBytes-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCurrentBytes</h4>
<pre>public&nbsp;int&nbsp;getCurrentBytes(boolean&nbsp;compact)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../com/yahoo/sketches/theta/Sketch.html#getCurrentBytes-boolean-">Sketch</a></code></span></div>
<div class="block">Returns the number of storage bytes required for this Sketch in its current state.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../com/yahoo/sketches/theta/Sketch.html#getCurrentBytes-boolean-">getCurrentBytes</a></code>&nbsp;in class&nbsp;<code><a href="../../../../com/yahoo/sketches/theta/Sketch.html" title="class in com.yahoo.sketches.theta">Sketch</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>compact</code> - if true, returns the bytes required for compact form.
If this sketch is already in compact form this parameter is ignored.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of storage bytes required for this sketch</dd>
</dl>
</li>
</ul>
<a name="getEstimate--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEstimate</h4>
<pre>public&nbsp;double&nbsp;getEstimate()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../com/yahoo/sketches/theta/Sketch.html#getEstimate--">Sketch</a></code></span></div>
<div class="block">Gets the unique count estimate.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../com/yahoo/sketches/theta/Sketch.html#getEstimate--">getEstimate</a></code>&nbsp;in class&nbsp;<code><a href="../../../../com/yahoo/sketches/theta/Sketch.html" title="class in com.yahoo.sketches.theta">Sketch</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the sketch's best estimate of the cardinality of the input stream.</dd>
</dl>
</li>
</ul>
<a name="iterator--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>iterator</h4>
<pre>public&nbsp;<a href="../../../../com/yahoo/sketches/theta/HashIterator.html" title="interface in com.yahoo.sketches.theta">HashIterator</a>&nbsp;iterator()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../com/yahoo/sketches/theta/Sketch.html#iterator--">Sketch</a></code></span></div>
<div class="block">Returns a HashIterator that can be used to iterate over the retained hash values of the
Theta sketch.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../com/yahoo/sketches/theta/Sketch.html#iterator--">iterator</a></code>&nbsp;in class&nbsp;<code><a href="../../../../com/yahoo/sketches/theta/Sketch.html" title="class in com.yahoo.sketches.theta">Sketch</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a HashIterator that can be used to iterate over the retained hash values of the
Theta sketch.</dd>
</dl>
</li>
</ul>
<a name="getLowerBound-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLowerBound</h4>
<pre>public&nbsp;double&nbsp;getLowerBound(int&nbsp;numStdDev)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../com/yahoo/sketches/theta/Sketch.html#getLowerBound-int-">Sketch</a></code></span></div>
<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="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../com/yahoo/sketches/theta/Sketch.html#getLowerBound-int-">getLowerBound</a></code>&nbsp;in class&nbsp;<code><a href="../../../../com/yahoo/sketches/theta/Sketch.html" title="class in com.yahoo.sketches.theta">Sketch</a></code></dd>
<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 name="getRetainedEntries-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRetainedEntries</h4>
<pre>public&nbsp;int&nbsp;getRetainedEntries(boolean&nbsp;valid)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../com/yahoo/sketches/theta/Sketch.html#getRetainedEntries-boolean-">Sketch</a></code></span></div>
<div class="block">Returns the number of entries that have been retained by the sketch.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../com/yahoo/sketches/theta/Sketch.html#getRetainedEntries-boolean-">getRetainedEntries</a></code>&nbsp;in class&nbsp;<code><a href="../../../../com/yahoo/sketches/theta/Sketch.html" title="class in com.yahoo.sketches.theta">Sketch</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>valid</code> - if true, returns the number of valid entries, which are less than theta and used
for estimation.
Otherwise, return the number of all entries, valid or not, that are currently in the internal
sketch cache.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of retained entries</dd>
</dl>
</li>
</ul>
<a name="getThetaLong--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getThetaLong</h4>
<pre>public&nbsp;long&nbsp;getThetaLong()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../com/yahoo/sketches/theta/Sketch.html#getThetaLong--">Sketch</a></code></span></div>
<div class="block">Gets the value of theta as a long</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../com/yahoo/sketches/theta/Sketch.html#getThetaLong--">getThetaLong</a></code>&nbsp;in class&nbsp;<code><a href="../../../../com/yahoo/sketches/theta/Sketch.html" title="class in com.yahoo.sketches.theta">Sketch</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the value of theta as a long</dd>
</dl>
</li>
</ul>
<a name="getUpperBound-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getUpperBound</h4>
<pre>public&nbsp;double&nbsp;getUpperBound(int&nbsp;numStdDev)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../com/yahoo/sketches/theta/Sketch.html#getUpperBound-int-">Sketch</a></code></span></div>
<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="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../com/yahoo/sketches/theta/Sketch.html#getUpperBound-int-">getUpperBound</a></code>&nbsp;in class&nbsp;<code><a href="../../../../com/yahoo/sketches/theta/Sketch.html" title="class in com.yahoo.sketches.theta">Sketch</a></code></dd>
<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 name="hasMemory--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasMemory</h4>
<pre>public&nbsp;boolean&nbsp;hasMemory()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../com/yahoo/sketches/theta/Sketch.html#hasMemory--">Sketch</a></code></span></div>
<div class="block">Returns true if this sketch's data structure is backed by Memory or WritableMemory.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../com/yahoo/sketches/theta/Sketch.html#hasMemory--">hasMemory</a></code>&nbsp;in class&nbsp;<code><a href="../../../../com/yahoo/sketches/theta/Sketch.html" title="class in com.yahoo.sketches.theta">Sketch</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if this sketch's data structure is backed by Memory or WritableMemory.</dd>
</dl>
</li>
</ul>
<a name="isDirect--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isDirect</h4>
<pre>public&nbsp;boolean&nbsp;isDirect()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../com/yahoo/sketches/theta/Sketch.html#isDirect--">Sketch</a></code></span></div>
<div class="block">Returns true if the this sketch's internal data structure is backed by direct (off-heap)
Memory.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../com/yahoo/sketches/theta/Sketch.html#isDirect--">isDirect</a></code>&nbsp;in class&nbsp;<code><a href="../../../../com/yahoo/sketches/theta/Sketch.html" title="class in com.yahoo.sketches.theta">Sketch</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if the this sketch's internal data structure is backed by direct (off-heap)
Memory.</dd>
</dl>
</li>
</ul>
<a name="isEmpty--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isEmpty</h4>
<pre>public&nbsp;boolean&nbsp;isEmpty()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../com/yahoo/sketches/theta/Sketch.html#isEmpty--">Sketch</a></code></span></div>
<div class="block"><a href="../../../../resources/dictionary.html#empty">See Empty</a></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../com/yahoo/sketches/theta/Sketch.html#isEmpty--">isEmpty</a></code>&nbsp;in class&nbsp;<code><a href="../../../../com/yahoo/sketches/theta/Sketch.html" title="class in com.yahoo.sketches.theta">Sketch</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if empty.</dd>
</dl>
</li>
</ul>
<a name="isOrdered--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isOrdered</h4>
<pre>public&nbsp;boolean&nbsp;isOrdered()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../com/yahoo/sketches/theta/Sketch.html#isOrdered--">Sketch</a></code></span></div>
<div class="block">Returns true if internal cache is ordered</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../com/yahoo/sketches/theta/Sketch.html#isOrdered--">isOrdered</a></code>&nbsp;in class&nbsp;<code><a href="../../../../com/yahoo/sketches/theta/Sketch.html" title="class in com.yahoo.sketches.theta">Sketch</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if internal cache is ordered</dd>
</dl>
</li>
</ul>
<a name="toByteArray--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toByteArray</h4>
<pre>public&nbsp;byte[]&nbsp;toByteArray()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../com/yahoo/sketches/theta/Sketch.html#toByteArray--">Sketch</a></code></span></div>
<div class="block">Serialize this sketch to a byte array form.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../com/yahoo/sketches/theta/Sketch.html#toByteArray--">toByteArray</a></code>&nbsp;in class&nbsp;<code><a href="../../../../com/yahoo/sketches/theta/Sketch.html" title="class in com.yahoo.sketches.theta">Sketch</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>byte array of this sketch</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/SingleItemSketch.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">
<li><a href="../../../../com/yahoo/sketches/theta/SetOperationBuilder.html" title="class in com.yahoo.sketches.theta"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../com/yahoo/sketches/theta/Sketch.html" title="class in com.yahoo.sketches.theta"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/yahoo/sketches/theta/SingleItemSketch.html" target="_top">Frames</a></li>
<li><a href="SingleItemSketch.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.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>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&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>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2015&#x2013;2019. All rights reserved.</small></p>
</body>
</html>