| <!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 (9) on Fri Oct 01 19:18:48 PDT 2021 --> |
| <title>JaccardSimilarity (datasketches-java 3.1.0-SNAPSHOT API)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="date" content="2021-10-01"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.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-1.10.2.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jquery-ui.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="JaccardSimilarity (datasketches-java 3.1.0-SNAPSHOT API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9,"i5":9,"i6":9,"i7":9}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| var pathtoroot = "../../../../";loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="fixedNav"> |
| <!-- ========= 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 class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/JaccardSimilarity.html">Use</a></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><a href="../../../../org/apache/datasketches/tuple/Intersection.html" title="class in org.apache.datasketches.tuple"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/datasketches/tuple/SerializerDeserializer.html" title="class in org.apache.datasketches.tuple"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/datasketches/tuple/JaccardSimilarity.html" target="_top">Frames</a></li> |
| <li><a href="JaccardSimilarity.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <ul class="navListSearch"> |
| <li><span>SEARCH: </span> |
| <input type="text" id="search" value=" " disabled="disabled"> |
| <input type="reset" id="reset" value=" " 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> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="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> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle"><span class="packageLabelInType">Package</span> <a href="../../../../org/apache/datasketches/tuple/package-summary.html">org.apache.datasketches.tuple</a></div> |
| <h2 title="Class JaccardSimilarity" class="title">Class JaccardSimilarity</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.datasketches.tuple.JaccardSimilarity</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public final class <span class="typeNameLabel">JaccardSimilarity</span> |
| extends <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre> |
| <div class="block">Jaccard similarity of two Tuple Sketches, or alternatively, of a Tuple and Theta Sketch. |
| |
| <p>Note: only retained hash values are compared, and the Tuple summary values are not accounted for in the |
| similarity measure.</p></div> |
| <dl> |
| <dt><span class="simpleTagLabel">Author:</span></dt> |
| <dd>Lee Rhodes, David Cromberge</dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Constructor</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="../../../../org/apache/datasketches/tuple/JaccardSimilarity.html#JaccardSimilarity--">JaccardSimilarity</a></span>​()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></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> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>static <S extends <a href="../../../../org/apache/datasketches/tuple/Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>><br>boolean</code></td> |
| <th class="colSecond" scope="row"><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><S> measured, |
| <a href="../../../../org/apache/datasketches/theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> expected, |
| S summary, |
| <a href="../../../../org/apache/datasketches/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 id="i1" class="rowColor"> |
| <td class="colFirst"><code>static <S extends <a href="../../../../org/apache/datasketches/tuple/Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>><br>boolean</code></td> |
| <th class="colSecond" scope="row"><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><S> measured, |
| <a href="../../../../org/apache/datasketches/tuple/Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> expected, |
| <a href="../../../../org/apache/datasketches/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 id="i2" class="altColor"> |
| <td class="colFirst"><code>static <S extends <a href="../../../../org/apache/datasketches/tuple/Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>><br>boolean</code></td> |
| <th class="colSecond" scope="row"><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><S> sketchA, |
| <a href="../../../../org/apache/datasketches/theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> sketchB, |
| S summary, |
| <a href="../../../../org/apache/datasketches/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 id="i3" class="rowColor"> |
| <td class="colFirst"><code>static <S extends <a href="../../../../org/apache/datasketches/tuple/Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>><br>boolean</code></td> |
| <th class="colSecond" scope="row"><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><S> sketchA, |
| <a href="../../../../org/apache/datasketches/tuple/Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> sketchB, |
| <a href="../../../../org/apache/datasketches/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 id="i4" class="altColor"> |
| <td class="colFirst"><code>static <S extends <a href="../../../../org/apache/datasketches/tuple/Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>><br>double[]</code></td> |
| <th class="colSecond" scope="row"><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><S> sketchA, |
| <a href="../../../../org/apache/datasketches/theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> sketchB, |
| S summary, |
| <a href="../../../../org/apache/datasketches/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 id="i5" class="rowColor"> |
| <td class="colFirst"><code>static <S extends <a href="../../../../org/apache/datasketches/tuple/Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>><br>double[]</code></td> |
| <th class="colSecond" scope="row"><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><S> sketchA, |
| <a href="../../../../org/apache/datasketches/tuple/Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> sketchB, |
| <a href="../../../../org/apache/datasketches/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 id="i6" class="altColor"> |
| <td class="colFirst"><code>static <S extends <a href="../../../../org/apache/datasketches/tuple/Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>><br>boolean</code></td> |
| <th class="colSecond" scope="row"><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><S> measured, |
| <a href="../../../../org/apache/datasketches/theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> expected, |
| S summary, |
| <a href="../../../../org/apache/datasketches/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 id="i7" class="rowColor"> |
| <td class="colFirst"><code>static <S extends <a href="../../../../org/apache/datasketches/tuple/Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>><br>boolean</code></td> |
| <th class="colSecond" scope="row"><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><S> measured, |
| <a href="../../../../org/apache/datasketches/tuple/Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> expected, |
| <a href="../../../../org/apache/datasketches/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> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="JaccardSimilarity--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>JaccardSimilarity</h4> |
| <pre>public JaccardSimilarity​()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="jaccard-org.apache.datasketches.tuple.Sketch-org.apache.datasketches.tuple.Sketch-org.apache.datasketches.tuple.SummarySetOperations-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>jaccard</h4> |
| <pre>public static <S extends <a href="../../../../org/apache/datasketches/tuple/Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>> double[] jaccard​(<a href="../../../../org/apache/datasketches/tuple/Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> sketchA, |
| <a href="../../../../org/apache/datasketches/tuple/Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> sketchB, |
| <a href="../../../../org/apache/datasketches/tuple/SummarySetOperations.html" title="interface in org.apache.datasketches.tuple">SummarySetOperations</a><S> summarySetOps)</pre> |
| <div class="block">Computes the Jaccard similarity index with upper and lower bounds. The Jaccard similarity index |
| <i>J(A,B) = (A ^ B)/(A U B)</i> is used to measure how similar the two sketches are to each |
| other. If J = 1.0, the sketches are considered equal. If J = 0, the two sketches are |
| distinct from each other. A Jaccard of .95 means the overlap between the two |
| populations is 95% of the union of the two populations. |
| |
| <p>Note: For very large pairs of sketches, where the configured nominal entries of the sketches |
| are 2^25 or 2^26, this method may produce unpredictable results.</div> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>S</code> - Summary</dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>sketchA</code> - The first argument, a Tuple sketch with summary type <i>S</i></dd> |
| <dd><code>sketchB</code> - The second argument, a Tuple sketch with summary type <i>S</i></dd> |
| <dd><code>summarySetOps</code> - instance of SummarySetOperations used to unify or intersect summaries.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a double array {LowerBound, Estimate, UpperBound} of the Jaccard index. |
| The Upper and Lower bounds are for a confidence interval of 95.4% or +/- 2 standard deviations.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="jaccard-org.apache.datasketches.tuple.Sketch-org.apache.datasketches.theta.Sketch-org.apache.datasketches.tuple.Summary-org.apache.datasketches.tuple.SummarySetOperations-"> |
| <!-- --> |
| </a><a name="jaccard-org.apache.datasketches.tuple.Sketch-org.apache.datasketches.theta.Sketch-S-org.apache.datasketches.tuple.SummarySetOperations-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>jaccard</h4> |
| <pre>public static <S extends <a href="../../../../org/apache/datasketches/tuple/Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>> double[] jaccard​(<a href="../../../../org/apache/datasketches/tuple/Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> sketchA, |
| <a href="../../../../org/apache/datasketches/theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> sketchB, |
| S summary, |
| <a href="../../../../org/apache/datasketches/tuple/SummarySetOperations.html" title="interface in org.apache.datasketches.tuple">SummarySetOperations</a><S> summarySetOps)</pre> |
| <div class="block">Computes the Jaccard similarity index with upper and lower bounds. The Jaccard similarity index |
| <i>J(A,B) = (A ^ B)/(A U B)</i> is used to measure how similar the two sketches are to each |
| other. If J = 1.0, the sketches are considered equal. If J = 0, the two sketches are |
| distinct from each other. A Jaccard of .95 means the overlap between the two |
| populations is 95% of the union of the two populations. |
| |
| <p>Note: For very large pairs of sketches, where the configured nominal entries of the sketches |
| are 2^25 or 2^26, this method may produce unpredictable results.</div> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>S</code> - Summary</dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>sketchA</code> - The first argument, a Tuple sketch with summary type <i>S</i></dd> |
| <dd><code>sketchB</code> - The second argument, a Theta sketch</dd> |
| <dd><code>summary</code> - the given proxy summary for the theta sketch, which doesn't have one. |
| This may not be null.</dd> |
| <dd><code>summarySetOps</code> - instance of SummarySetOperations used to unify or intersect summaries.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a double array {LowerBound, Estimate, UpperBound} of the Jaccard index. |
| The Upper and Lower bounds are for a confidence interval of 95.4% or +/- 2 standard deviations.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="exactlyEqual-org.apache.datasketches.tuple.Sketch-org.apache.datasketches.tuple.Sketch-org.apache.datasketches.tuple.SummarySetOperations-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>exactlyEqual</h4> |
| <pre>public static <S extends <a href="../../../../org/apache/datasketches/tuple/Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>> boolean exactlyEqual​(<a href="../../../../org/apache/datasketches/tuple/Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> sketchA, |
| <a href="../../../../org/apache/datasketches/tuple/Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> sketchB, |
| <a href="../../../../org/apache/datasketches/tuple/SummarySetOperations.html" title="interface in org.apache.datasketches.tuple">SummarySetOperations</a><S> summarySetOps)</pre> |
| <div class="block">Returns true if the two given sketches have exactly the same hash values and the same |
| theta values. Thus, they are equivalent.</div> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>S</code> - Summary</dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>sketchA</code> - The first argument, a Tuple sketch with summary type <i>S</i></dd> |
| <dd><code>sketchB</code> - The second argument, a Tuple sketch with summary type <i>S</i></dd> |
| <dd><code>summarySetOps</code> - instance of SummarySetOperations used to unify or intersect summaries.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if the two given sketches have exactly the same hash values and the same |
| theta values.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="exactlyEqual-org.apache.datasketches.tuple.Sketch-org.apache.datasketches.theta.Sketch-org.apache.datasketches.tuple.Summary-org.apache.datasketches.tuple.SummarySetOperations-"> |
| <!-- --> |
| </a><a name="exactlyEqual-org.apache.datasketches.tuple.Sketch-org.apache.datasketches.theta.Sketch-S-org.apache.datasketches.tuple.SummarySetOperations-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>exactlyEqual</h4> |
| <pre>public static <S extends <a href="../../../../org/apache/datasketches/tuple/Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>> boolean exactlyEqual​(<a href="../../../../org/apache/datasketches/tuple/Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> sketchA, |
| <a href="../../../../org/apache/datasketches/theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> sketchB, |
| S summary, |
| <a href="../../../../org/apache/datasketches/tuple/SummarySetOperations.html" title="interface in org.apache.datasketches.tuple">SummarySetOperations</a><S> summarySetOps)</pre> |
| <div class="block">Returns true if the two given sketches have exactly the same hash values and the same |
| theta values. Thus, they are equivalent.</div> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>S</code> - Summary</dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>sketchA</code> - The first argument, a Tuple sketch with summary type <i>S</i></dd> |
| <dd><code>sketchB</code> - The second argument, a Theta sketch</dd> |
| <dd><code>summary</code> - the given proxy summary for the theta sketch, which doesn't have one. |
| This may not be null.</dd> |
| <dd><code>summarySetOps</code> - instance of SummarySetOperations used to unify or intersect summaries.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if the two given sketches have exactly the same hash values and the same |
| theta values.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="similarityTest-org.apache.datasketches.tuple.Sketch-org.apache.datasketches.tuple.Sketch-org.apache.datasketches.tuple.SummarySetOperations-double-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>similarityTest</h4> |
| <pre>public static <S extends <a href="../../../../org/apache/datasketches/tuple/Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>> boolean similarityTest​(<a href="../../../../org/apache/datasketches/tuple/Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> measured, |
| <a href="../../../../org/apache/datasketches/tuple/Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> expected, |
| <a href="../../../../org/apache/datasketches/tuple/SummarySetOperations.html" title="interface in org.apache.datasketches.tuple">SummarySetOperations</a><S> summarySetOps, |
| double threshold)</pre> |
| <div class="block">Tests similarity of a measured Sketch against an expected Sketch. |
| Computes the lower bound of the Jaccard index <i>J<sub>LB</sub></i> of the measured and |
| expected sketches. |
| if <i>J<sub>LB</sub> ≥ threshold</i>, then the sketches are considered to be |
| similar with a confidence of 97.7%.</div> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>S</code> - Summary</dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>measured</code> - a Tuple sketch with summary type <i>S</i> to be tested</dd> |
| <dd><code>expected</code> - the reference Tuple sketch with summary type <i>S</i> that is considered to be correct.</dd> |
| <dd><code>summarySetOps</code> - instance of SummarySetOperations used to unify or intersect summaries.</dd> |
| <dd><code>threshold</code> - a real value between zero and one.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>if true, the similarity of the two sketches is greater than the given threshold |
| with at least 97.7% confidence.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="similarityTest-org.apache.datasketches.tuple.Sketch-org.apache.datasketches.theta.Sketch-org.apache.datasketches.tuple.Summary-org.apache.datasketches.tuple.SummarySetOperations-double-"> |
| <!-- --> |
| </a><a name="similarityTest-org.apache.datasketches.tuple.Sketch-org.apache.datasketches.theta.Sketch-S-org.apache.datasketches.tuple.SummarySetOperations-double-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>similarityTest</h4> |
| <pre>public static <S extends <a href="../../../../org/apache/datasketches/tuple/Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>> boolean similarityTest​(<a href="../../../../org/apache/datasketches/tuple/Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> measured, |
| <a href="../../../../org/apache/datasketches/theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> expected, |
| S summary, |
| <a href="../../../../org/apache/datasketches/tuple/SummarySetOperations.html" title="interface in org.apache.datasketches.tuple">SummarySetOperations</a><S> summarySetOps, |
| double threshold)</pre> |
| <div class="block">Tests similarity of a measured Sketch against an expected Sketch. |
| Computes the lower bound of the Jaccard index <i>J<sub>LB</sub></i> of the measured and |
| expected sketches. |
| if <i>J<sub>LB</sub> ≥ threshold</i>, then the sketches are considered to be |
| similar with a confidence of 97.7%.</div> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>S</code> - Summary</dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>measured</code> - a Tuple sketch with summary type <i>S</i> to be tested</dd> |
| <dd><code>expected</code> - the reference Theta sketch that is considered to be correct.</dd> |
| <dd><code>summary</code> - the given proxy summary for the theta sketch, which doesn't have one. |
| This may not be null.</dd> |
| <dd><code>summarySetOps</code> - instance of SummarySetOperations used to unify or intersect summaries.</dd> |
| <dd><code>threshold</code> - a real value between zero and one.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>if true, the similarity of the two sketches is greater than the given threshold |
| with at least 97.7% confidence.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="dissimilarityTest-org.apache.datasketches.tuple.Sketch-org.apache.datasketches.tuple.Sketch-org.apache.datasketches.tuple.SummarySetOperations-double-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>dissimilarityTest</h4> |
| <pre>public static <S extends <a href="../../../../org/apache/datasketches/tuple/Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>> boolean dissimilarityTest​(<a href="../../../../org/apache/datasketches/tuple/Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> measured, |
| <a href="../../../../org/apache/datasketches/tuple/Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> expected, |
| <a href="../../../../org/apache/datasketches/tuple/SummarySetOperations.html" title="interface in org.apache.datasketches.tuple">SummarySetOperations</a><S> summarySetOps, |
| double threshold)</pre> |
| <div class="block">Tests dissimilarity of a measured Sketch against an expected Sketch. |
| Computes the upper bound of the Jaccard index <i>J<sub>UB</sub></i> of the measured and |
| expected sketches. |
| if <i>J<sub>UB</sub> ≤ threshold</i>, then the sketches are considered to be |
| dissimilar with a confidence of 97.7%.</div> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>S</code> - Summary</dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>measured</code> - a Tuple sketch with summary type <i>S</i> to be tested</dd> |
| <dd><code>expected</code> - the reference Theta sketch that is considered to be correct.</dd> |
| <dd><code>summarySetOps</code> - instance of SummarySetOperations used to unify or intersect summaries.</dd> |
| <dd><code>threshold</code> - a real value between zero and one.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>if true, the dissimilarity of the two sketches is greater than the given threshold |
| with at least 97.7% confidence.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="dissimilarityTest-org.apache.datasketches.tuple.Sketch-org.apache.datasketches.theta.Sketch-org.apache.datasketches.tuple.Summary-org.apache.datasketches.tuple.SummarySetOperations-double-"> |
| <!-- --> |
| </a><a name="dissimilarityTest-org.apache.datasketches.tuple.Sketch-org.apache.datasketches.theta.Sketch-S-org.apache.datasketches.tuple.SummarySetOperations-double-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>dissimilarityTest</h4> |
| <pre>public static <S extends <a href="../../../../org/apache/datasketches/tuple/Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>> boolean dissimilarityTest​(<a href="../../../../org/apache/datasketches/tuple/Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S> measured, |
| <a href="../../../../org/apache/datasketches/theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> expected, |
| S summary, |
| <a href="../../../../org/apache/datasketches/tuple/SummarySetOperations.html" title="interface in org.apache.datasketches.tuple">SummarySetOperations</a><S> summarySetOps, |
| double threshold)</pre> |
| <div class="block">Tests dissimilarity of a measured Sketch against an expected Sketch. |
| Computes the upper bound of the Jaccard index <i>J<sub>UB</sub></i> of the measured and |
| expected sketches. |
| if <i>J<sub>UB</sub> ≤ threshold</i>, then the sketches are considered to be |
| dissimilar with a confidence of 97.7%.</div> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>S</code> - Summary</dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>measured</code> - a Tuple sketch with summary type <i>S</i> to be tested</dd> |
| <dd><code>expected</code> - the reference Theta sketch that is considered to be correct.</dd> |
| <dd><code>summary</code> - the given proxy summary for the theta sketch, which doesn't have one. |
| This may not be null.</dd> |
| <dd><code>summarySetOps</code> - instance of SummarySetOperations used to unify or intersect summaries.</dd> |
| <dd><code>threshold</code> - a real value between zero and one.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>if true, the dissimilarity of the two sketches is greater than the given threshold |
| with at least 97.7% confidence.</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= 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 class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/JaccardSimilarity.html">Use</a></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><a href="../../../../org/apache/datasketches/tuple/Intersection.html" title="class in org.apache.datasketches.tuple"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/datasketches/tuple/SerializerDeserializer.html" title="class in org.apache.datasketches.tuple"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/datasketches/tuple/JaccardSimilarity.html" target="_top">Frames</a></li> |
| <li><a href="JaccardSimilarity.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses-noframe.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> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2015–2021 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |