blob: efdc13f1512536b6bef92a362a6e559cd299e7b6 [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_162) on Thu Oct 25 17:06:11 PDT 2018 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Uses of Class com.yahoo.sketches.theta.Sketch (com.yahoo.datasketches:sketches-core 0.12.1-SNAPSHOT API)</title>
<meta name="date" content="2018-10-25">
<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 com.yahoo.sketches.theta.Sketch (com.yahoo.datasketches:sketches-core 0.12.1-SNAPSHOT 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="../../../../../com/yahoo/sketches/theta/Sketch.html" title="class in com.yahoo.sketches.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?com/yahoo/sketches/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 com.yahoo.sketches.theta.Sketch" class="title">Uses of Class<br>com.yahoo.sketches.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="../../../../../com/yahoo/sketches/theta/Sketch.html" title="class in com.yahoo.sketches.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="#com.yahoo.sketches">com.yahoo.sketches</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="#com.yahoo.sketches.theta">com.yahoo.sketches.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="com.yahoo.sketches">
<!-- -->
</a>
<h3>Uses of <a href="../../../../../com/yahoo/sketches/theta/Sketch.html" title="class in com.yahoo.sketches.theta">Sketch</a> in <a href="../../../../../com/yahoo/sketches/package-summary.html">com.yahoo.sketches</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="../../../../../com/yahoo/sketches/package-summary.html">com.yahoo.sketches</a> with parameters of type <a href="../../../../../com/yahoo/sketches/theta/Sketch.html" title="class in com.yahoo.sketches.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 double</code></td>
<td class="colLast"><span class="typeNameLabel">BoundsOnRatiosInThetaSketchedSets.</span><code><span class="memberNameLink"><a href="../../../../../com/yahoo/sketches/BoundsOnRatiosInThetaSketchedSets.html#getEstimateOfBoverA-com.yahoo.sketches.theta.Sketch-com.yahoo.sketches.theta.Sketch-">getEstimateOfBoverA</a></span>(<a href="../../../../../com/yahoo/sketches/theta/Sketch.html" title="class in com.yahoo.sketches.theta">Sketch</a>&nbsp;sketchA,
<a href="../../../../../com/yahoo/sketches/theta/Sketch.html" title="class in com.yahoo.sketches.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="../../../../../com/yahoo/sketches/BoundsOnRatiosInThetaSketchedSets.html#getLowerBoundForBoverA-com.yahoo.sketches.theta.Sketch-com.yahoo.sketches.theta.Sketch-">getLowerBoundForBoverA</a></span>(<a href="../../../../../com/yahoo/sketches/theta/Sketch.html" title="class in com.yahoo.sketches.theta">Sketch</a>&nbsp;sketchA,
<a href="../../../../../com/yahoo/sketches/theta/Sketch.html" title="class in com.yahoo.sketches.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 double</code></td>
<td class="colLast"><span class="typeNameLabel">BoundsOnRatiosInThetaSketchedSets.</span><code><span class="memberNameLink"><a href="../../../../../com/yahoo/sketches/BoundsOnRatiosInThetaSketchedSets.html#getUpperBoundForBoverA-com.yahoo.sketches.theta.Sketch-com.yahoo.sketches.theta.Sketch-">getUpperBoundForBoverA</a></span>(<a href="../../../../../com/yahoo/sketches/theta/Sketch.html" title="class in com.yahoo.sketches.theta">Sketch</a>&nbsp;sketchA,
<a href="../../../../../com/yahoo/sketches/theta/Sketch.html" title="class in com.yahoo.sketches.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="com.yahoo.sketches.theta">
<!-- -->
</a>
<h3>Uses of <a href="../../../../../com/yahoo/sketches/theta/Sketch.html" title="class in com.yahoo.sketches.theta">Sketch</a> in <a href="../../../../../com/yahoo/sketches/theta/package-summary.html">com.yahoo.sketches.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="../../../../../com/yahoo/sketches/theta/Sketch.html" title="class in com.yahoo.sketches.theta">Sketch</a> in <a href="../../../../../com/yahoo/sketches/theta/package-summary.html">com.yahoo.sketches.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="../../../../../com/yahoo/sketches/theta/CompactSketch.html" title="class in com.yahoo.sketches.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="../../../../../com/yahoo/sketches/theta/SingleItemSketch.html" title="class in com.yahoo.sketches.theta">SingleItemSketch</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/yahoo/sketches/theta/UpdateSketch.html" title="class in com.yahoo.sketches.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="../../../../../com/yahoo/sketches/theta/package-summary.html">com.yahoo.sketches.theta</a> that return <a href="../../../../../com/yahoo/sketches/theta/Sketch.html" title="class in com.yahoo.sketches.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="../../../../../com/yahoo/sketches/theta/Sketch.html" title="class in com.yahoo.sketches.theta">Sketch</a></code></td>
<td class="colLast"><span class="typeNameLabel">Sketch.</span><code><span class="memberNameLink"><a href="../../../../../com/yahoo/sketches/theta/Sketch.html#heapify-com.yahoo.memory.Memory-">heapify</a></span>(com.yahoo.memory.Memory&nbsp;srcMem)</code>
<div class="block">Heapify takes the sketch image in Memory and instantiates an on-heap
Sketch using the
<a href="../../../../../resources/dictionary.html#defaultUpdateSeed">Default Update Seed</a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../../../../com/yahoo/sketches/theta/Sketch.html" title="class in com.yahoo.sketches.theta">Sketch</a></code></td>
<td class="colLast"><span class="typeNameLabel">Sketch.</span><code><span class="memberNameLink"><a href="../../../../../com/yahoo/sketches/theta/Sketch.html#heapify-com.yahoo.memory.Memory-long-">heapify</a></span>(com.yahoo.memory.Memory&nbsp;srcMem,
long&nbsp;seed)</code>
<div class="block">Heapify takes the sketch image in Memory and instantiates an on-heap
Sketch using the given seed.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../../../com/yahoo/sketches/theta/Sketch.html" title="class in com.yahoo.sketches.theta">Sketch</a></code></td>
<td class="colLast"><span class="typeNameLabel">Sketches.</span><code><span class="memberNameLink"><a href="../../../../../com/yahoo/sketches/theta/Sketches.html#heapifySketch-com.yahoo.memory.Memory-">heapifySketch</a></span>(com.yahoo.memory.Memory&nbsp;srcMem)</code>
<div class="block">Ref: <a href="../../../../../com/yahoo/sketches/theta/Sketch.html#heapify-com.yahoo.memory.Memory-"><code>Sketch.heapify(Memory)</code></a></div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../../../../com/yahoo/sketches/theta/Sketch.html" title="class in com.yahoo.sketches.theta">Sketch</a></code></td>
<td class="colLast"><span class="typeNameLabel">Sketches.</span><code><span class="memberNameLink"><a href="../../../../../com/yahoo/sketches/theta/Sketches.html#heapifySketch-com.yahoo.memory.Memory-long-">heapifySketch</a></span>(com.yahoo.memory.Memory&nbsp;srcMem,
long&nbsp;seed)</code>
<div class="block">Ref: <a href="../../../../../com/yahoo/sketches/theta/Sketch.html#heapify-com.yahoo.memory.Memory-long-"><code>Sketch.heapify(Memory, long)</code></a></div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../../../com/yahoo/sketches/theta/Sketch.html" title="class in com.yahoo.sketches.theta">Sketch</a></code></td>
<td class="colLast"><span class="typeNameLabel">Sketch.</span><code><span class="memberNameLink"><a href="../../../../../com/yahoo/sketches/theta/Sketch.html#wrap-com.yahoo.memory.Memory-">wrap</a></span>(com.yahoo.memory.Memory&nbsp;srcMem)</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="../../../../../com/yahoo/sketches/theta/Sketch.html" title="class in com.yahoo.sketches.theta">Sketch</a></code></td>
<td class="colLast"><span class="typeNameLabel">Sketch.</span><code><span class="memberNameLink"><a href="../../../../../com/yahoo/sketches/theta/Sketch.html#wrap-com.yahoo.memory.Memory-long-">wrap</a></span>(com.yahoo.memory.Memory&nbsp;srcMem,
long&nbsp;seed)</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="../../../../../com/yahoo/sketches/theta/Sketch.html" title="class in com.yahoo.sketches.theta">Sketch</a></code></td>
<td class="colLast"><span class="typeNameLabel">Sketches.</span><code><span class="memberNameLink"><a href="../../../../../com/yahoo/sketches/theta/Sketches.html#wrapSketch-com.yahoo.memory.Memory-">wrapSketch</a></span>(com.yahoo.memory.Memory&nbsp;srcMem)</code>
<div class="block">Ref: <a href="../../../../../com/yahoo/sketches/theta/Sketch.html#wrap-com.yahoo.memory.Memory-"><code>Sketch.wrap(Memory)</code></a></div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../../../../com/yahoo/sketches/theta/Sketch.html" title="class in com.yahoo.sketches.theta">Sketch</a></code></td>
<td class="colLast"><span class="typeNameLabel">Sketches.</span><code><span class="memberNameLink"><a href="../../../../../com/yahoo/sketches/theta/Sketches.html#wrapSketch-com.yahoo.memory.Memory-long-">wrapSketch</a></span>(com.yahoo.memory.Memory&nbsp;srcMem,
long&nbsp;seed)</code>
<div class="block">Ref: <a href="../../../../../com/yahoo/sketches/theta/Sketch.html#wrap-com.yahoo.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="../../../../../com/yahoo/sketches/theta/package-summary.html">com.yahoo.sketches.theta</a> with parameters of type <a href="../../../../../com/yahoo/sketches/theta/Sketch.html" title="class in com.yahoo.sketches.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 boolean</code></td>
<td class="colLast"><span class="typeNameLabel">JaccardSimilarity.</span><code><span class="memberNameLink"><a href="../../../../../com/yahoo/sketches/theta/JaccardSimilarity.html#dissimilarityTest-com.yahoo.sketches.theta.Sketch-com.yahoo.sketches.theta.Sketch-double-">dissimilarityTest</a></span>(<a href="../../../../../com/yahoo/sketches/theta/Sketch.html" title="class in com.yahoo.sketches.theta">Sketch</a>&nbsp;measured,
<a href="../../../../../com/yahoo/sketches/theta/Sketch.html" title="class in com.yahoo.sketches.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="rowColor">
<td class="colFirst"><code>static boolean</code></td>
<td class="colLast"><span class="typeNameLabel">JaccardSimilarity.</span><code><span class="memberNameLink"><a href="../../../../../com/yahoo/sketches/theta/JaccardSimilarity.html#exactlyEqual-com.yahoo.sketches.theta.Sketch-com.yahoo.sketches.theta.Sketch-">exactlyEqual</a></span>(<a href="../../../../../com/yahoo/sketches/theta/Sketch.html" title="class in com.yahoo.sketches.theta">Sketch</a>&nbsp;sketchA,
<a href="../../../../../com/yahoo/sketches/theta/Sketch.html" title="class in com.yahoo.sketches.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="altColor">
<td class="colFirst"><code>static double[]</code></td>
<td class="colLast"><span class="typeNameLabel">JaccardSimilarity.</span><code><span class="memberNameLink"><a href="../../../../../com/yahoo/sketches/theta/JaccardSimilarity.html#jaccard-com.yahoo.sketches.theta.Sketch-com.yahoo.sketches.theta.Sketch-">jaccard</a></span>(<a href="../../../../../com/yahoo/sketches/theta/Sketch.html" title="class in com.yahoo.sketches.theta">Sketch</a>&nbsp;sketchA,
<a href="../../../../../com/yahoo/sketches/theta/Sketch.html" title="class in com.yahoo.sketches.theta">Sketch</a>&nbsp;sketchB)</code>
<div class="block">Computes the Jaccard similarity ratio with upper and lower bounds.</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="../../../../../com/yahoo/sketches/theta/JaccardSimilarity.html#similarityTest-com.yahoo.sketches.theta.Sketch-com.yahoo.sketches.theta.Sketch-double-">similarityTest</a></span>(<a href="../../../../../com/yahoo/sketches/theta/Sketch.html" title="class in com.yahoo.sketches.theta">Sketch</a>&nbsp;measured,
<a href="../../../../../com/yahoo/sketches/theta/Sketch.html" title="class in com.yahoo.sketches.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="altColor">
<td class="colFirst"><code>abstract void</code></td>
<td class="colLast"><span class="typeNameLabel">Intersection.</span><code><span class="memberNameLink"><a href="../../../../../com/yahoo/sketches/theta/Intersection.html#update-com.yahoo.sketches.theta.Sketch-">update</a></span>(<a href="../../../../../com/yahoo/sketches/theta/Sketch.html" title="class in com.yahoo.sketches.theta">Sketch</a>&nbsp;sketchIn)</code>
<div class="block">Intersect the given sketch with the internal state.</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="../../../../../com/yahoo/sketches/theta/Union.html#update-com.yahoo.sketches.theta.Sketch-">update</a></span>(<a href="../../../../../com/yahoo/sketches/theta/Sketch.html" title="class in com.yahoo.sketches.theta">Sketch</a>&nbsp;sketchIn)</code>
<div class="block">Union the given on-heap sketch.</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="../../../../../com/yahoo/sketches/theta/AnotB.html#update-com.yahoo.sketches.theta.Sketch-com.yahoo.sketches.theta.Sketch-">update</a></span>(<a href="../../../../../com/yahoo/sketches/theta/Sketch.html" title="class in com.yahoo.sketches.theta">Sketch</a>&nbsp;a,
<a href="../../../../../com/yahoo/sketches/theta/Sketch.html" title="class in com.yahoo.sketches.theta">Sketch</a>&nbsp;b)</code>
<div class="block">Perform A-and-not-B set operation on the two given sketches.</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="../../../../../com/yahoo/sketches/theta/Sketch.html" title="class in com.yahoo.sketches.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?com/yahoo/sketches/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;2018. All rights reserved.</small></p>
</body>
</html>