blob: c19ff5debb6bf94fb1f944d1c169fec1940c9d07 [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.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="Uses of Class org.apache.datasketches.theta.Sketch (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/Sketch.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/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>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h2 title="Uses of Class org.apache.datasketches.theta.Sketch" class="title">Uses of Class<br>org.apache.datasketches.theta.Sketch</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/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</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">org.apache.datasketches</a></td>
<td class="colLast">
<div class="block">This package is the parent package for all sketch algorithms.</div>
</td>
</tr>
<tr class="rowColor">
<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>
<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">
<!-- -->
</a>
<h3>Uses of <a href="../../../../../org/apache/datasketches/theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> in <a href="../../../../../org/apache/datasketches/package-summary.html">org.apache.datasketches</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/package-summary.html">org.apache.datasketches</a> with parameters of type <a href="../../../../../org/apache/datasketches/theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</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>double</code></td>
<td class="colLast"><span class="typeNameLabel">BoundsOnRatiosInTupleSketchedSets.</span><code><span class="memberNameLink"><a href="../../../../../org/apache/datasketches/BoundsOnRatiosInTupleSketchedSets.html#getEstimateOfBoverA-org.apache.datasketches.tuple.Sketch-org.apache.datasketches.theta.Sketch-">getEstimateOfBoverA</a></span>(<a href="../../../../../org/apache/datasketches/tuple/Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a>&lt;S&gt;&nbsp;sketchA,
<a href="../../../../../org/apache/datasketches/theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a>&nbsp;sketchB)</code>
<div class="block">Gets the estimate for B over A</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static double</code></td>
<td class="colLast"><span class="typeNameLabel">BoundsOnRatiosInThetaSketchedSets.</span><code><span class="memberNameLink"><a href="../../../../../org/apache/datasketches/BoundsOnRatiosInThetaSketchedSets.html#getEstimateOfBoverA-org.apache.datasketches.theta.Sketch-org.apache.datasketches.theta.Sketch-">getEstimateOfBoverA</a></span>(<a href="../../../../../org/apache/datasketches/theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a>&nbsp;sketchA,
<a href="../../../../../org/apache/datasketches/theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a>&nbsp;sketchB)</code>
<div class="block">Gets the estimate for B over A</div>
</td>
</tr>
<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>double</code></td>
<td class="colLast"><span class="typeNameLabel">BoundsOnRatiosInTupleSketchedSets.</span><code><span class="memberNameLink"><a href="../../../../../org/apache/datasketches/BoundsOnRatiosInTupleSketchedSets.html#getLowerBoundForBoverA-org.apache.datasketches.tuple.Sketch-org.apache.datasketches.theta.Sketch-">getLowerBoundForBoverA</a></span>(<a href="../../../../../org/apache/datasketches/tuple/Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a>&lt;S&gt;&nbsp;sketchA,
<a href="../../../../../org/apache/datasketches/theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a>&nbsp;sketchB)</code>
<div class="block">Gets the approximate lower bound for B over A based on a 95% confidence interval</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static double</code></td>
<td class="colLast"><span class="typeNameLabel">BoundsOnRatiosInThetaSketchedSets.</span><code><span class="memberNameLink"><a href="../../../../../org/apache/datasketches/BoundsOnRatiosInThetaSketchedSets.html#getLowerBoundForBoverA-org.apache.datasketches.theta.Sketch-org.apache.datasketches.theta.Sketch-">getLowerBoundForBoverA</a></span>(<a href="../../../../../org/apache/datasketches/theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a>&nbsp;sketchA,
<a href="../../../../../org/apache/datasketches/theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a>&nbsp;sketchB)</code>
<div class="block">Gets the approximate lower bound for B over A based on a 95% confidence interval</div>
</td>
</tr>
<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>double</code></td>
<td class="colLast"><span class="typeNameLabel">BoundsOnRatiosInTupleSketchedSets.</span><code><span class="memberNameLink"><a href="../../../../../org/apache/datasketches/BoundsOnRatiosInTupleSketchedSets.html#getUpperBoundForBoverA-org.apache.datasketches.tuple.Sketch-org.apache.datasketches.theta.Sketch-">getUpperBoundForBoverA</a></span>(<a href="../../../../../org/apache/datasketches/tuple/Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a>&lt;S&gt;&nbsp;sketchA,
<a href="../../../../../org/apache/datasketches/theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a>&nbsp;sketchB)</code>
<div class="block">Gets the approximate upper bound for B over A based on a 95% confidence interval</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static double</code></td>
<td class="colLast"><span class="typeNameLabel">BoundsOnRatiosInThetaSketchedSets.</span><code><span class="memberNameLink"><a href="../../../../../org/apache/datasketches/BoundsOnRatiosInThetaSketchedSets.html#getUpperBoundForBoverA-org.apache.datasketches.theta.Sketch-org.apache.datasketches.theta.Sketch-">getUpperBoundForBoverA</a></span>(<a href="../../../../../org/apache/datasketches/theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a>&nbsp;sketchA,
<a href="../../../../../org/apache/datasketches/theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a>&nbsp;sketchB)</code>
<div class="block">Gets the approximate upper bound for B over A based on a 95% confidence interval</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList"><a name="org.apache.datasketches.theta">
<!-- -->
</a>
<h3>Uses of <a href="../../../../../org/apache/datasketches/theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</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 subclasses, and an explanation">
<caption><span>Subclasses of <a href="../../../../../org/apache/datasketches/theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> in <a href="../../../../../org/apache/datasketches/theta/package-summary.html">org.apache.datasketches.theta</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Class and Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><code>class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/datasketches/theta/CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a></span></code>
<div class="block">The parent class of all the CompactSketches.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/datasketches/theta/UpdateSketch.html" title="class in org.apache.datasketches.theta">UpdateSketch</a></span></code>
<div class="block">The parent class for the Update Sketch families, such as QuickSelect and Alpha.</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> that return <a href="../../../../../org/apache/datasketches/theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</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 <a href="../../../../../org/apache/datasketches/theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a></code></td>
<td class="colLast"><span class="typeNameLabel">Sketch.</span><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 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"><span class="typeNameLabel">Sketch.</span><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 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"><span class="typeNameLabel">Sketches.</span><code><span class="memberNameLink"><a href="../../../../../org/apache/datasketches/theta/Sketches.html#heapifySketch-org.apache.datasketches.memory.Memory-">heapifySketch</a></span>(org.apache.datasketches.memory.Memory&nbsp;srcMem)</code>
<div class="block">Ref: <a href="../../../../../org/apache/datasketches/theta/Sketch.html#heapify-org.apache.datasketches.memory.Memory-"><code>Sketch.heapify(Memory)</code></a></div>
</td>
</tr>
<tr 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"><span class="typeNameLabel">Sketches.</span><code><span class="memberNameLink"><a href="../../../../../org/apache/datasketches/theta/Sketches.html#heapifySketch-org.apache.datasketches.memory.Memory-long-">heapifySketch</a></span>(org.apache.datasketches.memory.Memory&nbsp;srcMem,
long&nbsp;expectedSeed)</code>
<div class="block">Ref: <a href="../../../../../org/apache/datasketches/theta/Sketch.html#heapify-org.apache.datasketches.memory.Memory-long-"><code>Sketch.heapify(Memory, long)</code></a></div>
</td>
</tr>
<tr 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"><span class="typeNameLabel">Sketch.</span><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 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"><span class="typeNameLabel">Sketch.</span><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>
<tr 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"><span class="typeNameLabel">Sketches.</span><code><span class="memberNameLink"><a href="../../../../../org/apache/datasketches/theta/Sketches.html#wrapSketch-org.apache.datasketches.memory.Memory-">wrapSketch</a></span>(org.apache.datasketches.memory.Memory&nbsp;srcMem)</code>
<div class="block">Ref: <a href="../../../../../org/apache/datasketches/theta/Sketch.html#wrap-org.apache.datasketches.memory.Memory-"><code>Sketch.wrap(Memory)</code></a></div>
</td>
</tr>
<tr 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"><span class="typeNameLabel">Sketches.</span><code><span class="memberNameLink"><a href="../../../../../org/apache/datasketches/theta/Sketches.html#wrapSketch-org.apache.datasketches.memory.Memory-long-">wrapSketch</a></span>(org.apache.datasketches.memory.Memory&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>Sketch.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/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</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/CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a></code></td>
<td class="colLast"><span class="typeNameLabel">AnotB.</span><code><span class="memberNameLink"><a href="../../../../../org/apache/datasketches/theta/AnotB.html#aNotB-org.apache.datasketches.theta.Sketch-org.apache.datasketches.theta.Sketch-">aNotB</a></span>(<a href="../../../../../org/apache/datasketches/theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a>&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">Perform A-and-not-B set operation on the two given sketches and return the result as an
ordered CompactSketch on the heap.</div>
</td>
</tr>
<tr 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"><span class="typeNameLabel">PairwiseSetOperations.</span><code><span class="memberNameLink"><a href="../../../../../org/apache/datasketches/theta/PairwiseSetOperations.html#aNotB-org.apache.datasketches.theta.Sketch-org.apache.datasketches.theta.Sketch-">aNotB</a></span>(<a href="../../../../../org/apache/datasketches/theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a>&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"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<div class="block"><span class="deprecationComment">v2.0.0. Use <a href="../../../../../org/apache/datasketches/theta/AnotB.html#aNotB-org.apache.datasketches.theta.Sketch-org.apache.datasketches.theta.Sketch-"><code>AnotB.aNotB(Sketch, Sketch)</code></a> instead, which has more
complete seed handling.</span></div>
</div>
</td>
</tr>
<tr 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"><span class="typeNameLabel">AnotB.</span><code><span class="memberNameLink"><a href="../../../../../org/apache/datasketches/theta/AnotB.html#aNotB-org.apache.datasketches.theta.Sketch-org.apache.datasketches.theta.Sketch-boolean-org.apache.datasketches.memory.WritableMemory-">aNotB</a></span>(<a href="../../../../../org/apache/datasketches/theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a>&nbsp;skA,
<a href="../../../../../org/apache/datasketches/theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a>&nbsp;skB,
boolean&nbsp;dstOrdered,
org.apache.datasketches.memory.WritableMemory&nbsp;dstMem)</code>
<div class="block">Perform A-and-not-B set operation on the two given sketches and return the result as a
CompactSketch.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static boolean</code></td>
<td class="colLast"><span class="typeNameLabel">JaccardSimilarity.</span><code><span class="memberNameLink"><a href="../../../../../org/apache/datasketches/theta/JaccardSimilarity.html#dissimilarityTest-org.apache.datasketches.theta.Sketch-org.apache.datasketches.theta.Sketch-double-">dissimilarityTest</a></span>(<a href="../../../../../org/apache/datasketches/theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a>&nbsp;measured,
<a href="../../../../../org/apache/datasketches/theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a>&nbsp;expected,
double&nbsp;threshold)</code>
<div class="block">Tests dissimilarity of a measured Sketch against an expected Sketch.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static boolean</code></td>
<td class="colLast"><span class="typeNameLabel">JaccardSimilarity.</span><code><span class="memberNameLink"><a href="../../../../../org/apache/datasketches/theta/JaccardSimilarity.html#exactlyEqual-org.apache.datasketches.theta.Sketch-org.apache.datasketches.theta.Sketch-">exactlyEqual</a></span>(<a href="../../../../../org/apache/datasketches/theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a>&nbsp;sketchA,
<a href="../../../../../org/apache/datasketches/theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a>&nbsp;sketchB)</code>
<div class="block">Returns true if the two given sketches have exactly the same hash values and the same
theta values.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>abstract void</code></td>
<td class="colLast"><span class="typeNameLabel">Intersection.</span><code><span class="memberNameLink"><a href="../../../../../org/apache/datasketches/theta/Intersection.html#intersect-org.apache.datasketches.theta.Sketch-">intersect</a></span>(<a href="../../../../../org/apache/datasketches/theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a>&nbsp;sketchIn)</code>
<div class="block">Intersect the given sketch with the internal state.</div>
</td>
</tr>
<tr 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"><span class="typeNameLabel">Intersection.</span><code><span class="memberNameLink"><a href="../../../../../org/apache/datasketches/theta/Intersection.html#intersect-org.apache.datasketches.theta.Sketch-org.apache.datasketches.theta.Sketch-">intersect</a></span>(<a href="../../../../../org/apache/datasketches/theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a>&nbsp;a,
<a href="../../../../../org/apache/datasketches/theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a>&nbsp;b)</code>
<div class="block">Perform intersect set operation on the two given sketch arguments and return the result as an
ordered CompactSketch on the heap.</div>
</td>
</tr>
<tr 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"><span class="typeNameLabel">PairwiseSetOperations.</span><code><span class="memberNameLink"><a href="../../../../../org/apache/datasketches/theta/PairwiseSetOperations.html#intersect-org.apache.datasketches.theta.Sketch-org.apache.datasketches.theta.Sketch-">intersect</a></span>(<a href="../../../../../org/apache/datasketches/theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a>&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"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<div class="block"><span class="deprecationComment">v2.0.0. Use <a href="../../../../../org/apache/datasketches/theta/Intersection.html#intersect-org.apache.datasketches.theta.Sketch-org.apache.datasketches.theta.Sketch-"><code>Intersection.intersect(Sketch, Sketch)</code></a> instead, which has more
complete seed handling.</span></div>
</div>
</td>
</tr>
<tr 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"><span class="typeNameLabel">Intersection.</span><code><span class="memberNameLink"><a href="../../../../../org/apache/datasketches/theta/Intersection.html#intersect-org.apache.datasketches.theta.Sketch-org.apache.datasketches.theta.Sketch-boolean-org.apache.datasketches.memory.WritableMemory-">intersect</a></span>(<a href="../../../../../org/apache/datasketches/theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a>&nbsp;a,
<a href="../../../../../org/apache/datasketches/theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a>&nbsp;b,
boolean&nbsp;dstOrdered,
org.apache.datasketches.memory.WritableMemory&nbsp;dstMem)</code>
<div class="block">Perform intersect set operation on the two given sketches and return the result as a
CompactSketch.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static double[]</code></td>
<td class="colLast"><span class="typeNameLabel">JaccardSimilarity.</span><code><span class="memberNameLink"><a href="../../../../../org/apache/datasketches/theta/JaccardSimilarity.html#jaccard-org.apache.datasketches.theta.Sketch-org.apache.datasketches.theta.Sketch-">jaccard</a></span>(<a href="../../../../../org/apache/datasketches/theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a>&nbsp;sketchA,
<a href="../../../../../org/apache/datasketches/theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a>&nbsp;sketchB)</code>
<div class="block">Computes the Jaccard similarity index with upper and lower bounds.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>abstract void</code></td>
<td class="colLast"><span class="typeNameLabel">AnotB.</span><code><span class="memberNameLink"><a href="../../../../../org/apache/datasketches/theta/AnotB.html#notB-org.apache.datasketches.theta.Sketch-">notB</a></span>(<a href="../../../../../org/apache/datasketches/theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a>&nbsp;skB)</code>
<div class="block">This is part of a multistep, stateful AnotB operation and sets the given Theta sketch as the
second (or <i>n+1</i>th) argument <i>B</i> of <i>A-AND-NOT-B</i>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>abstract void</code></td>
<td class="colLast"><span class="typeNameLabel">AnotB.</span><code><span class="memberNameLink"><a href="../../../../../org/apache/datasketches/theta/AnotB.html#setA-org.apache.datasketches.theta.Sketch-">setA</a></span>(<a href="../../../../../org/apache/datasketches/theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a>&nbsp;skA)</code>
<div class="block">This is part of a multistep, stateful AnotB operation and sets the given Theta sketch as the
first argument <i>A</i> of <i>A-AND-NOT-B</i>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static boolean</code></td>
<td class="colLast"><span class="typeNameLabel">JaccardSimilarity.</span><code><span class="memberNameLink"><a href="../../../../../org/apache/datasketches/theta/JaccardSimilarity.html#similarityTest-org.apache.datasketches.theta.Sketch-org.apache.datasketches.theta.Sketch-double-">similarityTest</a></span>(<a href="../../../../../org/apache/datasketches/theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a>&nbsp;measured,
<a href="../../../../../org/apache/datasketches/theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a>&nbsp;expected,
double&nbsp;threshold)</code>
<div class="block">Tests similarity of a measured Sketch against an expected Sketch.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>abstract void</code></td>
<td class="colLast"><span class="typeNameLabel">Union.</span><code><span class="memberNameLink"><a href="../../../../../org/apache/datasketches/theta/Union.html#union-org.apache.datasketches.theta.Sketch-">union</a></span>(<a href="../../../../../org/apache/datasketches/theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a>&nbsp;sketchIn)</code>
<div class="block">Perform a Union operation with <i>this</i> union and the given on-heap sketch of the Theta Family.</div>
</td>
</tr>
<tr 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"><span class="typeNameLabel">Union.</span><code><span class="memberNameLink"><a href="../../../../../org/apache/datasketches/theta/Union.html#union-org.apache.datasketches.theta.Sketch-org.apache.datasketches.theta.Sketch-">union</a></span>(<a href="../../../../../org/apache/datasketches/theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a>&nbsp;sketchA,
<a href="../../../../../org/apache/datasketches/theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a>&nbsp;sketchB)</code>
<div class="block">This implements a stateless, pair-wise union operation.</div>
</td>
</tr>
<tr 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"><span class="typeNameLabel">Union.</span><code><span class="memberNameLink"><a href="../../../../../org/apache/datasketches/theta/Union.html#union-org.apache.datasketches.theta.Sketch-org.apache.datasketches.theta.Sketch-boolean-org.apache.datasketches.memory.WritableMemory-">union</a></span>(<a href="../../../../../org/apache/datasketches/theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a>&nbsp;sketchA,
<a href="../../../../../org/apache/datasketches/theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a>&nbsp;sketchB,
boolean&nbsp;dstOrdered,
org.apache.datasketches.memory.WritableMemory&nbsp;dstMem)</code>
<div class="block">This implements a stateless, pair-wise union operation.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList"><a name="org.apache.datasketches.tuple">
<!-- -->
</a>
<h3>Uses of <a href="../../../../../org/apache/datasketches/theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</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> with parameters of type <a href="../../../../../org/apache/datasketches/theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</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>boolean</code></td>
<td class="colLast"><span class="typeNameLabel">JaccardSimilarity.</span><code><span class="memberNameLink"><a href="../../../../../org/apache/datasketches/tuple/JaccardSimilarity.html#dissimilarityTest-org.apache.datasketches.tuple.Sketch-org.apache.datasketches.theta.Sketch-S-org.apache.datasketches.tuple.SummarySetOperations-double-">dissimilarityTest</a></span>(<a href="../../../../../org/apache/datasketches/tuple/Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a>&lt;S&gt;&nbsp;measured,
<a href="../../../../../org/apache/datasketches/theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a>&nbsp;expected,
S&nbsp;summary,
<a href="../../../../../org/apache/datasketches/tuple/SummarySetOperations.html" title="interface in org.apache.datasketches.tuple">SummarySetOperations</a>&lt;S&gt;&nbsp;summarySetOps,
double&nbsp;threshold)</code>
<div class="block">Tests dissimilarity of a measured Sketch against an expected Sketch.</div>
</td>
</tr>
<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>boolean</code></td>
<td class="colLast"><span class="typeNameLabel">JaccardSimilarity.</span><code><span class="memberNameLink"><a href="../../../../../org/apache/datasketches/tuple/JaccardSimilarity.html#exactlyEqual-org.apache.datasketches.tuple.Sketch-org.apache.datasketches.theta.Sketch-S-org.apache.datasketches.tuple.SummarySetOperations-">exactlyEqual</a></span>(<a href="../../../../../org/apache/datasketches/tuple/Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a>&lt;S&gt;&nbsp;sketchA,
<a href="../../../../../org/apache/datasketches/theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a>&nbsp;sketchB,
S&nbsp;summary,
<a href="../../../../../org/apache/datasketches/tuple/SummarySetOperations.html" title="interface in org.apache.datasketches.tuple">SummarySetOperations</a>&lt;S&gt;&nbsp;summarySetOps)</code>
<div class="block">Returns true if the two given sketches have exactly the same hash values and the same
theta values.</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.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="altColor">
<td class="colFirst"><code>void</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.theta.Sketch-S-">intersect</a></span>(<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">Performs a stateful intersection of the internal set with the given thetaSketch by combining entries
using the hashes from the theta sketch and summary values from the given summary and rules
from the summarySetOps defined by the Intersection constructor.</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>double[]</code></td>
<td class="colLast"><span class="typeNameLabel">JaccardSimilarity.</span><code><span class="memberNameLink"><a href="../../../../../org/apache/datasketches/tuple/JaccardSimilarity.html#jaccard-org.apache.datasketches.tuple.Sketch-org.apache.datasketches.theta.Sketch-S-org.apache.datasketches.tuple.SummarySetOperations-">jaccard</a></span>(<a href="../../../../../org/apache/datasketches/tuple/Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a>&lt;S&gt;&nbsp;sketchA,
<a href="../../../../../org/apache/datasketches/theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a>&nbsp;sketchB,
S&nbsp;summary,
<a href="../../../../../org/apache/datasketches/tuple/SummarySetOperations.html" title="interface in org.apache.datasketches.tuple">SummarySetOperations</a>&lt;S&gt;&nbsp;summarySetOps)</code>
<div class="block">Computes the Jaccard similarity index with upper and lower bounds.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><span class="typeNameLabel">AnotB.</span><code><span class="memberNameLink"><a href="../../../../../org/apache/datasketches/tuple/AnotB.html#notB-org.apache.datasketches.theta.Sketch-">notB</a></span>(<a href="../../../../../org/apache/datasketches/theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a>&nbsp;skB)</code>
<div class="block">This is part of a multistep, stateful AnotB operation and sets the given Theta sketch as the
second (or <i>n+1</i>th) argument <i>B</i> of <i>A-AND-NOT-B</i>.</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>boolean</code></td>
<td class="colLast"><span class="typeNameLabel">JaccardSimilarity.</span><code><span class="memberNameLink"><a href="../../../../../org/apache/datasketches/tuple/JaccardSimilarity.html#similarityTest-org.apache.datasketches.tuple.Sketch-org.apache.datasketches.theta.Sketch-S-org.apache.datasketches.tuple.SummarySetOperations-double-">similarityTest</a></span>(<a href="../../../../../org/apache/datasketches/tuple/Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a>&lt;S&gt;&nbsp;measured,
<a href="../../../../../org/apache/datasketches/theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a>&nbsp;expected,
S&nbsp;summary,
<a href="../../../../../org/apache/datasketches/tuple/SummarySetOperations.html" title="interface in org.apache.datasketches.tuple">SummarySetOperations</a>&lt;S&gt;&nbsp;summarySetOps,
double&nbsp;threshold)</code>
<div class="block">Tests similarity of a measured Sketch against an expected Sketch.</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>
<tr class="rowColor">
<td class="colFirst"><code>void</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.theta.Sketch-S-">union</a></span>(<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">Performs a stateful union of the internal set with the given thetaSketch by combining entries
using the hashes from the theta sketch and summary values from the given summary.</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/Sketch.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/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>
<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>