| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (1.8.0_162) on Thu Oct 25 17:06:10 PDT 2018 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>JaccardSimilarity (com.yahoo.datasketches:sketches-core 0.12.1-SNAPSHOT API)</title> |
| <meta name="date" content="2018-10-25"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="JaccardSimilarity (com.yahoo.datasketches:sketches-core 0.12.1-SNAPSHOT API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":9,"i1":9,"i2":9,"i3":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"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li 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="../../../../com/yahoo/sketches/theta/Intersection.html" title="class in com.yahoo.sketches.theta"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../com/yahoo/sketches/theta/PairwiseSetOperations.html" title="class in com.yahoo.sketches.theta"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?com/yahoo/sketches/theta/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> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <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 ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">com.yahoo.sketches.theta</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/8/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>com.yahoo.sketches.theta.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/8/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 Theta Sketches.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Author:</span></dt> |
| <dd>Lee Rhodes</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" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../com/yahoo/sketches/theta/JaccardSimilarity.html#JaccardSimilarity--">JaccardSimilarity</a></span>()</code> </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" border="0" cellpadding="3" cellspacing="0" 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="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>static boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/yahoo/sketches/theta/JaccardSimilarity.html#dissimilarityTest-com.yahoo.sketches.theta.Sketch-com.yahoo.sketches.theta.Sketch-double-">dissimilarityTest</a></span>(<a href="../../../../com/yahoo/sketches/theta/Sketch.html" title="class in com.yahoo.sketches.theta">Sketch</a> measured, |
| <a href="../../../../com/yahoo/sketches/theta/Sketch.html" title="class in com.yahoo.sketches.theta">Sketch</a> expected, |
| double threshold)</code> |
| <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 boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/yahoo/sketches/theta/JaccardSimilarity.html#exactlyEqual-com.yahoo.sketches.theta.Sketch-com.yahoo.sketches.theta.Sketch-">exactlyEqual</a></span>(<a href="../../../../com/yahoo/sketches/theta/Sketch.html" title="class in com.yahoo.sketches.theta">Sketch</a> sketchA, |
| <a href="../../../../com/yahoo/sketches/theta/Sketch.html" title="class in com.yahoo.sketches.theta">Sketch</a> sketchB)</code> |
| <div class="block">Returns true if the two given sketches have exactly the same hash values and the same |
| theta values.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>static double[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/yahoo/sketches/theta/JaccardSimilarity.html#jaccard-com.yahoo.sketches.theta.Sketch-com.yahoo.sketches.theta.Sketch-">jaccard</a></span>(<a href="../../../../com/yahoo/sketches/theta/Sketch.html" title="class in com.yahoo.sketches.theta">Sketch</a> sketchA, |
| <a href="../../../../com/yahoo/sketches/theta/Sketch.html" title="class in com.yahoo.sketches.theta">Sketch</a> sketchB)</code> |
| <div class="block">Computes the Jaccard similarity ratio with upper and lower bounds.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>static boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/yahoo/sketches/theta/JaccardSimilarity.html#similarityTest-com.yahoo.sketches.theta.Sketch-com.yahoo.sketches.theta.Sketch-double-">similarityTest</a></span>(<a href="../../../../com/yahoo/sketches/theta/Sketch.html" title="class in com.yahoo.sketches.theta">Sketch</a> measured, |
| <a href="../../../../com/yahoo/sketches/theta/Sketch.html" title="class in com.yahoo.sketches.theta">Sketch</a> expected, |
| double threshold)</code> |
| <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/8/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/8/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/8/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/8/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/8/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/8/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/8/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/8/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/8/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/8/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/8/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/8/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-com.yahoo.sketches.theta.Sketch-com.yahoo.sketches.theta.Sketch-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>jaccard</h4> |
| <pre>public static double[] jaccard(<a href="../../../../com/yahoo/sketches/theta/Sketch.html" title="class in com.yahoo.sketches.theta">Sketch</a> sketchA, |
| <a href="../../../../com/yahoo/sketches/theta/Sketch.html" title="class in com.yahoo.sketches.theta">Sketch</a> sketchB)</pre> |
| <div class="block">Computes the Jaccard similarity ratio with upper and lower bounds. The Jaccard similarity ratio |
| <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">Parameters:</span></dt> |
| <dd><code>sketchA</code> - given sketch A</dd> |
| <dd><code>sketchB</code> - given sketch B</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a double array {LowerBound, Estimate, UpperBound} of the Jaccard ratio. |
| The Upper and Lower bounds are for a confidence interval of 95.4% or +/- 2 standard deviations.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="exactlyEqual-com.yahoo.sketches.theta.Sketch-com.yahoo.sketches.theta.Sketch-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>exactlyEqual</h4> |
| <pre>public static boolean exactlyEqual(<a href="../../../../com/yahoo/sketches/theta/Sketch.html" title="class in com.yahoo.sketches.theta">Sketch</a> sketchA, |
| <a href="../../../../com/yahoo/sketches/theta/Sketch.html" title="class in com.yahoo.sketches.theta">Sketch</a> sketchB)</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">Parameters:</span></dt> |
| <dd><code>sketchA</code> - the given sketch A</dd> |
| <dd><code>sketchB</code> - the given sketch B</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-com.yahoo.sketches.theta.Sketch-com.yahoo.sketches.theta.Sketch-double-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>similarityTest</h4> |
| <pre>public static boolean similarityTest(<a href="../../../../com/yahoo/sketches/theta/Sketch.html" title="class in com.yahoo.sketches.theta">Sketch</a> measured, |
| <a href="../../../../com/yahoo/sketches/theta/Sketch.html" title="class in com.yahoo.sketches.theta">Sketch</a> expected, |
| double threshold)</pre> |
| <div class="block">Tests similarity of a measured Sketch against an expected Sketch. |
| Computes the lower bound of the Jaccard ratio <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">Parameters:</span></dt> |
| <dd><code>measured</code> - the sketch to be tested</dd> |
| <dd><code>expected</code> - the reference sketch that is considered to be correct.</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-com.yahoo.sketches.theta.Sketch-com.yahoo.sketches.theta.Sketch-double-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>dissimilarityTest</h4> |
| <pre>public static boolean dissimilarityTest(<a href="../../../../com/yahoo/sketches/theta/Sketch.html" title="class in com.yahoo.sketches.theta">Sketch</a> measured, |
| <a href="../../../../com/yahoo/sketches/theta/Sketch.html" title="class in com.yahoo.sketches.theta">Sketch</a> expected, |
| double threshold)</pre> |
| <div class="block">Tests dissimilarity of a measured Sketch against an expected Sketch. |
| Computes the upper bound of the Jaccard ratio <i>J<sub>LB</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">Parameters:</span></dt> |
| <dd><code>measured</code> - the sketch to be tested</dd> |
| <dd><code>expected</code> - the reference sketch that is considered to be correct.</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="../../../../com/yahoo/sketches/theta/Intersection.html" title="class in com.yahoo.sketches.theta"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../com/yahoo/sketches/theta/PairwiseSetOperations.html" title="class in com.yahoo.sketches.theta"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?com/yahoo/sketches/theta/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> |
| </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–2018. All rights reserved.</small></p> |
| </body> |
| </html> |
