Google Git
Sign in
apache / datasketches-website / 4e83e51533ab0e89e82946dca92a6cde8a66ded4 / . / api / java / snapshot / apidocs / org / apache / datasketches / theta / CompactSketch.html
blob: 680f360b7b78c9daae81afb2080246386026115b [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>CompactSketch (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="CompactSketch (datasketches-java 3.1.0 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":10,"i2":10,"i3":9,"i4":9,"i5":10,"i6":9,"i7":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/CompactSketch.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/AnotB.html" title="class in org.apache.datasketches.theta"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/datasketches/theta/HashIterator.html" title="interface 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/CompactSketch.html" target="_top">Frames</a></li>
<li><a href="CompactSketch.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><a href="#constructor.summary">Constr</a>&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><a href="#constructor.detail">Constr</a>&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 CompactSketch" class="title">Class CompactSketch</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="../../../../org/apache/datasketches/theta/Sketch.html" title="class in org.apache.datasketches.theta">org.apache.datasketches.theta.Sketch</a></li>
<li>
<ul class="inheritance">
<li>org.apache.datasketches.theta.CompactSketch</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public abstract class <span class="typeNameLabel">CompactSketch</span>
extends <a href="../../../../org/apache/datasketches/theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a></pre>
<div class="block">The parent class of all the CompactSketches. CompactSketches are never created directly.
They are created as a result of the compact() method of an UpdateSketch, a result of a
getResult() of a SetOperation, or from a heapify method.
<p>A CompactSketch is the simplest form of a Theta Sketch. It consists of a compact list
(i.e., no intervening spaces) of hash values, which may be ordered or not, a value for theta
and a seed hash. A CompactSketch is immutable (read-only),
and the space required when stored is only the space required for the hash values and 8 to 24
bytes of preamble. An empty CompactSketch consumes only 8 bytes.</p></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">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/datasketches/theta/CompactSketch.html#CompactSketch--">CompactSketch</a></span>()</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== 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>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/CompactSketch.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="i1" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/datasketches/theta/CompactSketch.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="i2" class="altColor">
<td class="colFirst"><code><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/CompactSketch.html#getFamily--">getFamily</a></span>()</code>
<div class="block">Returns the Family that this sketch belongs to</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>static <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/CompactSketch.html#heapify-org.apache.datasketches.memory.Memory-">heapify</a></span>(org.apache.datasketches.memory.Memory&nbsp;srcMem)</code>
<div class="block">Heapify takes a CompactSketch image in Memory and instantiates an on-heap CompactSketch.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>static <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/CompactSketch.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 a CompactSketch image in Memory and instantiates an on-heap CompactSketch.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/datasketches/theta/CompactSketch.html#isCompact--">isCompact</a></span>()</code>
<div class="block">Returns true if this sketch is in compact form.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>static <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/CompactSketch.html#wrap-org.apache.datasketches.memory.Memory-">wrap</a></span>(org.apache.datasketches.memory.Memory&nbsp;srcMem)</code>
<div class="block">Wrap takes the CompactSketch image in given Memory and refers to it directly.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>static <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/CompactSketch.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.org.apache.datasketches.theta.Sketch">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.datasketches.theta.<a href="../../../../org/apache/datasketches/theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a></h3>
<code><a href="../../../../org/apache/datasketches/theta/Sketch.html#compact--">compact</a>, <a href="../../../../org/apache/datasketches/theta/Sketch.html#getCountLessThanThetaLong-long-">getCountLessThanThetaLong</a>, <a href="../../../../org/apache/datasketches/theta/Sketch.html#getCurrentBytes--">getCurrentBytes</a>, <a href="../../../../org/apache/datasketches/theta/Sketch.html#getEstimate--">getEstimate</a>, <a href="../../../../org/apache/datasketches/theta/Sketch.html#getLowerBound-int-">getLowerBound</a>, <a href="../../../../org/apache/datasketches/theta/Sketch.html#getMaxCompactSketchBytes-int-">getMaxCompactSketchBytes</a>, <a href="../../../../org/apache/datasketches/theta/Sketch.html#getMaxUpdateSketchBytes-int-">getMaxUpdateSketchBytes</a>, <a href="../../../../org/apache/datasketches/theta/Sketch.html#getRetainedEntries--">getRetainedEntries</a>, <a href="../../../../org/apache/datasketches/theta/Sketch.html#getRetainedEntries-boolean-">getRetainedEntries</a>, <a href="../../../../org/apache/datasketches/theta/Sketch.html#getSerializationVersion-org.apache.datasketches.memory.Memory-">getSerializationVersion</a>, <a href="../../../../org/apache/datasketches/theta/Sketch.html#getTheta--">getTheta</a>, <a href="../../../../org/apache/datasketches/theta/Sketch.html#getThetaLong--">getThetaLong</a>, <a href="../../../../org/apache/datasketches/theta/Sketch.html#getUpperBound-int-">getUpperBound</a>, <a href="../../../../org/apache/datasketches/theta/Sketch.html#hasMemory--">hasMemory</a>, <a href="../../../../org/apache/datasketches/theta/Sketch.html#isDirect--">isDirect</a>, <a href="../../../../org/apache/datasketches/theta/Sketch.html#isEmpty--">isEmpty</a>, <a href="../../../../org/apache/datasketches/theta/Sketch.html#isEstimationMode--">isEstimationMode</a>, <a href="../../../../org/apache/datasketches/theta/Sketch.html#isOrdered--">isOrdered</a>, <a href="../../../../org/apache/datasketches/theta/Sketch.html#isSameResource-org.apache.datasketches.memory.Memory-">isSameResource</a>, <a href="../../../../org/apache/datasketches/theta/Sketch.html#iterator--">iterator</a>, <a href="../../../../org/apache/datasketches/theta/Sketch.html#toByteArray--">toByteArray</a>, <a href="../../../../org/apache/datasketches/theta/Sketch.html#toString--">toString</a>, <a href="../../../../org/apache/datasketches/theta/Sketch.html#toString-boolean-boolean-int-boolean-">toString</a>, <a href="../../../../org/apache/datasketches/theta/Sketch.html#toString-byte:A-">toString</a>, <a href="../../../../org/apache/datasketches/theta/Sketch.html#toString-org.apache.datasketches.memory.Memory-">toString</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">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="CompactSketch--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>CompactSketch</h4>
<pre>public&nbsp;CompactSketch()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ 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/CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a>&nbsp;heapify(org.apache.datasketches.memory.Memory&nbsp;srcMem)</pre>
<div class="block">Heapify takes a CompactSketch image in Memory and instantiates an on-heap CompactSketch.
<p>The resulting sketch will not retain any link to the source Memory and all of its data will be
copied to the heap CompactSketch.</p>
<p>This method assumes that the sketch image was created with the correct hash seed, so it is not checked.
The resulting on-heap CompactSketch will be given the seedHash derived from the given sketch image.
However, Serial Version 1 sketch images do not have a seedHash field,
so the resulting heapified CompactSketch will be given the hash of the DEFAULT_UPDATE_SEED.</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>srcMem</code> - an image of a CompactSketch.
<a href="../../../../resources/dictionary.html#mem">See Memory</a>.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a CompactSketch 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/CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a>&nbsp;heapify(org.apache.datasketches.memory.Memory&nbsp;srcMem,
long&nbsp;expectedSeed)</pre>
<div class="block">Heapify takes a CompactSketch image in Memory and instantiates an on-heap CompactSketch.
<p>The resulting sketch will not retain any link to the source Memory and all of its data will be
copied to the heap CompactSketch.</p>
<p>This method checks if the given expectedSeed was used to create the source Memory image.
However, SerialVersion 1 sketch images cannot be checked as they don't have a seedHash field,
so the resulting heapified CompactSketch will be given the hash of the expectedSeed.</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>srcMem</code> - an image of a CompactSketch that was created using the given expectedSeed.
<a href="../../../../resources/dictionary.html#mem">See Memory</a>.</dd>
<dd><code>expectedSeed</code> - the seed used to validate the given Memory image.
<a href="../../../../resources/dictionary.html#seed">See Update Hash Seed</a>.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a CompactSketch 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/CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a>&nbsp;wrap(org.apache.datasketches.memory.Memory&nbsp;srcMem)</pre>
<div class="block">Wrap takes the CompactSketch image in given Memory and refers to it directly.
There is no data copying onto the java heap.
The wrap operation enables fast read-only merging and access to all the public read-only API.
<p>Only "Direct" Serialization Version 3 (i.e, OpenSource) sketches that have
been explicitly stored as direct sketches can be wrapped.
Wrapping earlier serial version sketches will result in a heapify operation.
These early versions were never designed to "wrap".</p>
<p>Wrapping any subclass of this class that is empty or contains only a single item will
result in heapified forms of empty and single item sketch respectively.
This is actually faster and consumes less overall memory.</p>
<p>This method assumes that the sketch image was created with the correct hash seed, so it is not checked.
However, Serial Version 1 sketch images do not have a seedHash field,
so the resulting on-heap CompactSketch will be given the hash of the DEFAULT_UPDATE_SEED.</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 CompactSketch backed by the given Memory except as above.</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/CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</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 heapify operation.
These early versions were never designed to "wrap".</p>
<p>Wrapping any subclass of this class that is empty or contains only a single item will
result in heapified forms of empty and single item sketch respectively.
This is actually faster and consumes less overall memory.</p>
<p>This method checks if the given expectedSeed was used to create the source Memory image.
However, SerialVersion 1 sketches cannot be checked as they don't have a seedHash field,
so the resulting heapified CompactSketch will be given the hash of the expectedSeed.</p></div>
<dl>
<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>.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a CompactSketch backed by the given Memory except as above.</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"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../org/apache/datasketches/theta/Sketch.html#compact-boolean-org.apache.datasketches.memory.WritableMemory-">Sketch</a></code></span></div>
<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="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/apache/datasketches/theta/Sketch.html#compact-boolean-org.apache.datasketches.memory.WritableMemory-">compact</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/apache/datasketches/theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a></code></dd>
<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&nbsp;int&nbsp;getCompactBytes()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../org/apache/datasketches/theta/Sketch.html#getCompactBytes--">Sketch</a></code></span></div>
<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>Sketch.getCurrentBytes()</code></a>.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/apache/datasketches/theta/Sketch.html#getCompactBytes--">getCompactBytes</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/apache/datasketches/theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>number of compact bytes</dd>
</dl>
</li>
</ul>
<a name="getFamily--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFamily</h4>
<pre>public&nbsp;<a href="../../../../org/apache/datasketches/Family.html" title="enum in org.apache.datasketches">Family</a>&nbsp;getFamily()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../org/apache/datasketches/theta/Sketch.html#getFamily--">Sketch</a></code></span></div>
<div class="block">Returns the Family that this sketch belongs to</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/apache/datasketches/theta/Sketch.html#getFamily--">getFamily</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/apache/datasketches/theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the Family that this sketch belongs to</dd>
</dl>
</li>
</ul>
<a name="isCompact--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>isCompact</h4>
<pre>public&nbsp;boolean&nbsp;isCompact()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../org/apache/datasketches/theta/Sketch.html#isCompact--">Sketch</a></code></span></div>
<div class="block">Returns true if this sketch is in compact form.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/apache/datasketches/theta/Sketch.html#isCompact--">isCompact</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/apache/datasketches/theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if this sketch is in compact form.</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/CompactSketch.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/AnotB.html" title="class in org.apache.datasketches.theta"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/datasketches/theta/HashIterator.html" title="interface 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/CompactSketch.html" target="_top">Frames</a></li>
<li><a href="CompactSketch.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><a href="#constructor.summary">Constr</a>&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><a href="#constructor.detail">Constr</a>&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>