blob: 66be5a7b6f3cdedb4076121efcd06a831a1793bc [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.tuple.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="Uses of Class org.apache.datasketches.tuple.CompactSketch (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/tuple/CompactSketch.html" title="class in org.apache.datasketches.tuple">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/tuple/class-use/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>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h2 title="Uses of Class org.apache.datasketches.tuple.CompactSketch" class="title">Uses of Class<br>org.apache.datasketches.tuple.CompactSketch</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/tuple/CompactSketch.html" title="class in org.apache.datasketches.tuple">CompactSketch</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.tuple">org.apache.datasketches.tuple</a></td>
<td class="colLast">
<div class="block">The tuple package contains implementation of sketches based on the idea of
theta sketches with the addition of values associated with unique keys.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<ul class="blockList">
<li class="blockList"><a name="org.apache.datasketches.tuple">
<!-- -->
</a>
<h3>Uses of <a href="../../../../../org/apache/datasketches/tuple/CompactSketch.html" title="class in org.apache.datasketches.tuple">CompactSketch</a> in <a href="../../../../../org/apache/datasketches/tuple/package-summary.html">org.apache.datasketches.tuple</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/tuple/package-summary.html">org.apache.datasketches.tuple</a> that return <a href="../../../../../org/apache/datasketches/tuple/CompactSketch.html" title="class in org.apache.datasketches.tuple">CompactSketch</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>static &lt;S extends <a href="../../../../../org/apache/datasketches/tuple/Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>&gt;<br><a href="../../../../../org/apache/datasketches/tuple/CompactSketch.html" title="class in org.apache.datasketches.tuple">CompactSketch</a>&lt;S&gt;</code></td>
<td class="colLast"><span class="typeNameLabel">AnotB.</span><code><span class="memberNameLink"><a href="../../../../../org/apache/datasketches/tuple/AnotB.html#aNotB-org.apache.datasketches.tuple.Sketch-org.apache.datasketches.theta.Sketch-">aNotB</a></span>(<a href="../../../../../org/apache/datasketches/tuple/Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a>&lt;S&gt;&nbsp;skA,
<a href="../../../../../org/apache/datasketches/theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a>&nbsp;skB)</code>
<div class="block">Returns the A-and-not-B set operation on a Tuple sketch and a Theta sketch.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static &lt;S extends <a href="../../../../../org/apache/datasketches/tuple/Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>&gt;<br><a href="../../../../../org/apache/datasketches/tuple/CompactSketch.html" title="class in org.apache.datasketches.tuple">CompactSketch</a>&lt;S&gt;</code></td>
<td class="colLast"><span class="typeNameLabel">AnotB.</span><code><span class="memberNameLink"><a href="../../../../../org/apache/datasketches/tuple/AnotB.html#aNotB-org.apache.datasketches.tuple.Sketch-org.apache.datasketches.tuple.Sketch-">aNotB</a></span>(<a href="../../../../../org/apache/datasketches/tuple/Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a>&lt;S&gt;&nbsp;skA,
<a href="../../../../../org/apache/datasketches/tuple/Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a>&lt;S&gt;&nbsp;skB)</code>
<div class="block">Returns the A-and-not-B set operation on the two given Tuple sketches.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>abstract <a href="../../../../../org/apache/datasketches/tuple/CompactSketch.html" title="class in org.apache.datasketches.tuple">CompactSketch</a>&lt;<a href="../../../../../org/apache/datasketches/tuple/Sketch.html" title="type parameter in Sketch">S</a>&gt;</code></td>
<td class="colLast"><span class="typeNameLabel">Sketch.</span><code><span class="memberNameLink"><a href="../../../../../org/apache/datasketches/tuple/Sketch.html#compact--">compact</a></span>()</code>
<div class="block">Converts this sketch to a CompactSketch on the Java heap.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/datasketches/tuple/CompactSketch.html" title="class in org.apache.datasketches.tuple">CompactSketch</a>&lt;<a href="../../../../../org/apache/datasketches/tuple/CompactSketch.html" title="type parameter in CompactSketch">S</a>&gt;</code></td>
<td class="colLast"><span class="typeNameLabel">CompactSketch.</span><code><span class="memberNameLink"><a href="../../../../../org/apache/datasketches/tuple/CompactSketch.html#compact--">compact</a></span>()</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/datasketches/tuple/CompactSketch.html" title="class in org.apache.datasketches.tuple">CompactSketch</a>&lt;<a href="../../../../../org/apache/datasketches/tuple/Filter.html" title="type parameter in Filter">T</a>&gt;</code></td>
<td class="colLast"><span class="typeNameLabel">Filter.</span><code><span class="memberNameLink"><a href="../../../../../org/apache/datasketches/tuple/Filter.html#filter-org.apache.datasketches.tuple.Sketch-">filter</a></span>(<a href="../../../../../org/apache/datasketches/tuple/Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a>&lt;<a href="../../../../../org/apache/datasketches/tuple/Filter.html" title="type parameter in Filter">T</a>&gt;&nbsp;sketchIn)</code>
<div class="block">Filters elements on the provided <a href="../../../../../org/apache/datasketches/tuple/Sketch.html" title="class in org.apache.datasketches.tuple"><code>Sketch</code></a></div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/datasketches/tuple/CompactSketch.html" title="class in org.apache.datasketches.tuple">CompactSketch</a>&lt;<a href="../../../../../org/apache/datasketches/tuple/Intersection.html" title="type parameter in Intersection">S</a>&gt;</code></td>
<td class="colLast"><span class="typeNameLabel">Intersection.</span><code><span class="memberNameLink"><a href="../../../../../org/apache/datasketches/tuple/Intersection.html#getResult--">getResult</a></span>()</code>
<div class="block">Gets the internal set as an unordered CompactSketch</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/datasketches/tuple/CompactSketch.html" title="class in org.apache.datasketches.tuple">CompactSketch</a>&lt;<a href="../../../../../org/apache/datasketches/tuple/Union.html" title="type parameter in Union">S</a>&gt;</code></td>
<td class="colLast"><span class="typeNameLabel">Union.</span><code><span class="memberNameLink"><a href="../../../../../org/apache/datasketches/tuple/Union.html#getResult--">getResult</a></span>()</code>
<div class="block">Gets the result of a sequence of stateful <i>union</i> operations as an unordered CompactSketch</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/datasketches/tuple/CompactSketch.html" title="class in org.apache.datasketches.tuple">CompactSketch</a>&lt;<a href="../../../../../org/apache/datasketches/tuple/AnotB.html" title="type parameter in AnotB">S</a>&gt;</code></td>
<td class="colLast"><span class="typeNameLabel">AnotB.</span><code><span class="memberNameLink"><a href="../../../../../org/apache/datasketches/tuple/AnotB.html#getResult-boolean-">getResult</a></span>(boolean&nbsp;reset)</code>
<div class="block">Gets the result of the multistep, stateful operation AnotB that have been executed with calls
to <a href="../../../../../org/apache/datasketches/tuple/AnotB.html#setA-org.apache.datasketches.tuple.Sketch-"><code>AnotB.setA(Sketch)</code></a> and (<a href="../../../../../org/apache/datasketches/tuple/AnotB.html#notB-org.apache.datasketches.theta.Sketch-"><code>AnotB.notB(Sketch)</code></a> or
<a href="../../../../../org/apache/datasketches/tuple/AnotB.html#notB-org.apache.datasketches.theta.Sketch-"><code>AnotB.notB(org.apache.datasketches.theta.Sketch)</code></a>).</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/datasketches/tuple/CompactSketch.html" title="class in org.apache.datasketches.tuple">CompactSketch</a>&lt;<a href="../../../../../org/apache/datasketches/tuple/Union.html" title="type parameter in Union">S</a>&gt;</code></td>
<td class="colLast"><span class="typeNameLabel">Union.</span><code><span class="memberNameLink"><a href="../../../../../org/apache/datasketches/tuple/Union.html#getResult-boolean-">getResult</a></span>(boolean&nbsp;reset)</code>
<div class="block">Gets the result of a sequence of stateful <i>union</i> operations as an unordered CompactSketch.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/datasketches/tuple/CompactSketch.html" title="class in org.apache.datasketches.tuple">CompactSketch</a>&lt;<a href="../../../../../org/apache/datasketches/tuple/Intersection.html" title="type parameter in Intersection">S</a>&gt;</code></td>
<td class="colLast"><span class="typeNameLabel">Intersection.</span><code><span class="memberNameLink"><a href="../../../../../org/apache/datasketches/tuple/Intersection.html#intersect-org.apache.datasketches.tuple.Sketch-org.apache.datasketches.tuple.Sketch-">intersect</a></span>(<a href="../../../../../org/apache/datasketches/tuple/Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a>&lt;<a href="../../../../../org/apache/datasketches/tuple/Intersection.html" title="type parameter in Intersection">S</a>&gt;&nbsp;tupleSketchA,
<a href="../../../../../org/apache/datasketches/tuple/Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a>&lt;<a href="../../../../../org/apache/datasketches/tuple/Intersection.html" title="type parameter in Intersection">S</a>&gt;&nbsp;tupleSketchB)</code>
<div class="block">Perform a stateless intersect set operation on the two given tuple sketches and returns the
result as an unordered CompactSketch on the heap.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/datasketches/tuple/CompactSketch.html" title="class in org.apache.datasketches.tuple">CompactSketch</a>&lt;<a href="../../../../../org/apache/datasketches/tuple/Intersection.html" title="type parameter in Intersection">S</a>&gt;</code></td>
<td class="colLast"><span class="typeNameLabel">Intersection.</span><code><span class="memberNameLink"><a href="../../../../../org/apache/datasketches/tuple/Intersection.html#intersect-org.apache.datasketches.tuple.Sketch-org.apache.datasketches.theta.Sketch-S-">intersect</a></span>(<a href="../../../../../org/apache/datasketches/tuple/Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a>&lt;<a href="../../../../../org/apache/datasketches/tuple/Intersection.html" title="type parameter in Intersection">S</a>&gt;&nbsp;tupleSketch,
<a href="../../../../../org/apache/datasketches/theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a>&nbsp;thetaSketch,
<a href="../../../../../org/apache/datasketches/tuple/Intersection.html" title="type parameter in Intersection">S</a>&nbsp;summary)</code>
<div class="block">Perform a stateless intersect set operation on a tuple sketch and a theta sketch and returns the
result as an unordered CompactSketch on the heap.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/datasketches/tuple/CompactSketch.html" title="class in org.apache.datasketches.tuple">CompactSketch</a>&lt;<a href="../../../../../org/apache/datasketches/tuple/Union.html" title="type parameter in Union">S</a>&gt;</code></td>
<td class="colLast"><span class="typeNameLabel">Union.</span><code><span class="memberNameLink"><a href="../../../../../org/apache/datasketches/tuple/Union.html#union-org.apache.datasketches.tuple.Sketch-org.apache.datasketches.tuple.Sketch-">union</a></span>(<a href="../../../../../org/apache/datasketches/tuple/Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a>&lt;<a href="../../../../../org/apache/datasketches/tuple/Union.html" title="type parameter in Union">S</a>&gt;&nbsp;tupleSketchA,
<a href="../../../../../org/apache/datasketches/tuple/Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a>&lt;<a href="../../../../../org/apache/datasketches/tuple/Union.html" title="type parameter in Union">S</a>&gt;&nbsp;tupleSketchB)</code>
<div class="block">Perform a stateless, pair-wise union operation between two tuple sketches.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/datasketches/tuple/CompactSketch.html" title="class in org.apache.datasketches.tuple">CompactSketch</a>&lt;<a href="../../../../../org/apache/datasketches/tuple/Union.html" title="type parameter in Union">S</a>&gt;</code></td>
<td class="colLast"><span class="typeNameLabel">Union.</span><code><span class="memberNameLink"><a href="../../../../../org/apache/datasketches/tuple/Union.html#union-org.apache.datasketches.tuple.Sketch-org.apache.datasketches.theta.Sketch-S-">union</a></span>(<a href="../../../../../org/apache/datasketches/tuple/Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a>&lt;<a href="../../../../../org/apache/datasketches/tuple/Union.html" title="type parameter in Union">S</a>&gt;&nbsp;tupleSketch,
<a href="../../../../../org/apache/datasketches/theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a>&nbsp;thetaSketch,
<a href="../../../../../org/apache/datasketches/tuple/Union.html" title="type parameter in Union">S</a>&nbsp;summary)</code>
<div class="block">Perform a stateless, pair-wise union operation between a tupleSketch and a thetaSketch.</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/tuple/CompactSketch.html" title="class in org.apache.datasketches.tuple">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/tuple/class-use/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>
<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>