blob: 191e8173d8c88c9738223181e4ed42ee58a5bad9 [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 Interface org.apache.datasketches.tuple.Summary (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 Interface org.apache.datasketches.tuple.Summary (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/Summary.html" title="interface 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/Summary.html" target="_top">Frames</a></li>
<li><a href="Summary.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 Interface org.apache.datasketches.tuple.Summary" class="title">Uses of Interface<br>org.apache.datasketches.tuple.Summary</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/Summary.html" title="interface in org.apache.datasketches.tuple">Summary</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.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>
<tr class="altColor">
<td class="colFirst"><a href="#org.apache.datasketches.tuple.adouble">org.apache.datasketches.tuple.adouble</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="#org.apache.datasketches.tuple.aninteger">org.apache.datasketches.tuple.aninteger</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="#org.apache.datasketches.tuple.strings">org.apache.datasketches.tuple.strings</a></td>
<td class="colLast">&nbsp;</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/tuple/Summary.html" title="interface in org.apache.datasketches.tuple">Summary</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 type parameters of type <a href="../../../../../org/apache/datasketches/tuple/Summary.html" title="interface in org.apache.datasketches.tuple">Summary</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 &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.tuple.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/tuple/Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a>&lt;S&gt;&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 &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.tuple.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/tuple/Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a>&lt;S&gt;&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 &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.tuple.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/tuple/Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a>&lt;S&gt;&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.tuple">
<!-- -->
</a>
<h3>Uses of <a href="../../../../../org/apache/datasketches/tuple/Summary.html" title="interface in org.apache.datasketches.tuple">Summary</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 classes, and an explanation">
<caption><span>Classes in <a href="../../../../../org/apache/datasketches/tuple/package-summary.html">org.apache.datasketches.tuple</a> with type parameters of type <a href="../../../../../org/apache/datasketches/tuple/Summary.html" title="interface in org.apache.datasketches.tuple">Summary</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/tuple/AnotB.html" title="class in org.apache.datasketches.tuple">AnotB</a>&lt;S extends <a href="../../../../../org/apache/datasketches/tuple/Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>&gt;</span></code>
<div class="block">Computes a set difference, A-AND-NOT-B, of two generic tuple sketches.</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/tuple/CompactSketch.html" title="class in org.apache.datasketches.tuple">CompactSketch</a>&lt;S extends <a href="../../../../../org/apache/datasketches/tuple/Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>&gt;</span></code>
<div class="block">CompactSketches are never created directly.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/datasketches/tuple/Filter.html" title="class in org.apache.datasketches.tuple">Filter</a>&lt;T extends <a href="../../../../../org/apache/datasketches/tuple/Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>&gt;</span></code>
<div class="block">Class for filtering entries from a <a href="../../../../../org/apache/datasketches/tuple/Sketch.html" title="class in org.apache.datasketches.tuple"><code>Sketch</code></a> given a <a href="../../../../../org/apache/datasketches/tuple/Summary.html" title="interface in org.apache.datasketches.tuple"><code>Summary</code></a></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/tuple/Intersection.html" title="class in org.apache.datasketches.tuple">Intersection</a>&lt;S extends <a href="../../../../../org/apache/datasketches/tuple/Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>&gt;</span></code>
<div class="block">Computes an intersection of two or more generic tuple sketches or generic tuple sketches
combined with theta sketches.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/datasketches/tuple/Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a>&lt;S extends <a href="../../../../../org/apache/datasketches/tuple/Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>&gt;</span></code>
<div class="block">This is an equivalent to org.apache.datasketches.theta.Sketch with
addition of a user-defined Summary object associated with every unique entry
in the sketch.</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/tuple/SketchIterator.html" title="class in org.apache.datasketches.tuple">SketchIterator</a>&lt;S extends <a href="../../../../../org/apache/datasketches/tuple/Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>&gt;</span></code>
<div class="block">Iterator over a generic tuple sketch</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>interface&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/datasketches/tuple/SummaryDeserializer.html" title="interface in org.apache.datasketches.tuple">SummaryDeserializer</a>&lt;S extends <a href="../../../../../org/apache/datasketches/tuple/Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>&gt;</span></code>
<div class="block">Interface for deserializing user-defined Summary</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>interface&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/datasketches/tuple/SummaryFactory.html" title="interface in org.apache.datasketches.tuple">SummaryFactory</a>&lt;S extends <a href="../../../../../org/apache/datasketches/tuple/Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>&gt;</span></code>
<div class="block">Interface for user-defined SummaryFactory</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>interface&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/datasketches/tuple/SummarySetOperations.html" title="interface in org.apache.datasketches.tuple">SummarySetOperations</a>&lt;S extends <a href="../../../../../org/apache/datasketches/tuple/Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>&gt;</span></code>
<div class="block">This is to provide methods of producing unions and intersections of two Summary objects.</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/tuple/Union.html" title="class in org.apache.datasketches.tuple">Union</a>&lt;S extends <a href="../../../../../org/apache/datasketches/tuple/Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>&gt;</span></code>
<div class="block">Compute the union of two or more generic tuple sketches or generic tuple sketches combined with
theta sketches.</div>
</td>
</tr>
</tbody>
</table>
<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing subinterfaces, and an explanation">
<caption><span>Subinterfaces of <a href="../../../../../org/apache/datasketches/tuple/Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a> in <a href="../../../../../org/apache/datasketches/tuple/package-summary.html">org.apache.datasketches.tuple</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Interface and Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><code>interface&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/datasketches/tuple/UpdatableSummary.html" title="interface in org.apache.datasketches.tuple">UpdatableSummary</a>&lt;U&gt;</span></code>
<div class="block">Interface for updating user-defined Summary</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/tuple/package-summary.html">org.apache.datasketches.tuple</a> with type parameters of type <a href="../../../../../org/apache/datasketches/tuple/Summary.html" title="interface in org.apache.datasketches.tuple">Summary</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>static &lt;S extends <a href="../../../../../org/apache/datasketches/tuple/Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>&gt;<br>S[]</code></td>
<td class="colLast"><span class="typeNameLabel">Util.</span><code><span class="memberNameLink"><a href="../../../../../org/apache/datasketches/tuple/Util.html#copySummaryArray-S:A-">copySummaryArray</a></span>(S[]&nbsp;summaryArr)</code>
<div class="block">Will copy compact summary arrays as well as hashed summary tables (with nulls).</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/Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a>&lt;S&gt;</code></td>
<td class="colLast"><span class="typeNameLabel">Sketches.</span><code><span class="memberNameLink"><a href="../../../../../org/apache/datasketches/tuple/Sketches.html#createEmptySketch--">createEmptySketch</a></span>()</code>&nbsp;</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#dissimilarityTest-org.apache.datasketches.tuple.Sketch-org.apache.datasketches.tuple.Sketch-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/tuple/Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a>&lt;S&gt;&nbsp;expected,
<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="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.tuple.Sketch-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/tuple/Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a>&lt;S&gt;&nbsp;sketchB,
<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>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="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/Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a>&lt;S&gt;</code></td>
<td class="colLast"><span class="typeNameLabel">Sketches.</span><code><span class="memberNameLink"><a href="../../../../../org/apache/datasketches/tuple/Sketches.html#heapifySketch-org.apache.datasketches.memory.Memory-org.apache.datasketches.tuple.SummaryDeserializer-">heapifySketch</a></span>(org.apache.datasketches.memory.Memory&nbsp;mem,
<a href="../../../../../org/apache/datasketches/tuple/SummaryDeserializer.html" title="interface in org.apache.datasketches.tuple">SummaryDeserializer</a>&lt;S&gt;&nbsp;deserializer)</code>
<div class="block">Instantiate a Sketch from a given Memory.</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.tuple.Sketch-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/tuple/Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a>&lt;S&gt;&nbsp;sketchB,
<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>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="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>S[]</code></td>
<td class="colLast"><span class="typeNameLabel">Util.</span><code><span class="memberNameLink"><a href="../../../../../org/apache/datasketches/tuple/Util.html#newSummaryArray-S:A-int-">newSummaryArray</a></span>(S[]&nbsp;summaryArr,
int&nbsp;length)</code>&nbsp;</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#similarityTest-org.apache.datasketches.tuple.Sketch-org.apache.datasketches.tuple.Sketch-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/tuple/Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a>&lt;S&gt;&nbsp;expected,
<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="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>
</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/tuple/package-summary.html">org.apache.datasketches.tuple</a> that return <a href="../../../../../org/apache/datasketches/tuple/Summary.html" title="interface in org.apache.datasketches.tuple">Summary</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/tuple/Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a></code></td>
<td class="colLast"><span class="typeNameLabel">Summary.</span><code><span class="memberNameLink"><a href="../../../../../org/apache/datasketches/tuple/Summary.html#copy--">copy</a></span>()</code>
<div class="block">Deep copy.</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>S[]</code></td>
<td class="colLast"><span class="typeNameLabel">Util.</span><code><span class="memberNameLink"><a href="../../../../../org/apache/datasketches/tuple/Util.html#copySummaryArray-S:A-">copySummaryArray</a></span>(S[]&nbsp;summaryArr)</code>
<div class="block">Will copy compact summary arrays as well as hashed summary tables (with nulls).</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>S[]</code></td>
<td class="colLast"><span class="typeNameLabel">Util.</span><code><span class="memberNameLink"><a href="../../../../../org/apache/datasketches/tuple/Util.html#newSummaryArray-S:A-int-">newSummaryArray</a></span>(S[]&nbsp;summaryArr,
int&nbsp;length)</code>&nbsp;</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/tuple/package-summary.html">org.apache.datasketches.tuple</a> with parameters of type <a href="../../../../../org/apache/datasketches/tuple/Summary.html" title="interface in org.apache.datasketches.tuple">Summary</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>S[]</code></td>
<td class="colLast"><span class="typeNameLabel">Util.</span><code><span class="memberNameLink"><a href="../../../../../org/apache/datasketches/tuple/Util.html#copySummaryArray-S:A-">copySummaryArray</a></span>(S[]&nbsp;summaryArr)</code>
<div class="block">Will copy compact summary arrays as well as hashed summary tables (with nulls).</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>S[]</code></td>
<td class="colLast"><span class="typeNameLabel">Util.</span><code><span class="memberNameLink"><a href="../../../../../org/apache/datasketches/tuple/Util.html#newSummaryArray-S:A-int-">newSummaryArray</a></span>(S[]&nbsp;summaryArr,
int&nbsp;length)</code>&nbsp;</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList"><a name="org.apache.datasketches.tuple.adouble">
<!-- -->
</a>
<h3>Uses of <a href="../../../../../org/apache/datasketches/tuple/Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a> in <a href="../../../../../org/apache/datasketches/tuple/adouble/package-summary.html">org.apache.datasketches.tuple.adouble</a></h3>
<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation">
<caption><span>Classes in <a href="../../../../../org/apache/datasketches/tuple/adouble/package-summary.html">org.apache.datasketches.tuple.adouble</a> that implement <a href="../../../../../org/apache/datasketches/tuple/Summary.html" title="interface in org.apache.datasketches.tuple">Summary</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/tuple/adouble/DoubleSummary.html" title="class in org.apache.datasketches.tuple.adouble">DoubleSummary</a></span></code>
<div class="block">Summary for generic tuple sketches of type Double.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList"><a name="org.apache.datasketches.tuple.aninteger">
<!-- -->
</a>
<h3>Uses of <a href="../../../../../org/apache/datasketches/tuple/Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a> in <a href="../../../../../org/apache/datasketches/tuple/aninteger/package-summary.html">org.apache.datasketches.tuple.aninteger</a></h3>
<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation">
<caption><span>Classes in <a href="../../../../../org/apache/datasketches/tuple/aninteger/package-summary.html">org.apache.datasketches.tuple.aninteger</a> that implement <a href="../../../../../org/apache/datasketches/tuple/Summary.html" title="interface in org.apache.datasketches.tuple">Summary</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/tuple/aninteger/IntegerSummary.html" title="class in org.apache.datasketches.tuple.aninteger">IntegerSummary</a></span></code>
<div class="block">Summary for generic tuple sketches of type Integer.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList"><a name="org.apache.datasketches.tuple.strings">
<!-- -->
</a>
<h3>Uses of <a href="../../../../../org/apache/datasketches/tuple/Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a> in <a href="../../../../../org/apache/datasketches/tuple/strings/package-summary.html">org.apache.datasketches.tuple.strings</a></h3>
<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation">
<caption><span>Classes in <a href="../../../../../org/apache/datasketches/tuple/strings/package-summary.html">org.apache.datasketches.tuple.strings</a> that implement <a href="../../../../../org/apache/datasketches/tuple/Summary.html" title="interface in org.apache.datasketches.tuple">Summary</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/tuple/strings/ArrayOfStringsSummary.html" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSummary</a></span></code>&nbsp;</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/Summary.html" title="interface 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/Summary.html" target="_top">Frames</a></li>
<li><a href="Summary.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>