Google Git
Sign in
apache / datasketches-website / 4e83e51533ab0e89e82946dca92a6cde8a66ded4 / . / api / java / snapshot / apidocs / org / apache / datasketches / theta / Sketch.html
blob: 6027e4f71dc9dfd46fab6a57b34399039479c9a2 [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_302) on Wed Jan 26 15:15:51 PST 2022 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Sketch (datasketches-java 3.1.0 API)</title>
<meta name="date" content="2022-01-26">
<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="Sketch (datasketches-java 3.1.0 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":6,"i2":6,"i3":10,"i4":6,"i5":6,"i6":6,"i7":10,"i8":9,"i9":9,"i10":10,"i11":6,"i12":9,"i13":10,"i14":6,"i15":10,"i16":6,"i17":9,"i18":9,"i19":6,"i20":6,"i21":6,"i22":10,"i23":6,"i24":10,"i25":6,"i26":6,"i27":10,"i28":10,"i29":9,"i30":9,"i31":9,"i32":9};
var tabs = {65535:["t0","All Methods"],1:["t1","Static 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";
</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/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">
<li><a href="../../../../org/apache/datasketches/theta/SetOperationBuilder.html" title="class in org.apache.datasketches.theta"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/datasketches/theta/Sketches.html" title="class in org.apache.datasketches.theta"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/datasketches/theta/Sketch.html" target="_top">Frames</a></li>
<li><a href="Sketch.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">org.apache.datasketches.theta</div>
<h2 title="Class Sketch" class="title">Class Sketch</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>org.apache.datasketches.theta.Sketch</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../../org/apache/datasketches/theta/CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a>, <a href="../../../../org/apache/datasketches/theta/UpdateSketch.html" title="class in org.apache.datasketches.theta">UpdateSketch</a></dd>
</dl>
<hr>
<br>
<pre>public abstract class <span class="typeNameLabel">Sketch</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">Object</a></pre>
<div class="block">The top-level class for all sketches. This class is never constructed directly.
Use the UpdateSketch.builder() methods to create UpdateSketches.</div>
<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="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="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/datasketches/theta/CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/datasketches/theta/Sketch.html#compact--">compact</a></span>()</code>
<div class="block">Converts this sketch to a ordered CompactSketch on the Java heap.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>abstract <a href="../../../../org/apache/datasketches/theta/CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/datasketches/theta/Sketch.html#compact-boolean-org.apache.datasketches.memory.WritableMemory-">compact</a></span>(boolean&nbsp;dstOrdered,
org.apache.datasketches.memory.WritableMemory&nbsp;dstMem)</code>
<div class="block">Convert this sketch to a new CompactSketch of the chosen order and direct or on the heap.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>abstract int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/datasketches/theta/Sketch.html#getCompactBytes--">getCompactBytes</a></span>()</code>
<div class="block">Returns the number of storage bytes required for this Sketch if its current state were
compacted.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/datasketches/theta/Sketch.html#getCountLessThanThetaLong-long-">getCountLessThanThetaLong</a></span>(long&nbsp;thetaLong)</code>
<div class="block">Gets the number of hash values less than the given theta expressed as a long.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>abstract int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/datasketches/theta/Sketch.html#getCurrentBytes--">getCurrentBytes</a></span>()</code>
<div class="block">Returns the number of storage bytes required for this sketch in its current state.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>abstract double</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/datasketches/theta/Sketch.html#getEstimate--">getEstimate</a></span>()</code>
<div class="block">Gets the unique count estimate.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>abstract <a href="../../../../org/apache/datasketches/Family.html" title="enum in org.apache.datasketches">Family</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/datasketches/theta/Sketch.html#getFamily--">getFamily</a></span>()</code>
<div class="block">Returns the Family that this sketch belongs to</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/datasketches/theta/Sketch.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="i8" class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/datasketches/theta/Sketch.html#getMaxCompactSketchBytes-int-">getMaxCompactSketchBytes</a></span>(int&nbsp;numberOfEntries)</code>
<div class="block">Returns the maximum number of storage bytes required for a CompactSketch with the given
number of actual entries.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/datasketches/theta/Sketch.html#getMaxUpdateSketchBytes-int-">getMaxUpdateSketchBytes</a></span>(int&nbsp;nomEntries)</code>
<div class="block">Returns the maximum number of storage bytes required for an UpdateSketch with the given
number of nominal entries (power of 2).</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/datasketches/theta/Sketch.html#getRetainedEntries--">getRetainedEntries</a></span>()</code>
<div class="block">Returns the number of valid entries that have been retained by the sketch.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>abstract int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/datasketches/theta/Sketch.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="i12" class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/datasketches/theta/Sketch.html#getSerializationVersion-org.apache.datasketches.memory.Memory-">getSerializationVersion</a></span>(org.apache.datasketches.memory.Memory&nbsp;mem)</code>
<div class="block">Returns the serialization version from the given Memory</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/datasketches/theta/Sketch.html#getTheta--">getTheta</a></span>()</code>
<div class="block">Gets the value of theta as a double with a value between zero and one</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>abstract long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/datasketches/theta/Sketch.html#getThetaLong--">getThetaLong</a></span>()</code>
<div class="block">Gets the value of theta as a long</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/datasketches/theta/Sketch.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="i16" class="altColor">
<td class="colFirst"><code>abstract boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/datasketches/theta/Sketch.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="i17" class="rowColor">
<td class="colFirst"><code>static <a href="../../../../org/apache/datasketches/theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/datasketches/theta/Sketch.html#heapify-org.apache.datasketches.memory.Memory-">heapify</a></span>(org.apache.datasketches.memory.Memory&nbsp;srcMem)</code>
<div class="block">Heapify takes the sketch image in Memory and instantiates an on-heap Sketch.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>static <a href="../../../../org/apache/datasketches/theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/datasketches/theta/Sketch.html#heapify-org.apache.datasketches.memory.Memory-long-">heapify</a></span>(org.apache.datasketches.memory.Memory&nbsp;srcMem,
long&nbsp;expectedSeed)</code>
<div class="block">Heapify takes the sketch image in Memory and instantiates an on-heap Sketch.</div>
</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code>abstract boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/datasketches/theta/Sketch.html#isCompact--">isCompact</a></span>()</code>
<div class="block">Returns true if this sketch is in compact form.</div>
</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code>abstract boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/datasketches/theta/Sketch.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="i21" class="rowColor">
<td class="colFirst"><code>abstract boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/datasketches/theta/Sketch.html#isEmpty--">isEmpty</a></span>()</code>
<div class="block"><a href="../../../../resources/dictionary.html#empty">See Empty</a></div>
</td>
</tr>
<tr id="i22" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/datasketches/theta/Sketch.html#isEstimationMode--">isEstimationMode</a></span>()</code>
<div class="block">Returns true if the sketch is Estimation Mode (as opposed to Exact Mode).</div>
</td>
</tr>
<tr id="i23" class="rowColor">
<td class="colFirst"><code>abstract boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/datasketches/theta/Sketch.html#isOrdered--">isOrdered</a></span>()</code>
<div class="block">Returns true if internal cache is ordered</div>
</td>
</tr>
<tr id="i24" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/datasketches/theta/Sketch.html#isSameResource-org.apache.datasketches.memory.Memory-">isSameResource</a></span>(org.apache.datasketches.memory.Memory&nbsp;that)</code>
<div class="block">Returns true if the backing resource of <i>this</i> is identical with the backing resource
of <i>that</i>.</div>
</td>
</tr>
<tr id="i25" class="rowColor">
<td class="colFirst"><code>abstract <a href="../../../../org/apache/datasketches/theta/HashIterator.html" title="interface in org.apache.datasketches.theta">HashIterator</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/datasketches/theta/Sketch.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="i26" class="altColor">
<td class="colFirst"><code>abstract byte[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/datasketches/theta/Sketch.html#toByteArray--">toByteArray</a></span>()</code>
<div class="block">Serialize this sketch to a byte array form.</div>
</td>
</tr>
<tr id="i27" class="rowColor">
<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">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/datasketches/theta/Sketch.html#toString--">toString</a></span>()</code>
<div class="block">Returns a human readable summary of the sketch.</div>
</td>
</tr>
<tr id="i28" 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">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/datasketches/theta/Sketch.html#toString-boolean-boolean-int-boolean-">toString</a></span>(boolean&nbsp;sketchSummary,
boolean&nbsp;dataDetail,
int&nbsp;width,
boolean&nbsp;hexMode)</code>
<div class="block">Gets a human readable listing of contents and summary of the given sketch.</div>
</td>
</tr>
<tr id="i29" class="rowColor">
<td class="colFirst"><code>static <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></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/datasketches/theta/Sketch.html#toString-byte:A-">toString</a></span>(byte[]&nbsp;byteArr)</code>
<div class="block">Returns a human readable string of the preamble of a byte array image of a Theta Sketch.</div>
</td>
</tr>
<tr id="i30" class="altColor">
<td class="colFirst"><code>static <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></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/datasketches/theta/Sketch.html#toString-org.apache.datasketches.memory.Memory-">toString</a></span>(org.apache.datasketches.memory.Memory&nbsp;mem)</code>
<div class="block">Returns a human readable string of the preamble of a Memory image of a Theta Sketch.</div>
</td>
</tr>
<tr id="i31" class="rowColor">
<td class="colFirst"><code>static <a href="../../../../org/apache/datasketches/theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/datasketches/theta/Sketch.html#wrap-org.apache.datasketches.memory.Memory-">wrap</a></span>(org.apache.datasketches.memory.Memory&nbsp;srcMem)</code>
<div class="block">Wrap takes the sketch image in the given Memory and refers to it directly.</div>
</td>
</tr>
<tr id="i32" class="altColor">
<td class="colFirst"><code>static <a href="../../../../org/apache/datasketches/theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/datasketches/theta/Sketch.html#wrap-org.apache.datasketches.memory.Memory-long-">wrap</a></span>(org.apache.datasketches.memory.Memory&nbsp;srcMem,
long&nbsp;expectedSeed)</code>
<div class="block">Wrap takes the sketch image in the given Memory and refers to it directly.</div>
</td>
</tr>
</table>
<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-org.apache.datasketches.memory.Memory-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>heapify</h4>
<pre>public static&nbsp;<a href="../../../../org/apache/datasketches/theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a>&nbsp;heapify(org.apache.datasketches.memory.Memory&nbsp;srcMem)</pre>
<div class="block">Heapify takes the sketch image in Memory and instantiates an on-heap Sketch.
<p>The resulting sketch will not retain any link to the source Memory.</p>
<p>For Update Sketches this method checks if the
<a href="../../../../resources/dictionary.html#defaultUpdateSeed">Default Update Seed</a></p>
was used to create the source Memory image.
<p>For Compact Sketches this method assumes that the sketch image was created with the
correct hash seed, so it is not checked.</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>srcMem</code> - an image of a Sketch.
<a href="../../../../resources/dictionary.html#mem">See Memory</a>.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a Sketch on the heap.</dd>
</dl>
</li>
</ul>
<a name="heapify-org.apache.datasketches.memory.Memory-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>heapify</h4>
<pre>public static&nbsp;<a href="../../../../org/apache/datasketches/theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a>&nbsp;heapify(org.apache.datasketches.memory.Memory&nbsp;srcMem,
long&nbsp;expectedSeed)</pre>
<div class="block">Heapify takes the sketch image in Memory and instantiates an on-heap Sketch.
<p>The resulting sketch will not retain any link to the source Memory.</p>
<p>For Update and Compact Sketches this method checks if the given expectedSeed was used to
create the source Memory image. However, SerialVersion 1 sketches cannot be checked.</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>srcMem</code> - an image of a Sketch that was created using the given expectedSeed.
<a href="../../../../resources/dictionary.html#mem">See Memory</a>.</dd>
<dd><code>expectedSeed</code> - the seed used to validate the given Memory image.
<a href="../../../../resources/dictionary.html#seed">See Update Hash Seed</a>.
Compact sketches store a 16-bit hash of the seed, but not the seed itself.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a Sketch on the heap.</dd>
</dl>
</li>
</ul>
<a name="wrap-org.apache.datasketches.memory.Memory-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>wrap</h4>
<pre>public static&nbsp;<a href="../../../../org/apache/datasketches/theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a>&nbsp;wrap(org.apache.datasketches.memory.Memory&nbsp;srcMem)</pre>
<div class="block">Wrap takes the sketch image in the given Memory and refers to it directly.
There is no data copying onto the java heap.
The wrap operation enables fast read-only merging and access to all the public read-only API.
<p>Only "Direct" Serialization Version 3 (i.e, OpenSource) sketches that have
been explicitly stored as direct sketches can be wrapped.
Wrapping earlier serial version sketches will result in a on-heap CompactSketch
where all data will be copied to the heap. These early versions were never designed to
"wrap".</p>
<p>Wrapping any subclass of this class that is empty or contains only a single item will
result in on-heap equivalent forms of empty and single item sketch respectively.
This is actually faster and consumes less overall memory.</p>
<p>For Update Sketches this method checks if the
<a href="../../../../resources/dictionary.html#defaultUpdateSeed">Default Update Seed</a></p>
was used to create the source Memory image.
<p>For Compact Sketches this method assumes that the sketch image was created with the
correct hash seed, so it is not checked.</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>srcMem</code> - an image of a Sketch.
<a href="../../../../resources/dictionary.html#mem">See Memory</a>.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a Sketch backed by the given Memory</dd>
</dl>
</li>
</ul>
<a name="wrap-org.apache.datasketches.memory.Memory-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>wrap</h4>
<pre>public static&nbsp;<a href="../../../../org/apache/datasketches/theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a>&nbsp;wrap(org.apache.datasketches.memory.Memory&nbsp;srcMem,
long&nbsp;expectedSeed)</pre>
<div class="block">Wrap takes the sketch image in the given Memory and refers to it directly.
There is no data copying onto the java heap.
The wrap operation enables fast read-only merging and access to all the public read-only API.
<p>Only "Direct" Serialization Version 3 (i.e, OpenSource) sketches that have
been explicitly stored as direct sketches can be wrapped.
Wrapping earlier serial version sketches will result in a on-heap CompactSketch
where all data will be copied to the heap. These early versions were never designed to
"wrap".</p>
<p>Wrapping any subclass of this class that is empty or contains only a single item will
result in on-heap equivalent forms of empty and single item sketch respectively.
This is actually faster and consumes less overall memory.</p>
<p>For Update and Compact Sketches this method checks if the given expectedSeed was used to
create the source Memory image. However, SerialVersion 1 sketches cannot be checked.</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>srcMem</code> - an image of a Sketch.
<a href="../../../../resources/dictionary.html#mem">See Memory</a></dd>
<dd><code>expectedSeed</code> - the seed used to validate the given Memory image.
<a href="../../../../resources/dictionary.html#seed">See Update Hash Seed</a>.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a UpdateSketch backed by the given Memory except as above.</dd>
</dl>
</li>
</ul>
<a name="compact--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>compact</h4>
<pre>public&nbsp;<a href="../../../../org/apache/datasketches/theta/CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a>&nbsp;compact()</pre>
<div class="block">Converts this sketch to a ordered CompactSketch on the Java heap.
<p>If this sketch is already in the proper form, this method returns <i>this</i>,
otherwise, this method returns a new CompactSketch of the proper form.
<p>A CompactSketch is always immutable.</p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this sketch as an ordered CompactSketch on the Java heap.</dd>
</dl>
</li>
</ul>
<a name="compact-boolean-org.apache.datasketches.memory.WritableMemory-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>compact</h4>
<pre>public abstract&nbsp;<a href="../../../../org/apache/datasketches/theta/CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a>&nbsp;compact(boolean&nbsp;dstOrdered,
org.apache.datasketches.memory.WritableMemory&nbsp;dstMem)</pre>
<div class="block">Convert this sketch to a new CompactSketch of the chosen order and direct or on the heap.
<p>If this sketch is already in the proper form, this operation returns <i>this</i>,
otherwise, this method returns a new CompactSketch of the proper form.
<p>If this sketch is a type of UpdateSketch, the compacting process converts the hash table
of the UpdateSketch to a simple list of the valid hash values.
Any hash values of zero or equal-to or greater than theta will be discarded.
The number of valid values remaining in the CompactSketch depends on a number of factors,
but may be larger or smaller than <i>Nominal Entries</i> (or <i>k</i>).
It will never exceed 2<i>k</i>.
If it is critical to always limit the size to no more than <i>k</i>,
then <i>rebuild()</i> should be called on the UpdateSketch prior to calling this method.</p>
<p>A CompactSketch is always immutable.</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>dstOrdered</code> - <a href="../../../../resources/dictionary.html#dstOrdered">See Destination Ordered</a></dd>
<dd><code>dstMem</code> - <a href="../../../../resources/dictionary.html#dstMem">See Destination Memory</a>.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this sketch as a CompactSketch in the chosen form</dd>
</dl>
</li>
</ul>
<a name="getCompactBytes--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCompactBytes</h4>
<pre>public abstract&nbsp;int&nbsp;getCompactBytes()</pre>
<div class="block">Returns the number of storage bytes required for this Sketch if its current state were
compacted. It this sketch is already in the compact form this is equivalent to
calling <a href="../../../../org/apache/datasketches/theta/Sketch.html#getCurrentBytes--"><code>getCurrentBytes()</code></a>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>number of compact bytes</dd>
</dl>
</li>
</ul>
<a name="getCountLessThanThetaLong-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCountLessThanThetaLong</h4>
<pre>public&nbsp;int&nbsp;getCountLessThanThetaLong(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 name="getCurrentBytes--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCurrentBytes</h4>
<pre>public abstract&nbsp;int&nbsp;getCurrentBytes()</pre>
<div class="block">Returns the number of storage bytes required for this sketch in its current state.</div>
<dl>
<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 abstract&nbsp;double&nbsp;getEstimate()</pre>
<div class="block">Gets the unique count estimate.</div>
<dl>
<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="getFamily--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFamily</h4>
<pre>public abstract&nbsp;<a href="../../../../org/apache/datasketches/Family.html" title="enum in org.apache.datasketches">Family</a>&nbsp;getFamily()</pre>
<div class="block">Returns the Family that this sketch belongs to</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the Family that this sketch belongs to</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">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 name="getMaxCompactSketchBytes-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMaxCompactSketchBytes</h4>
<pre>public static&nbsp;int&nbsp;getMaxCompactSketchBytes(int&nbsp;numberOfEntries)</pre>
<div class="block">Returns the maximum number of storage bytes required for a CompactSketch with the given
number of actual entries. Note that this assumes the worse case of the sketch in
estimation mode, which requires storing theta and count.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>numberOfEntries</code> - the actual number of entries stored with the CompactSketch.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the maximum number of storage bytes required for a CompactSketch with the given number
of entries.</dd>
</dl>
</li>
</ul>
<a name="getMaxUpdateSketchBytes-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMaxUpdateSketchBytes</h4>
<pre>public static&nbsp;int&nbsp;getMaxUpdateSketchBytes(int&nbsp;nomEntries)</pre>
<div class="block">Returns the maximum number of storage bytes required for an UpdateSketch with the given
number of nominal entries (power of 2).</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>nomEntries</code> - <a href="../../../../resources/dictionary.html#nomEntries">Nominal Entres</a>
This will become the ceiling power of 2 if it is not.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the maximum number of storage bytes required for a UpdateSketch with the given
nomEntries</dd>
</dl>
</li>
</ul>
<a name="getRetainedEntries--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRetainedEntries</h4>
<pre>public&nbsp;int&nbsp;getRetainedEntries()</pre>
<div class="block">Returns the number of valid entries that have been retained by the sketch.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of valid retained entries</dd>
</dl>
</li>
</ul>
<a name="getRetainedEntries-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRetainedEntries</h4>
<pre>public abstract&nbsp;int&nbsp;getRetainedEntries(boolean&nbsp;valid)</pre>
<div class="block">Returns the number of entries that have been retained by the sketch.</div>
<dl>
<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="getSerializationVersion-org.apache.datasketches.memory.Memory-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSerializationVersion</h4>
<pre>public static&nbsp;int&nbsp;getSerializationVersion(org.apache.datasketches.memory.Memory&nbsp;mem)</pre>
<div class="block">Returns the serialization version from the given Memory</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>mem</code> - the sketch Memory</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the serialization version from the Memory</dd>
</dl>
</li>
</ul>
<a name="getTheta--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTheta</h4>
<pre>public&nbsp;double&nbsp;getTheta()</pre>
<div class="block">Gets the value of theta as a double with a value 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 name="getThetaLong--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getThetaLong</h4>
<pre>public abstract&nbsp;long&nbsp;getThetaLong()</pre>
<div class="block">Gets the value of theta as a long</div>
<dl>
<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">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 name="hasMemory--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasMemory</h4>
<pre>public abstract&nbsp;boolean&nbsp;hasMemory()</pre>
<div class="block">Returns true if this sketch's data structure is backed by Memory or WritableMemory.</div>
<dl>
<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="isCompact--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isCompact</h4>
<pre>public abstract&nbsp;boolean&nbsp;isCompact()</pre>
<div class="block">Returns true if this sketch is in compact form.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if this sketch is in compact form.</dd>
</dl>
</li>
</ul>
<a name="isDirect--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isDirect</h4>
<pre>public abstract&nbsp;boolean&nbsp;isDirect()</pre>
<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="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 abstract&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 name="isEstimationMode--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isEstimationMode</h4>
<pre>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 name="isOrdered--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isOrdered</h4>
<pre>public abstract&nbsp;boolean&nbsp;isOrdered()</pre>
<div class="block">Returns true if internal cache is ordered</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if internal cache is ordered</dd>
</dl>
</li>
</ul>
<a name="isSameResource-org.apache.datasketches.memory.Memory-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isSameResource</h4>
<pre>public&nbsp;boolean&nbsp;isSameResource(org.apache.datasketches.memory.Memory&nbsp;that)</pre>
<div class="block">Returns true if the backing resource of <i>this</i> is identical with the backing resource
of <i>that</i>. The capacities must be the same. If <i>this</i> is a region,
the region offset must also be the same.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>that</code> - A different non-null object</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if the backing resource of <i>this</i> is the same as the backing resource
of <i>that</i>.</dd>
</dl>
</li>
</ul>
<a name="iterator--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>iterator</h4>
<pre>public abstract&nbsp;<a href="../../../../org/apache/datasketches/theta/HashIterator.html" title="interface in org.apache.datasketches.theta">HashIterator</a>&nbsp;iterator()</pre>
<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="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="toByteArray--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toByteArray</h4>
<pre>public abstract&nbsp;byte[]&nbsp;toByteArray()</pre>
<div class="block">Serialize this sketch to a byte array form.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>byte array of this sketch</dd>
</dl>
</li>
</ul>
<a name="toString--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toString</h4>
<pre>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">String</a>&nbsp;toString()</pre>
<div class="block">Returns a human readable summary of the sketch. This method is equivalent to the parameterized
call:<br>
<i>Sketch.toString(sketch, true, false, 8, true);</i></div>
<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">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">Object</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>summary</dd>
</dl>
</li>
</ul>
<a name="toString-boolean-boolean-int-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toString</h4>
<pre>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">String</a>&nbsp;toString(boolean&nbsp;sketchSummary,
boolean&nbsp;dataDetail,
int&nbsp;width,
boolean&nbsp;hexMode)</pre>
<div class="block">Gets a human readable listing of contents and summary of the given sketch.
This can be a very long string. If this sketch is in a "dirty" state there
may be values in the dataDetail view that are &ge; theta.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>sketchSummary</code> - If true the sketch summary will be output at the end.</dd>
<dd><code>dataDetail</code> - If true, includes all valid hash values in the sketch.</dd>
<dd><code>width</code> - The number of columns of hash values. Default is 8.</dd>
<dd><code>hexMode</code> - If true, hashes will be output in hex.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The result string, which can be very long.</dd>
</dl>
</li>
</ul>
<a name="toString-byte:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toString</h4>
<pre>public static&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">String</a>&nbsp;toString(byte[]&nbsp;byteArr)</pre>
<div class="block">Returns a human readable string of the preamble of a byte array image of a Theta Sketch.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>byteArr</code> - the given byte array</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a human readable string of the preamble of a byte array image of a Theta Sketch.</dd>
</dl>
</li>
</ul>
<a name="toString-org.apache.datasketches.memory.Memory-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toString</h4>
<pre>public static&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">String</a>&nbsp;toString(org.apache.datasketches.memory.Memory&nbsp;mem)</pre>
<div class="block">Returns a human readable string of the preamble of a Memory image of a Theta Sketch.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>mem</code> - the given Memory object</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a human readable string of the preamble of a Memory image of a Theta 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/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">
<li><a href="../../../../org/apache/datasketches/theta/SetOperationBuilder.html" title="class in org.apache.datasketches.theta"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/datasketches/theta/Sketches.html" title="class in org.apache.datasketches.theta"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/datasketches/theta/Sketch.html" target="_top">Frames</a></li>
<li><a href="Sketch.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;2020 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>