Google Git
Sign in
apache / datasketches-website / 4e83e51533ab0e89e82946dca92a6cde8a66ded4 / . / api / java / snapshot / apidocs / org / apache / datasketches / theta / class-use / UpdateSketch.html
blob: d76249aad2a2e8e135c5f972c93dadeec1e2caa5 [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>Uses of Class org.apache.datasketches.theta.UpdateSketch (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="Uses of Class org.apache.datasketches.theta.UpdateSketch (datasketches-java 3.1.0 API)";
}
}
catch(err) {
}
//-->
</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><a href="../../../../../org/apache/datasketches/theta/UpdateSketch.html" title="class in org.apache.datasketches.theta">Class</a></li>
<li class="navBarCell1Rev">Use</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>Prev</li>
<li>Next</li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/datasketches/theta/class-use/UpdateSketch.html" target="_top">Frames</a></li>
<li><a href="UpdateSketch.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>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h2 title="Uses of Class org.apache.datasketches.theta.UpdateSketch" class="title">Uses of Class<br>org.apache.datasketches.theta.UpdateSketch</h2>
</div>
<div class="classUseContainer">
<ul class="blockList">
<li class="blockList">
<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation">
<caption><span>Packages that use <a href="../../../../../org/apache/datasketches/theta/UpdateSketch.html" title="class in org.apache.datasketches.theta">UpdateSketch</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Package</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="#org.apache.datasketches.theta">org.apache.datasketches.theta</a></td>
<td class="colLast">
<div class="block">The theta package contains all the sketch classes that are members of the
<a href="../../../../../resources/dictionary.html#thetaSketch">Theta Sketch Framework</a>.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<ul class="blockList">
<li class="blockList"><a name="org.apache.datasketches.theta">
<!-- -->
</a>
<h3>Uses of <a href="../../../../../org/apache/datasketches/theta/UpdateSketch.html" title="class in org.apache.datasketches.theta">UpdateSketch</a> in <a href="../../../../../org/apache/datasketches/theta/package-summary.html">org.apache.datasketches.theta</a></h3>
<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation">
<caption><span>Methods in <a href="../../../../../org/apache/datasketches/theta/package-summary.html">org.apache.datasketches.theta</a> that return <a href="../../../../../org/apache/datasketches/theta/UpdateSketch.html" title="class in org.apache.datasketches.theta">UpdateSketch</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/datasketches/theta/UpdateSketch.html" title="class in org.apache.datasketches.theta">UpdateSketch</a></code></td>
<td class="colLast"><span class="typeNameLabel">UpdateSketchBuilder.</span><code><span class="memberNameLink"><a href="../../../../../org/apache/datasketches/theta/UpdateSketchBuilder.html#build--">build</a></span>()</code>
<div class="block">Returns an UpdateSketch with the current configuration of this Builder.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/datasketches/theta/UpdateSketch.html" title="class in org.apache.datasketches.theta">UpdateSketch</a></code></td>
<td class="colLast"><span class="typeNameLabel">UpdateSketchBuilder.</span><code><span class="memberNameLink"><a href="../../../../../org/apache/datasketches/theta/UpdateSketchBuilder.html#build-org.apache.datasketches.memory.WritableMemory-">build</a></span>(org.apache.datasketches.memory.WritableMemory&nbsp;dstMem)</code>
<div class="block">Returns an UpdateSketch with the current configuration of this Builder
with the specified backing destination Memory store.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/datasketches/theta/UpdateSketch.html" title="class in org.apache.datasketches.theta">UpdateSketch</a></code></td>
<td class="colLast"><span class="typeNameLabel">UpdateSketchBuilder.</span><code><span class="memberNameLink"><a href="../../../../../org/apache/datasketches/theta/UpdateSketchBuilder.html#buildLocal-org.apache.datasketches.theta.UpdateSketch-">buildLocal</a></span>(<a href="../../../../../org/apache/datasketches/theta/UpdateSketch.html" title="class in org.apache.datasketches.theta">UpdateSketch</a>&nbsp;shared)</code>
<div class="block">Returns a local, on-heap, concurrent UpdateSketch to be used as a per-thread local buffer
along with the given concurrent shared UpdateSketch and the current configuration of this
Builder.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/datasketches/theta/UpdateSketch.html" title="class in org.apache.datasketches.theta">UpdateSketch</a></code></td>
<td class="colLast"><span class="typeNameLabel">UpdateSketchBuilder.</span><code><span class="memberNameLink"><a href="../../../../../org/apache/datasketches/theta/UpdateSketchBuilder.html#buildShared--">buildShared</a></span>()</code>
<div class="block">Returns an on-heap concurrent shared UpdateSketch with the current configuration of the
Builder.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/datasketches/theta/UpdateSketch.html" title="class in org.apache.datasketches.theta">UpdateSketch</a></code></td>
<td class="colLast"><span class="typeNameLabel">UpdateSketchBuilder.</span><code><span class="memberNameLink"><a href="../../../../../org/apache/datasketches/theta/UpdateSketchBuilder.html#buildShared-org.apache.datasketches.memory.WritableMemory-">buildShared</a></span>(org.apache.datasketches.memory.WritableMemory&nbsp;dstMem)</code>
<div class="block">Returns a direct (potentially off-heap) concurrent shared UpdateSketch with the current
configuration of the Builder and the given destination WritableMemory.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/datasketches/theta/UpdateSketch.html" title="class in org.apache.datasketches.theta">UpdateSketch</a></code></td>
<td class="colLast"><span class="typeNameLabel">UpdateSketchBuilder.</span><code><span class="memberNameLink"><a href="../../../../../org/apache/datasketches/theta/UpdateSketchBuilder.html#buildSharedFromSketch-org.apache.datasketches.theta.UpdateSketch-org.apache.datasketches.memory.WritableMemory-">buildSharedFromSketch</a></span>(<a href="../../../../../org/apache/datasketches/theta/UpdateSketch.html" title="class in org.apache.datasketches.theta">UpdateSketch</a>&nbsp;sketch,
org.apache.datasketches.memory.WritableMemory&nbsp;dstMem)</code>
<div class="block">Returns a direct (potentially off-heap) concurrent shared UpdateSketch with the current
configuration of the Builder, the data from the given sketch, and the given destination
WritableMemory.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../../../org/apache/datasketches/theta/UpdateSketch.html" title="class in org.apache.datasketches.theta">UpdateSketch</a></code></td>
<td class="colLast"><span class="typeNameLabel">UpdateSketch.</span><code><span class="memberNameLink"><a href="../../../../../org/apache/datasketches/theta/UpdateSketch.html#heapify-org.apache.datasketches.memory.Memory-">heapify</a></span>(org.apache.datasketches.memory.Memory&nbsp;srcMem)</code>
<div class="block">Instantiates an on-heap UpdateSketch from Memory.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../../../../org/apache/datasketches/theta/UpdateSketch.html" title="class in org.apache.datasketches.theta">UpdateSketch</a></code></td>
<td class="colLast"><span class="typeNameLabel">UpdateSketch.</span><code><span class="memberNameLink"><a href="../../../../../org/apache/datasketches/theta/UpdateSketch.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">Instantiates an on-heap UpdateSketch from Memory.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../../../org/apache/datasketches/theta/UpdateSketch.html" title="class in org.apache.datasketches.theta">UpdateSketch</a></code></td>
<td class="colLast"><span class="typeNameLabel">Sketches.</span><code><span class="memberNameLink"><a href="../../../../../org/apache/datasketches/theta/Sketches.html#heapifyUpdateSketch-org.apache.datasketches.memory.Memory-">heapifyUpdateSketch</a></span>(org.apache.datasketches.memory.Memory&nbsp;srcMem)</code>
<div class="block">Ref: <a href="../../../../../org/apache/datasketches/theta/UpdateSketch.html#heapify-org.apache.datasketches.memory.Memory-"><code>UpdateSketch.heapify(Memory)</code></a></div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../../../../org/apache/datasketches/theta/UpdateSketch.html" title="class in org.apache.datasketches.theta">UpdateSketch</a></code></td>
<td class="colLast"><span class="typeNameLabel">Sketches.</span><code><span class="memberNameLink"><a href="../../../../../org/apache/datasketches/theta/Sketches.html#heapifyUpdateSketch-org.apache.datasketches.memory.Memory-long-">heapifyUpdateSketch</a></span>(org.apache.datasketches.memory.Memory&nbsp;srcMem,
long&nbsp;expectedSeed)</code>
<div class="block">Ref: <a href="../../../../../org/apache/datasketches/theta/UpdateSketch.html#heapify-org.apache.datasketches.memory.Memory-long-"><code>UpdateSketch.heapify(Memory, long)</code></a></div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>abstract <a href="../../../../../org/apache/datasketches/theta/UpdateSketch.html" title="class in org.apache.datasketches.theta">UpdateSketch</a></code></td>
<td class="colLast"><span class="typeNameLabel">UpdateSketch.</span><code><span class="memberNameLink"><a href="../../../../../org/apache/datasketches/theta/UpdateSketch.html#rebuild--">rebuild</a></span>()</code>
<div class="block">Rebuilds the hash table to remove dirty values or to reduce the size
to nominal entries.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../../../../org/apache/datasketches/theta/UpdateSketch.html" title="class in org.apache.datasketches.theta">UpdateSketch</a></code></td>
<td class="colLast"><span class="typeNameLabel">UpdateSketch.</span><code><span class="memberNameLink"><a href="../../../../../org/apache/datasketches/theta/UpdateSketch.html#wrap-org.apache.datasketches.memory.WritableMemory-">wrap</a></span>(org.apache.datasketches.memory.WritableMemory&nbsp;srcMem)</code>
<div class="block">Wrap takes the sketch image in Memory and refers to it directly.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../../../org/apache/datasketches/theta/UpdateSketch.html" title="class in org.apache.datasketches.theta">UpdateSketch</a></code></td>
<td class="colLast"><span class="typeNameLabel">UpdateSketch.</span><code><span class="memberNameLink"><a href="../../../../../org/apache/datasketches/theta/UpdateSketch.html#wrap-org.apache.datasketches.memory.WritableMemory-long-">wrap</a></span>(org.apache.datasketches.memory.WritableMemory&nbsp;srcMem,
long&nbsp;expectedSeed)</code>
<div class="block">Wrap takes the sketch image in Memory and refers to it directly.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../../../../org/apache/datasketches/theta/UpdateSketch.html" title="class in org.apache.datasketches.theta">UpdateSketch</a></code></td>
<td class="colLast"><span class="typeNameLabel">Sketches.</span><code><span class="memberNameLink"><a href="../../../../../org/apache/datasketches/theta/Sketches.html#wrapUpdateSketch-org.apache.datasketches.memory.WritableMemory-">wrapUpdateSketch</a></span>(org.apache.datasketches.memory.WritableMemory&nbsp;srcMem)</code>
<div class="block">Ref: <a href="../../../../../org/apache/datasketches/theta/Sketch.html#wrap-org.apache.datasketches.memory.Memory-"><code>UpdateSketch.wrap(Memory)</code></a></div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../../../org/apache/datasketches/theta/UpdateSketch.html" title="class in org.apache.datasketches.theta">UpdateSketch</a></code></td>
<td class="colLast"><span class="typeNameLabel">Sketches.</span><code><span class="memberNameLink"><a href="../../../../../org/apache/datasketches/theta/Sketches.html#wrapUpdateSketch-org.apache.datasketches.memory.WritableMemory-long-">wrapUpdateSketch</a></span>(org.apache.datasketches.memory.WritableMemory&nbsp;srcMem,
long&nbsp;expectedSeed)</code>
<div class="block">Ref: <a href="../../../../../org/apache/datasketches/theta/Sketch.html#wrap-org.apache.datasketches.memory.Memory-long-"><code>UpdateSketch.wrap(Memory, long)</code></a></div>
</td>
</tr>
</tbody>
</table>
<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation">
<caption><span>Methods in <a href="../../../../../org/apache/datasketches/theta/package-summary.html">org.apache.datasketches.theta</a> with parameters of type <a href="../../../../../org/apache/datasketches/theta/UpdateSketch.html" title="class in org.apache.datasketches.theta">UpdateSketch</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/datasketches/theta/UpdateSketch.html" title="class in org.apache.datasketches.theta">UpdateSketch</a></code></td>
<td class="colLast"><span class="typeNameLabel">UpdateSketchBuilder.</span><code><span class="memberNameLink"><a href="../../../../../org/apache/datasketches/theta/UpdateSketchBuilder.html#buildLocal-org.apache.datasketches.theta.UpdateSketch-">buildLocal</a></span>(<a href="../../../../../org/apache/datasketches/theta/UpdateSketch.html" title="class in org.apache.datasketches.theta">UpdateSketch</a>&nbsp;shared)</code>
<div class="block">Returns a local, on-heap, concurrent UpdateSketch to be used as a per-thread local buffer
along with the given concurrent shared UpdateSketch and the current configuration of this
Builder.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/datasketches/theta/UpdateSketch.html" title="class in org.apache.datasketches.theta">UpdateSketch</a></code></td>
<td class="colLast"><span class="typeNameLabel">UpdateSketchBuilder.</span><code><span class="memberNameLink"><a href="../../../../../org/apache/datasketches/theta/UpdateSketchBuilder.html#buildSharedFromSketch-org.apache.datasketches.theta.UpdateSketch-org.apache.datasketches.memory.WritableMemory-">buildSharedFromSketch</a></span>(<a href="../../../../../org/apache/datasketches/theta/UpdateSketch.html" title="class in org.apache.datasketches.theta">UpdateSketch</a>&nbsp;sketch,
org.apache.datasketches.memory.WritableMemory&nbsp;dstMem)</code>
<div class="block">Returns a direct (potentially off-heap) concurrent shared UpdateSketch with the current
configuration of the Builder, the data from the given sketch, and the given destination
WritableMemory.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
</li>
</ul>
</div>
<!-- ======= 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><a href="../../../../../org/apache/datasketches/theta/UpdateSketch.html" title="class in org.apache.datasketches.theta">Class</a></li>
<li class="navBarCell1Rev">Use</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>Prev</li>
<li>Next</li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/datasketches/theta/class-use/UpdateSketch.html" target="_top">Frames</a></li>
<li><a href="UpdateSketch.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>
<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>