| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>Uses of Class org.apache.datasketches.theta.Sketch (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 Class org.apache.datasketches.theta.Sketch (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="../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" id="allclasses_navbar_top"> |
| <li><a href="../../../../../allclasses.html">All 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"> </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 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"> |
| <caption><span>Packages that use <a href="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a></span><span class="tabEnd"> </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.theta">org.apache.datasketches.theta</a></th> |
| <td class="colLast"> |
| <div class="block">The theta package contains the basic sketch classes that are members of the |
| <a href="../../../../../resources/dictionary.html#thetaSketch">Theta Sketch Framework</a>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="#org.apache.datasketches.thetacommon">org.apache.datasketches.thetacommon</a></th> |
| <td class="colLast"> |
| <div class="block">This package contains common tools and methods for the <i>theta</i>, |
| <i>tuple</i>, <i>tuple/*</i> and <i>fdt</i> packages.</div> |
| </td> |
| </tr> |
| <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> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <section><a id="org.apache.datasketches.theta"> |
| <!-- --> |
| </a> |
| <h3>Uses of <a href="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> in <a href="../package-summary.html">org.apache.datasketches.theta</a></h3> |
| <table class="useSummary"> |
| <caption><span>Subclasses of <a href="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> in <a href="../package-summary.html">org.apache.datasketches.theta</a></span><span class="tabEnd"> </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 </code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">The parent class of all the CompactSketches.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>class </code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../UpdateSketch.html" title="class in org.apache.datasketches.theta">UpdateSketch</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">The parent class for the Update Sketch families, such as QuickSelect and Alpha.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <table class="useSummary"> |
| <caption><span>Methods in <a href="../package-summary.html">org.apache.datasketches.theta</a> that return <a href="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a></span><span class="tabEnd"> </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 <a href="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">Sketch.</span><code><span class="memberNameLink"><a href="../Sketch.html#heapify(org.apache.datasketches.memory.Memory)">heapify</a></span>​(org.apache.datasketches.memory.Memory srcMem)</code></th> |
| <td class="colLast"> |
| <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="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">Sketch.</span><code><span class="memberNameLink"><a href="../Sketch.html#heapify(org.apache.datasketches.memory.Memory,long)">heapify</a></span>​(org.apache.datasketches.memory.Memory srcMem, |
| long expectedSeed)</code></th> |
| <td class="colLast"> |
| <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="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">Sketches.</span><code><span class="memberNameLink"><a href="../Sketches.html#heapifySketch(org.apache.datasketches.memory.Memory)">heapifySketch</a></span>​(org.apache.datasketches.memory.Memory srcMem)</code></th> |
| <td class="colLast"> |
| <div class="block">Ref: <a href="../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="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">Sketches.</span><code><span class="memberNameLink"><a href="../Sketches.html#heapifySketch(org.apache.datasketches.memory.Memory,long)">heapifySketch</a></span>​(org.apache.datasketches.memory.Memory srcMem, |
| long expectedSeed)</code></th> |
| <td class="colLast"> |
| <div class="block">Ref: <a href="../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="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">Sketch.</span><code><span class="memberNameLink"><a href="../Sketch.html#wrap(org.apache.datasketches.memory.Memory)">wrap</a></span>​(org.apache.datasketches.memory.Memory srcMem)</code></th> |
| <td class="colLast"> |
| <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="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">Sketch.</span><code><span class="memberNameLink"><a href="../Sketch.html#wrap(org.apache.datasketches.memory.Memory,long)">wrap</a></span>​(org.apache.datasketches.memory.Memory srcMem, |
| long expectedSeed)</code></th> |
| <td class="colLast"> |
| <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="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">Sketches.</span><code><span class="memberNameLink"><a href="../Sketches.html#wrapSketch(org.apache.datasketches.memory.Memory)">wrapSketch</a></span>​(org.apache.datasketches.memory.Memory srcMem)</code></th> |
| <td class="colLast"> |
| <div class="block">Ref: <a href="../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="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">Sketches.</span><code><span class="memberNameLink"><a href="../Sketches.html#wrapSketch(org.apache.datasketches.memory.Memory,long)">wrapSketch</a></span>​(org.apache.datasketches.memory.Memory srcMem, |
| long expectedSeed)</code></th> |
| <td class="colLast"> |
| <div class="block">Ref: <a href="../Sketch.html#wrap(org.apache.datasketches.memory.Memory,long)"><code>Sketch.wrap(Memory, long)</code></a></div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <table class="useSummary"> |
| <caption><span>Methods in <a href="../package-summary.html">org.apache.datasketches.theta</a> with parameters of type <a href="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a></span><span class="tabEnd"> </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><a href="../CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">AnotB.</span><code><span class="memberNameLink"><a href="../AnotB.html#aNotB(org.apache.datasketches.theta.Sketch,org.apache.datasketches.theta.Sketch)">aNotB</a></span>​(<a href="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> skA, |
| <a href="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> skB)</code></th> |
| <td class="colLast"> |
| <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>abstract <a href="../CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">AnotB.</span><code><span class="memberNameLink"><a href="../AnotB.html#aNotB(org.apache.datasketches.theta.Sketch,org.apache.datasketches.theta.Sketch,boolean,org.apache.datasketches.memory.WritableMemory)">aNotB</a></span>​(<a href="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> skA, |
| <a href="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> skB, |
| boolean dstOrdered, |
| org.apache.datasketches.memory.WritableMemory dstMem)</code></th> |
| <td class="colLast"> |
| <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="altColor"> |
| <td class="colFirst"><code>static <a href="../CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">PairwiseSetOperations.</span><code><span class="memberNameLink"><a href="../PairwiseSetOperations.html#aNotB(org.apache.datasketches.theta.Sketch,org.apache.datasketches.theta.Sketch)">aNotB</a></span>​(<a href="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> skA, |
| <a href="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> skB)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">v2.0.0.</div> |
| </div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static 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.theta.Sketch,org.apache.datasketches.theta.Sketch,double)">dissimilarityTest</a></span>​(<a href="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> measured, |
| <a href="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> expected, |
| double 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 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.theta.Sketch,org.apache.datasketches.theta.Sketch)">exactlyEqual</a></span>​(<a href="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> sketchA, |
| <a href="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> sketchB)</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>abstract void</code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">Intersection.</span><code><span class="memberNameLink"><a href="../Intersection.html#intersect(org.apache.datasketches.theta.Sketch)">intersect</a></span>​(<a href="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> sketchIn)</code></th> |
| <td class="colLast"> |
| <div class="block">Intersect the given sketch with the internal state.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">Intersection.</span><code><span class="memberNameLink"><a href="../Intersection.html#intersect(org.apache.datasketches.theta.Sketch,org.apache.datasketches.theta.Sketch)">intersect</a></span>​(<a href="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> a, |
| <a href="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> b)</code></th> |
| <td class="colLast"> |
| <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>abstract <a href="../CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">Intersection.</span><code><span class="memberNameLink"><a href="../Intersection.html#intersect(org.apache.datasketches.theta.Sketch,org.apache.datasketches.theta.Sketch,boolean,org.apache.datasketches.memory.WritableMemory)">intersect</a></span>​(<a href="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> a, |
| <a href="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> b, |
| boolean dstOrdered, |
| org.apache.datasketches.memory.WritableMemory dstMem)</code></th> |
| <td class="colLast"> |
| <div class="block">Perform intersect set operation on the two given sketches and return the result as a |
| CompactSketch.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="../CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">PairwiseSetOperations.</span><code><span class="memberNameLink"><a href="../PairwiseSetOperations.html#intersect(org.apache.datasketches.theta.Sketch,org.apache.datasketches.theta.Sketch)">intersect</a></span>​(<a href="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> skA, |
| <a href="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> skB)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">v2.0.0.</div> |
| </div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static 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.theta.Sketch,org.apache.datasketches.theta.Sketch)">jaccard</a></span>​(<a href="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> sketchA, |
| <a href="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> sketchB)</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>abstract void</code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">AnotB.</span><code><span class="memberNameLink"><a href="../AnotB.html#notB(org.apache.datasketches.theta.Sketch)">notB</a></span>​(<a href="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> skB)</code></th> |
| <td class="colLast"> |
| <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> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">AnotB.</span><code><span class="memberNameLink"><a href="../AnotB.html#setA(org.apache.datasketches.theta.Sketch)">setA</a></span>​(<a href="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> skA)</code></th> |
| <td class="colLast"> |
| <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> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">JaccardSimilarity.</span><code><span class="memberNameLink"><a href="../JaccardSimilarity.html#similarityTest(org.apache.datasketches.theta.Sketch,org.apache.datasketches.theta.Sketch,double)">similarityTest</a></span>​(<a href="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> measured, |
| <a href="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> expected, |
| double 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>abstract void</code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">Union.</span><code><span class="memberNameLink"><a href="../Union.html#union(org.apache.datasketches.theta.Sketch)">union</a></span>​(<a href="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> sketchIn)</code></th> |
| <td class="colLast"> |
| <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="../CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">Union.</span><code><span class="memberNameLink"><a href="../Union.html#union(org.apache.datasketches.theta.Sketch,org.apache.datasketches.theta.Sketch)">union</a></span>​(<a href="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> sketchA, |
| <a href="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> sketchB)</code></th> |
| <td class="colLast"> |
| <div class="block">This implements a stateless, pair-wise union operation.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>abstract <a href="../CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">Union.</span><code><span class="memberNameLink"><a href="../Union.html#union(org.apache.datasketches.theta.Sketch,org.apache.datasketches.theta.Sketch,boolean,org.apache.datasketches.memory.WritableMemory)">union</a></span>​(<a href="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> sketchA, |
| <a href="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> sketchB, |
| boolean dstOrdered, |
| org.apache.datasketches.memory.WritableMemory dstMem)</code></th> |
| <td class="colLast"> |
| <div class="block">This implements a stateless, pair-wise union operation.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section><a id="org.apache.datasketches.thetacommon"> |
| <!-- --> |
| </a> |
| <h3>Uses of <a href="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> in <a href="../../thetacommon/package-summary.html">org.apache.datasketches.thetacommon</a></h3> |
| <table class="useSummary"> |
| <caption><span>Methods in <a href="../../thetacommon/package-summary.html">org.apache.datasketches.thetacommon</a> with parameters of type <a href="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a></span><span class="tabEnd"> </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 double</code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">BoundsOnRatiosInThetaSketchedSets.</span><code><span class="memberNameLink"><a href="../../thetacommon/BoundsOnRatiosInThetaSketchedSets.html#getEstimateOfBoverA(org.apache.datasketches.theta.Sketch,org.apache.datasketches.theta.Sketch)">getEstimateOfBoverA</a></span>​(<a href="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> sketchA, |
| <a href="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> sketchB)</code></th> |
| <td class="colLast"> |
| <div class="block">Gets the estimate for B over A</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <S extends <a href="../../tuple/Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>><br>double</code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">BoundsOnRatiosInTupleSketchedSets.</span><code><span class="memberNameLink"><a href="../../thetacommon/BoundsOnRatiosInTupleSketchedSets.html#getEstimateOfBoverA(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.theta.Sketch)">getEstimateOfBoverA</a></span>​(<a href="../../tuple/Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> sketchA, |
| <a href="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> sketchB)</code></th> |
| <td class="colLast"> |
| <div class="block">Gets the estimate for B over A</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static double</code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">BoundsOnRatiosInThetaSketchedSets.</span><code><span class="memberNameLink"><a href="../../thetacommon/BoundsOnRatiosInThetaSketchedSets.html#getLowerBoundForBoverA(org.apache.datasketches.theta.Sketch,org.apache.datasketches.theta.Sketch)">getLowerBoundForBoverA</a></span>​(<a href="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> sketchA, |
| <a href="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> sketchB)</code></th> |
| <td class="colLast"> |
| <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 <S extends <a href="../../tuple/Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>><br>double</code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">BoundsOnRatiosInTupleSketchedSets.</span><code><span class="memberNameLink"><a href="../../thetacommon/BoundsOnRatiosInTupleSketchedSets.html#getLowerBoundForBoverA(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.theta.Sketch)">getLowerBoundForBoverA</a></span>​(<a href="../../tuple/Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> sketchA, |
| <a href="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> sketchB)</code></th> |
| <td class="colLast"> |
| <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> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">BoundsOnRatiosInThetaSketchedSets.</span><code><span class="memberNameLink"><a href="../../thetacommon/BoundsOnRatiosInThetaSketchedSets.html#getUpperBoundForBoverA(org.apache.datasketches.theta.Sketch,org.apache.datasketches.theta.Sketch)">getUpperBoundForBoverA</a></span>​(<a href="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> sketchA, |
| <a href="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> sketchB)</code></th> |
| <td class="colLast"> |
| <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 <S extends <a href="../../tuple/Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>><br>double</code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">BoundsOnRatiosInTupleSketchedSets.</span><code><span class="memberNameLink"><a href="../../thetacommon/BoundsOnRatiosInTupleSketchedSets.html#getUpperBoundForBoverA(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.theta.Sketch)">getUpperBoundForBoverA</a></span>​(<a href="../../tuple/Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> sketchA, |
| <a href="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> sketchB)</code></th> |
| <td class="colLast"> |
| <div class="block">Gets the approximate upper bound for B over A based on a 95% confidence interval</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section><a id="org.apache.datasketches.tuple"> |
| <!-- --> |
| </a> |
| <h3>Uses of <a href="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> in <a href="../../tuple/package-summary.html">org.apache.datasketches.tuple</a></h3> |
| <table class="useSummary"> |
| <caption><span>Methods in <a href="../../tuple/package-summary.html">org.apache.datasketches.tuple</a> with parameters of type <a href="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a></span><span class="tabEnd"> </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 <S extends <a href="../../tuple/Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>><br><a href="../../tuple/CompactSketch.html" title="class in org.apache.datasketches.tuple">CompactSketch</a><S></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">AnotB.</span><code><span class="memberNameLink"><a href="../../tuple/AnotB.html#aNotB(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.theta.Sketch)">aNotB</a></span>​(<a href="../../tuple/Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> skA, |
| <a href="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> skB)</code></th> |
| <td class="colLast"> |
| <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 <S extends <a href="../../tuple/Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>><br>boolean</code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">JaccardSimilarity.</span><code><span class="memberNameLink"><a href="../../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="../../tuple/Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> measured, |
| <a href="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> expected, |
| S summary, |
| <a href="../../tuple/SummarySetOperations.html" title="interface in org.apache.datasketches.tuple">SummarySetOperations</a><S> summarySetOps, |
| double 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 <S extends <a href="../../tuple/Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>><br>boolean</code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">JaccardSimilarity.</span><code><span class="memberNameLink"><a href="../../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="../../tuple/Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> sketchA, |
| <a href="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> sketchB, |
| S summary, |
| <a href="../../tuple/SummarySetOperations.html" title="interface in org.apache.datasketches.tuple">SummarySetOperations</a><S> 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>void</code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">Intersection.</span><code><span class="memberNameLink"><a href="../../tuple/Intersection.html#intersect(org.apache.datasketches.theta.Sketch,S)">intersect</a></span>​(<a href="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> thetaSketch, |
| <a href="../../tuple/Intersection.html" title="type parameter in Intersection">S</a> summary)</code></th> |
| <td class="colLast"> |
| <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="altColor"> |
| <td class="colFirst"><code><a href="../../tuple/CompactSketch.html" title="class in org.apache.datasketches.tuple">CompactSketch</a><<a href="../../tuple/Intersection.html" title="type parameter in Intersection">S</a>></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">Intersection.</span><code><span class="memberNameLink"><a href="../../tuple/Intersection.html#intersect(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.theta.Sketch,S)">intersect</a></span>​(<a href="../../tuple/Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><<a href="../../tuple/Intersection.html" title="type parameter in Intersection">S</a>> tupleSketch, |
| <a href="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> thetaSketch, |
| <a href="../../tuple/Intersection.html" title="type parameter in Intersection">S</a> summary)</code></th> |
| <td class="colLast"> |
| <div class="block">Perform a stateless intersect set operation on a tuple sketch and a theta sketch and returns the |
| result as an unordered CompactSketch on the heap.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <S extends <a href="../../tuple/Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>><br>double[]</code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">JaccardSimilarity.</span><code><span class="memberNameLink"><a href="../../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="../../tuple/Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> sketchA, |
| <a href="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> sketchB, |
| S summary, |
| <a href="../../tuple/SummarySetOperations.html" title="interface in org.apache.datasketches.tuple">SummarySetOperations</a><S> 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>void</code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">AnotB.</span><code><span class="memberNameLink"><a href="../../tuple/AnotB.html#notB(org.apache.datasketches.theta.Sketch)">notB</a></span>​(<a href="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> skB)</code></th> |
| <td class="colLast"> |
| <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 <S extends <a href="../../tuple/Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>><br>boolean</code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">JaccardSimilarity.</span><code><span class="memberNameLink"><a href="../../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="../../tuple/Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> measured, |
| <a href="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> expected, |
| S summary, |
| <a href="../../tuple/SummarySetOperations.html" title="interface in org.apache.datasketches.tuple">SummarySetOperations</a><S> summarySetOps, |
| double threshold)</code></th> |
| <td class="colLast"> |
| <div class="block">Tests similarity of a measured Sketch against an expected Sketch.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">Union.</span><code><span class="memberNameLink"><a href="../../tuple/Union.html#union(org.apache.datasketches.theta.Sketch,S)">union</a></span>​(<a href="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> thetaSketch, |
| <a href="../../tuple/Union.html" title="type parameter in Union">S</a> summary)</code></th> |
| <td class="colLast"> |
| <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> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../tuple/CompactSketch.html" title="class in org.apache.datasketches.tuple">CompactSketch</a><<a href="../../tuple/Union.html" title="type parameter in Union">S</a>></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">Union.</span><code><span class="memberNameLink"><a href="../../tuple/Union.html#union(org.apache.datasketches.tuple.Sketch,org.apache.datasketches.theta.Sketch,S)">union</a></span>​(<a href="../../tuple/Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><<a href="../../tuple/Union.html" title="type parameter in Union">S</a>> tupleSketch, |
| <a href="../Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> thetaSketch, |
| <a href="../../tuple/Union.html" title="type parameter in Union">S</a> summary)</code></th> |
| <td class="colLast"> |
| <div class="block">Perform a stateless, pair-wise union operation between a tupleSketch and a thetaSketch.</div> |
| </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="../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" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../allclasses.html">All 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 © 2015–2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </body> |
| </html> |
