Google Git
Sign in
apache / datasketches-website / d5f29b3e6de7df659f65c31ea2ce341dcaf8b675 / . / api / java / snapshot / apidocs / org / apache / datasketches / tuple / class-use / SummarySetOperations.html
blob: 6bfbb3994d9bc448c8dddb24dffc5e9c9d78ad0b [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>Uses of Interface org.apache.datasketches.tuple.SummarySetOperations (datasketches-java 4.0.0 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../jquery/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../../jquery/jquery-3.6.0.min.js"></script>
<script type="text/javascript" src="../../../../../jquery/jquery-ui.min.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.SummarySetOperations (datasketches-java 4.0.0 API)";
}
}
catch(err) {
}
//-->
var pathtoroot = "../../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li><a href="../package-summary.html">Package</a></li>
<li><a href="../SummarySetOperations.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" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<a id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<main role="main">
<div class="header">
<h2 title="Uses of Interface org.apache.datasketches.tuple.SummarySetOperations" class="title">Uses of Interface<br>org.apache.datasketches.tuple.SummarySetOperations</h2>
</div>
<div class="classUseContainer">
<ul class="blockList">
<li class="blockList">
<table class="useSummary">
<caption><span>Packages that use <a href="../SummarySetOperations.html" title="interface in org.apache.datasketches.tuple">SummarySetOperations</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">
<th class="colFirst" scope="row"><a href="#org.apache.datasketches.tuple">org.apache.datasketches.tuple</a></th>
<td class="colLast">
<div class="block">The tuple package contains a number of sketches based on the same
fundamental algorithms of the Theta Sketch Framework and extend these
concepts for whole new families of sketches.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="#org.apache.datasketches.tuple.adouble">org.apache.datasketches.tuple.adouble</a></th>
<td class="colLast">
<div class="block">This package is for a generic implementation of the Tuple sketch for single Double value.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="#org.apache.datasketches.tuple.aninteger">org.apache.datasketches.tuple.aninteger</a></th>
<td class="colLast">
<div class="block">This package is for a generic implementation of the Tuple sketch for single Integer value.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="#org.apache.datasketches.tuple.strings">org.apache.datasketches.tuple.strings</a></th>
<td class="colLast">
<div class="block">This package is for a generic implementation of the Tuple sketch for single String value.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<ul class="blockList">
<li class="blockList">
<section><a id="org.apache.datasketches.tuple">
<!-- -->
</a>
<h3>Uses of <a href="../SummarySetOperations.html" title="interface in org.apache.datasketches.tuple">SummarySetOperations</a> in <a href="../package-summary.html">org.apache.datasketches.tuple</a></h3>
<table class="useSummary">
<caption><span>Methods in <a href="../package-summary.html">org.apache.datasketches.tuple</a> with parameters of type <a href="../SummarySetOperations.html" title="interface in org.apache.datasketches.tuple">SummarySetOperations</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><code>static &lt;S extends <a href="../Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>&gt;<br>boolean</code></td>
<th class="colSecond" scope="row"><span class="typeNameLabel">JaccardSimilarity.</span><code><span class="memberNameLink"><a href="../JaccardSimilarity.html#dissimilarityTest(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.theta.Sketch,S,org.apache.datasketches.tuple.SummarySetOperations,double)">dissimilarityTest</a></span>&#8203;(<a href="../Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a>&lt;S&gt;&nbsp;measured,
<a href="../../theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a>&nbsp;expected,
S&nbsp;summary,
<a href="../SummarySetOperations.html" title="interface in org.apache.datasketches.tuple">SummarySetOperations</a>&lt;S&gt;&nbsp;summarySetOps,
double&nbsp;threshold)</code></th>
<td class="colLast">
<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="../Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>&gt;<br>boolean</code></td>
<th class="colSecond" scope="row"><span class="typeNameLabel">JaccardSimilarity.</span><code><span class="memberNameLink"><a href="../JaccardSimilarity.html#dissimilarityTest(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.tuple.Sketch,org.apache.datasketches.tuple.SummarySetOperations,double)">dissimilarityTest</a></span>&#8203;(<a href="../Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a>&lt;S&gt;&nbsp;measured,
<a href="../Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a>&lt;S&gt;&nbsp;expected,
<a href="../SummarySetOperations.html" title="interface in org.apache.datasketches.tuple">SummarySetOperations</a>&lt;S&gt;&nbsp;summarySetOps,
double&nbsp;threshold)</code></th>
<td class="colLast">
<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="../Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>&gt;<br>boolean</code></td>
<th class="colSecond" scope="row"><span class="typeNameLabel">JaccardSimilarity.</span><code><span class="memberNameLink"><a href="../JaccardSimilarity.html#exactlyEqual(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.theta.Sketch,S,org.apache.datasketches.tuple.SummarySetOperations)">exactlyEqual</a></span>&#8203;(<a href="../Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a>&lt;S&gt;&nbsp;sketchA,
<a href="../../theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a>&nbsp;sketchB,
S&nbsp;summary,
<a href="../SummarySetOperations.html" title="interface in org.apache.datasketches.tuple">SummarySetOperations</a>&lt;S&gt;&nbsp;summarySetOps)</code></th>
<td class="colLast">
<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="../Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>&gt;<br>boolean</code></td>
<th class="colSecond" scope="row"><span class="typeNameLabel">JaccardSimilarity.</span><code><span class="memberNameLink"><a href="../JaccardSimilarity.html#exactlyEqual(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.tuple.Sketch,org.apache.datasketches.tuple.SummarySetOperations)">exactlyEqual</a></span>&#8203;(<a href="../Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a>&lt;S&gt;&nbsp;sketchA,
<a href="../Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a>&lt;S&gt;&nbsp;sketchB,
<a href="../SummarySetOperations.html" title="interface in org.apache.datasketches.tuple">SummarySetOperations</a>&lt;S&gt;&nbsp;summarySetOps)</code></th>
<td class="colLast">
<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="../Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>&gt;<br>double[]</code></td>
<th class="colSecond" scope="row"><span class="typeNameLabel">JaccardSimilarity.</span><code><span class="memberNameLink"><a href="../JaccardSimilarity.html#jaccard(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.theta.Sketch,S,org.apache.datasketches.tuple.SummarySetOperations)">jaccard</a></span>&#8203;(<a href="../Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a>&lt;S&gt;&nbsp;sketchA,
<a href="../../theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a>&nbsp;sketchB,
S&nbsp;summary,
<a href="../SummarySetOperations.html" title="interface in org.apache.datasketches.tuple">SummarySetOperations</a>&lt;S&gt;&nbsp;summarySetOps)</code></th>
<td class="colLast">
<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="../Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>&gt;<br>double[]</code></td>
<th class="colSecond" scope="row"><span class="typeNameLabel">JaccardSimilarity.</span><code><span class="memberNameLink"><a href="../JaccardSimilarity.html#jaccard(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.tuple.Sketch,org.apache.datasketches.tuple.SummarySetOperations)">jaccard</a></span>&#8203;(<a href="../Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a>&lt;S&gt;&nbsp;sketchA,
<a href="../Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a>&lt;S&gt;&nbsp;sketchB,
<a href="../SummarySetOperations.html" title="interface in org.apache.datasketches.tuple">SummarySetOperations</a>&lt;S&gt;&nbsp;summarySetOps)</code></th>
<td class="colLast">
<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="../Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>&gt;<br>boolean</code></td>
<th class="colSecond" scope="row"><span class="typeNameLabel">JaccardSimilarity.</span><code><span class="memberNameLink"><a href="../JaccardSimilarity.html#similarityTest(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.theta.Sketch,S,org.apache.datasketches.tuple.SummarySetOperations,double)">similarityTest</a></span>&#8203;(<a href="../Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a>&lt;S&gt;&nbsp;measured,
<a href="../../theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a>&nbsp;expected,
S&nbsp;summary,
<a href="../SummarySetOperations.html" title="interface in org.apache.datasketches.tuple">SummarySetOperations</a>&lt;S&gt;&nbsp;summarySetOps,
double&nbsp;threshold)</code></th>
<td class="colLast">
<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="../Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>&gt;<br>boolean</code></td>
<th class="colSecond" scope="row"><span class="typeNameLabel">JaccardSimilarity.</span><code><span class="memberNameLink"><a href="../JaccardSimilarity.html#similarityTest(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.tuple.Sketch,org.apache.datasketches.tuple.SummarySetOperations,double)">similarityTest</a></span>&#8203;(<a href="../Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a>&lt;S&gt;&nbsp;measured,
<a href="../Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a>&lt;S&gt;&nbsp;expected,
<a href="../SummarySetOperations.html" title="interface in org.apache.datasketches.tuple">SummarySetOperations</a>&lt;S&gt;&nbsp;summarySetOps,
double&nbsp;threshold)</code></th>
<td class="colLast">
<div class="block">Tests similarity of a measured Sketch against an expected Sketch.</div>
</td>
</tr>
</tbody>
</table>
<table class="useSummary">
<caption><span>Constructors in <a href="../package-summary.html">org.apache.datasketches.tuple</a> with parameters of type <a href="../SummarySetOperations.html" title="interface in org.apache.datasketches.tuple">SummarySetOperations</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../Intersection.html#%3Cinit%3E(org.apache.datasketches.tuple.SummarySetOperations)">Intersection</a></span>&#8203;(<a href="../SummarySetOperations.html" title="interface in org.apache.datasketches.tuple">SummarySetOperations</a>&lt;<a href="../Intersection.html" title="type parameter in Intersection">S</a>&gt;&nbsp;summarySetOps)</code></th>
<td class="colLast">
<div class="block">Creates new Intersection instance with instructions on how to process two summaries that
intersect.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../Union.html#%3Cinit%3E(int,org.apache.datasketches.tuple.SummarySetOperations)">Union</a></span>&#8203;(int&nbsp;nomEntries,
<a href="../SummarySetOperations.html" title="interface in org.apache.datasketches.tuple">SummarySetOperations</a>&lt;<a href="../Union.html" title="type parameter in Union">S</a>&gt;&nbsp;summarySetOps)</code></th>
<td class="colLast">
<div class="block">Creates new Union instance.</div>
</td>
</tr>
<tr class="altColor">
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../Union.html#%3Cinit%3E(org.apache.datasketches.tuple.SummarySetOperations)">Union</a></span>&#8203;(<a href="../SummarySetOperations.html" title="interface in org.apache.datasketches.tuple">SummarySetOperations</a>&lt;<a href="../Union.html" title="type parameter in Union">S</a>&gt;&nbsp;summarySetOps)</code></th>
<td class="colLast">
<div class="block">Creates new Union instance with instructions on how to process two summaries that
overlap.</div>
</td>
</tr>
</tbody>
</table>
</section>
</li>
<li class="blockList">
<section><a id="org.apache.datasketches.tuple.adouble">
<!-- -->
</a>
<h3>Uses of <a href="../SummarySetOperations.html" title="interface in org.apache.datasketches.tuple">SummarySetOperations</a> in <a href="../adouble/package-summary.html">org.apache.datasketches.tuple.adouble</a></h3>
<table class="useSummary">
<caption><span>Classes in <a href="../adouble/package-summary.html">org.apache.datasketches.tuple.adouble</a> that implement <a href="../SummarySetOperations.html" title="interface in org.apache.datasketches.tuple">SummarySetOperations</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><code>class&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../adouble/DoubleSummarySetOperations.html" title="class in org.apache.datasketches.tuple.adouble">DoubleSummarySetOperations</a></span></code></th>
<td class="colLast">
<div class="block">Methods for defining how unions and intersections of two objects of type DoubleSummary
are performed.</div>
</td>
</tr>
</tbody>
</table>
</section>
</li>
<li class="blockList">
<section><a id="org.apache.datasketches.tuple.aninteger">
<!-- -->
</a>
<h3>Uses of <a href="../SummarySetOperations.html" title="interface in org.apache.datasketches.tuple">SummarySetOperations</a> in <a href="../aninteger/package-summary.html">org.apache.datasketches.tuple.aninteger</a></h3>
<table class="useSummary">
<caption><span>Classes in <a href="../aninteger/package-summary.html">org.apache.datasketches.tuple.aninteger</a> that implement <a href="../SummarySetOperations.html" title="interface in org.apache.datasketches.tuple">SummarySetOperations</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><code>class&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../aninteger/IntegerSummarySetOperations.html" title="class in org.apache.datasketches.tuple.aninteger">IntegerSummarySetOperations</a></span></code></th>
<td class="colLast">
<div class="block">Methods for defining how unions and intersections of two objects of type IntegerSummary
are performed.</div>
</td>
</tr>
</tbody>
</table>
</section>
</li>
<li class="blockList">
<section><a id="org.apache.datasketches.tuple.strings">
<!-- -->
</a>
<h3>Uses of <a href="../SummarySetOperations.html" title="interface in org.apache.datasketches.tuple">SummarySetOperations</a> in <a href="../strings/package-summary.html">org.apache.datasketches.tuple.strings</a></h3>
<table class="useSummary">
<caption><span>Classes in <a href="../strings/package-summary.html">org.apache.datasketches.tuple.strings</a> that implement <a href="../SummarySetOperations.html" title="interface in org.apache.datasketches.tuple">SummarySetOperations</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><code>class&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../strings/ArrayOfStringsSummarySetOperations.html" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSummarySetOperations</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
</table>
</section>
</li>
</ul>
</li>
</ul>
</div>
</main>
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li><a href="../package-summary.html">Package</a></li>
<li><a href="../SummarySetOperations.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" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses.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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Copyright &#169; 2015&#x2013;2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</body>
</html>