| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| <html xmlns="http://www.w3.org/1999/xhtml" lang="en-US"> |
| <head> |
| <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
| <meta http-equiv="X-UA-Compatible" content="IE=11"/> |
| <meta name="generator" content="Doxygen 1.9.8"/> |
| <meta name="viewport" content="width=device-width, initial-scale=1"/> |
| <title>datasketches-cpp: jaccard_similarity_base< Union, Intersection, ExtractKey > Class Template Reference</title> |
| <link href="tabs.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="jquery.js"></script> |
| <script type="text/javascript" src="dynsections.js"></script> |
| <link href="search/search.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="search/searchdata.js"></script> |
| <script type="text/javascript" src="search/search.js"></script> |
| <link href="doxygen.css" rel="stylesheet" type="text/css" /> |
| </head> |
| <body> |
| <div id="top"><!-- do not remove this div, it is closed by doxygen! --> |
| <div id="titlearea"> |
| <table cellspacing="0" cellpadding="0"> |
| <tbody> |
| <tr id="projectrow"> |
| <td id="projectalign"> |
| <div id="projectname">datasketches-cpp |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.9.8 --> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ |
| var searchBox = new SearchBox("searchBox", "search/",'.html'); |
| /* @license-end */ |
| </script> |
| <script type="text/javascript" src="menudata.js"></script> |
| <script type="text/javascript" src="menu.js"></script> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ |
| $(function() { |
| initMenu('',true,false,'search.php','Search'); |
| $(document).ready(function() { init_search(); }); |
| }); |
| /* @license-end */ |
| </script> |
| <div id="main-nav"></div> |
| <!-- window showing the filter options --> |
| <div id="MSearchSelectWindow" |
| onmouseover="return searchBox.OnSearchSelectShow()" |
| onmouseout="return searchBox.OnSearchSelectHide()" |
| onkeydown="return searchBox.OnSearchSelectKey(event)"> |
| </div> |
| |
| <!-- iframe showing the search results (closed by default) --> |
| <div id="MSearchResultsWindow"> |
| <div id="MSearchResults"> |
| <div class="SRPage"> |
| <div id="SRIndex"> |
| <div id="SRResults"></div> |
| <div class="SRStatus" id="Loading">Loading...</div> |
| <div class="SRStatus" id="Searching">Searching...</div> |
| <div class="SRStatus" id="NoMatches">No Matches</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="nav-path" class="navpath"> |
| <ul> |
| <li class="navelem"><a class="el" href="namespacedatasketches.html">datasketches</a></li><li class="navelem"><a class="el" href="classdatasketches_1_1jaccard__similarity__base.html">jaccard_similarity_base</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-static-methods">Static Public Member Functions</a> | |
| <a href="classdatasketches_1_1jaccard__similarity__base-members.html">List of all members</a> </div> |
| <div class="headertitle"><div class="title">jaccard_similarity_base< Union, Intersection, ExtractKey > Class Template Reference</div></div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Base class for Jaccard similarity. |
| <a href="classdatasketches_1_1jaccard__similarity__base.html#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="theta__jaccard__similarity__base_8hpp_source.html">theta_jaccard_similarity_base.hpp</a>></code></p> |
| <table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-methods" name="pub-static-methods"></a> |
| Static Public Member Functions</h2></td></tr> |
| <tr class="memitem:a8a2af62ca89e1120a6019ee10cd90e04" id="r_a8a2af62ca89e1120a6019ee10cd90e04"><td class="memTemplParams" colspan="2">template<typename SketchA , typename SketchB > </td></tr> |
| <tr class="memitem:a8a2af62ca89e1120a6019ee10cd90e04"><td class="memTemplItemLeft" align="right" valign="top">static std::array< double, 3 > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1jaccard__similarity__base.html#a8a2af62ca89e1120a6019ee10cd90e04">jaccard</a> (const SketchA &sketch_a, const SketchB &sketch_b, uint64_t seed=DEFAULT_SEED)</td></tr> |
| <tr class="memdesc:a8a2af62ca89e1120a6019ee10cd90e04"><td class="mdescLeft"> </td><td class="mdescRight">Computes the Jaccard similarity index with upper and lower bounds. <br /></td></tr> |
| <tr class="separator:a8a2af62ca89e1120a6019ee10cd90e04"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a18c18c5c7351430540000bf360f523fc" id="r_a18c18c5c7351430540000bf360f523fc"><td class="memTemplParams" colspan="2">template<typename SketchA , typename SketchB > </td></tr> |
| <tr class="memitem:a18c18c5c7351430540000bf360f523fc"><td class="memTemplItemLeft" align="right" valign="top">static bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1jaccard__similarity__base.html#a18c18c5c7351430540000bf360f523fc">exactly_equal</a> (const SketchA &sketch_a, const SketchB &sketch_b, uint64_t seed=DEFAULT_SEED)</td></tr> |
| <tr class="memdesc:a18c18c5c7351430540000bf360f523fc"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if the two given sketches are equivalent. <br /></td></tr> |
| <tr class="separator:a18c18c5c7351430540000bf360f523fc"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a919ce3dd7d15658fe67eb359368e9f07" id="r_a919ce3dd7d15658fe67eb359368e9f07"><td class="memTemplParams" colspan="2">template<typename SketchA , typename SketchB > </td></tr> |
| <tr class="memitem:a919ce3dd7d15658fe67eb359368e9f07"><td class="memTemplItemLeft" align="right" valign="top">static bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1jaccard__similarity__base.html#a919ce3dd7d15658fe67eb359368e9f07">similarity_test</a> (const SketchA &actual, const SketchB &expected, double threshold, uint64_t seed=DEFAULT_SEED)</td></tr> |
| <tr class="memdesc:a919ce3dd7d15658fe67eb359368e9f07"><td class="mdescLeft"> </td><td class="mdescRight">Tests similarity of an actual Sketch against an expected Sketch. <br /></td></tr> |
| <tr class="separator:a919ce3dd7d15658fe67eb359368e9f07"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a5bc3426c328c625eb345a5c00c755004" id="r_a5bc3426c328c625eb345a5c00c755004"><td class="memTemplParams" colspan="2">template<typename SketchA , typename SketchB > </td></tr> |
| <tr class="memitem:a5bc3426c328c625eb345a5c00c755004"><td class="memTemplItemLeft" align="right" valign="top">static bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1jaccard__similarity__base.html#a5bc3426c328c625eb345a5c00c755004">dissimilarity_test</a> (const SketchA &actual, const SketchB &expected, double threshold, uint64_t seed=DEFAULT_SEED)</td></tr> |
| <tr class="memdesc:a5bc3426c328c625eb345a5c00c755004"><td class="mdescLeft"> </td><td class="mdescRight">Tests dissimilarity of an actual Sketch against an expected Sketch. <br /></td></tr> |
| <tr class="separator:a5bc3426c328c625eb345a5c00c755004"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><div class="compoundTemplParams">template<typename Union, typename Intersection, typename ExtractKey><br /> |
| class datasketches::jaccard_similarity_base< Union, Intersection, ExtractKey ></div><p>Base class for Jaccard similarity. </p> |
| </div><h2 class="groupheader">Member Function Documentation</h2> |
| <a id="a8a2af62ca89e1120a6019ee10cd90e04" name="a8a2af62ca89e1120a6019ee10cd90e04"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a8a2af62ca89e1120a6019ee10cd90e04">◆ </a></span>jaccard()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename Union , typename Intersection , typename ExtractKey > </div> |
| <div class="memtemplate"> |
| template<typename SketchA , typename SketchB > </div> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">static std::array< double, 3 > jaccard </td> |
| <td>(</td> |
| <td class="paramtype">const SketchA & </td> |
| <td class="paramname"><em>sketch_a</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const SketchB & </td> |
| <td class="paramname"><em>sketch_b</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">uint64_t </td> |
| <td class="paramname"><em>seed</em> = <code>DEFAULT_SEED</code> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Computes the Jaccard similarity index with upper and lower bounds. </p> |
| <p>The Jaccard similarity index <em>J(A,B) = (A ^ B)/(A U B)</em> 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 disjoint. A Jaccard of .95 means the overlap between the two sets is 95% of the union of the two sets.</p> |
| <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.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">sketch_a</td><td>given sketch A </td></tr> |
| <tr><td class="paramname">sketch_b</td><td>given sketch B </td></tr> |
| <tr><td class="paramname">seed</td><td>for the hash function that was used to create the sketch </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</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> |
| |
| </div> |
| </div> |
| <a id="a18c18c5c7351430540000bf360f523fc" name="a18c18c5c7351430540000bf360f523fc"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a18c18c5c7351430540000bf360f523fc">◆ </a></span>exactly_equal()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename Union , typename Intersection , typename ExtractKey > </div> |
| <div class="memtemplate"> |
| template<typename SketchA , typename SketchB > </div> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">static bool exactly_equal </td> |
| <td>(</td> |
| <td class="paramtype">const SketchA & </td> |
| <td class="paramname"><em>sketch_a</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const SketchB & </td> |
| <td class="paramname"><em>sketch_b</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">uint64_t </td> |
| <td class="paramname"><em>seed</em> = <code>DEFAULT_SEED</code> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Returns true if the two given sketches are equivalent. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">sketch_a</td><td>the given sketch A </td></tr> |
| <tr><td class="paramname">sketch_b</td><td>the given sketch B </td></tr> |
| <tr><td class="paramname">seed</td><td>for the hash function that was used to create the sketch </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>true if the two given sketches are exactly equal </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a919ce3dd7d15658fe67eb359368e9f07" name="a919ce3dd7d15658fe67eb359368e9f07"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a919ce3dd7d15658fe67eb359368e9f07">◆ </a></span>similarity_test()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename Union , typename Intersection , typename ExtractKey > </div> |
| <div class="memtemplate"> |
| template<typename SketchA , typename SketchB > </div> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">static bool similarity_test </td> |
| <td>(</td> |
| <td class="paramtype">const SketchA & </td> |
| <td class="paramname"><em>actual</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const SketchB & </td> |
| <td class="paramname"><em>expected</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">double </td> |
| <td class="paramname"><em>threshold</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">uint64_t </td> |
| <td class="paramname"><em>seed</em> = <code>DEFAULT_SEED</code> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Tests similarity of an actual Sketch against an expected Sketch. </p> |
| <p>Computes the lower bound of the Jaccard index <em>J<sub>LB</sub></em> of the actual and expected sketches. if <em>J<sub>LB</sub> ≥ threshold</em>, then the sketches are considered to be similar with a confidence of 97.7%.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">actual</td><td>the sketch to be tested </td></tr> |
| <tr><td class="paramname">expected</td><td>the reference sketch that is considered to be correct </td></tr> |
| <tr><td class="paramname">threshold</td><td>a real value between zero and one </td></tr> |
| <tr><td class="paramname">seed</td><td>for the hash function that was used to create the sketch </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>true if the similarity of the two sketches is greater than the given threshold with at least 97.7% confidence </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a5bc3426c328c625eb345a5c00c755004" name="a5bc3426c328c625eb345a5c00c755004"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a5bc3426c328c625eb345a5c00c755004">◆ </a></span>dissimilarity_test()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename Union , typename Intersection , typename ExtractKey > </div> |
| <div class="memtemplate"> |
| template<typename SketchA , typename SketchB > </div> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">static bool dissimilarity_test </td> |
| <td>(</td> |
| <td class="paramtype">const SketchA & </td> |
| <td class="paramname"><em>actual</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const SketchB & </td> |
| <td class="paramname"><em>expected</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">double </td> |
| <td class="paramname"><em>threshold</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">uint64_t </td> |
| <td class="paramname"><em>seed</em> = <code>DEFAULT_SEED</code> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Tests dissimilarity of an actual Sketch against an expected Sketch. </p> |
| <p>Computes the upper bound of the Jaccard index <em>J<sub>UB</sub></em> of the actual and expected sketches. if <em>J<sub>UB</sub> ≤ threshold</em>, then the sketches are considered to be dissimilar with a confidence of 97.7%.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">actual</td><td>the sketch to be tested </td></tr> |
| <tr><td class="paramname">expected</td><td>the reference sketch that is considered to be correct </td></tr> |
| <tr><td class="paramname">threshold</td><td>a real value between zero and one </td></tr> |
| <tr><td class="paramname">seed</td><td>for the hash function that was used to create the sketch </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>true if the dissimilarity of the two sketches is greater than the given threshold with at least 97.7% confidence </dd></dl> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li>theta/include/<a class="el" href="theta__jaccard__similarity__base_8hpp_source.html">theta_jaccard_similarity_base.hpp</a></li> |
| </ul> |
| </div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8 |
| </small></address> |
| </body> |
| </html> |
