blob: 4fb3cfb604c27ce1dbad0f35f6e6a7555baabd39 [file] [log] [blame]
<!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">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>datasketches-cpp: theta/include/theta_jaccard_similarity_base.hpp Source File</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 style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">datasketches-cpp
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'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:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(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">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_e96b5dfe115c13cdeb36484e37aec42e.html">theta</a></li><li class="navelem"><a class="el" href="dir_3f8742d40c9573c3b90638004faf146b.html">include</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">theta_jaccard_similarity_base.hpp</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">/*</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment"> * Licensed to the Apache Software Foundation (ASF) under one</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"> * or more contributor license agreements. See the NOTICE file</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment"> * distributed with this work for additional information</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment"> * regarding copyright ownership. The ASF licenses this file</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment"> * to you under the Apache License, Version 2.0 (the</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment"> * &quot;License&quot;); you may not use this file except in compliance</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment"> * with the License. You may obtain a copy of the License at</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment"> * Unless required by applicable law or agreed to in writing,</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment"> * software distributed under the License is distributed on an</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment"> * &quot;AS IS&quot; BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment"> * KIND, either express or implied. See the License for the</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="comment"> * specific language governing permissions and limitations</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="comment"> * under the License.</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160; </div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="preprocessor">#ifndef THETA_JACCARD_SIMILARITY_BASE_HPP_</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="preprocessor">#define THETA_JACCARD_SIMILARITY_BASE_HPP_</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; </div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="preprocessor">#include &lt;memory&gt;</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="preprocessor">#include &lt;array&gt;</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; </div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="preprocessor">#include &quot;theta_constants.hpp&quot;</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="preprocessor">#include &quot;bounds_on_ratios_in_theta_sketched_sets.hpp&quot;</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<span class="preprocessor">#include &quot;ceiling_power_of_2.hpp&quot;</span></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="preprocessor">#include &quot;common_defs.hpp&quot;</span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; </div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespacedatasketches.html">datasketches</a> {</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; </div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;<span class="keyword">template</span>&lt;<span class="keyword">typename</span> Union, <span class="keyword">typename</span> Intersection, <span class="keyword">typename</span> ExtractKey&gt;</div>
<div class="line"><a name="l00035"></a><span class="lineno"><a class="line" href="classdatasketches_1_1jaccard__similarity__base.html"> 35</a></span>&#160;<span class="keyword">class </span><a class="code" href="classdatasketches_1_1jaccard__similarity__base.html">jaccard_similarity_base</a> {</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;<span class="keyword">public</span>:</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; </div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> SketchA, <span class="keyword">typename</span> SketchB&gt;</div>
<div class="line"><a name="l00055"></a><span class="lineno"><a class="line" href="classdatasketches_1_1jaccard__similarity__base.html#a733368dc893af01141bb6dff468bf008"> 55</a></span>&#160; <span class="keyword">static</span> std::array&lt;double, 3&gt; <a class="code" href="classdatasketches_1_1jaccard__similarity__base.html#a733368dc893af01141bb6dff468bf008">jaccard</a>(<span class="keyword">const</span> SketchA&amp; sketch_a, <span class="keyword">const</span> SketchB&amp; sketch_b, uint64_t seed = DEFAULT_SEED) {</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; <span class="keywordflow">if</span> (<span class="keyword">reinterpret_cast&lt;</span><span class="keyword">const </span><span class="keywordtype">void</span>*<span class="keyword">&gt;</span>(&amp;sketch_a) == <span class="keyword">reinterpret_cast&lt;</span><span class="keyword">const </span><span class="keywordtype">void</span>*<span class="keyword">&gt;</span>(&amp;sketch_b)) <span class="keywordflow">return</span> {1, 1, 1};</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; <span class="keywordflow">if</span> (sketch_a.is_empty() &amp;&amp; sketch_b.is_empty()) <span class="keywordflow">return</span> {1, 1, 1};</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; <span class="keywordflow">if</span> (sketch_a.is_empty() || sketch_b.is_empty()) <span class="keywordflow">return</span> {0, 0, 0};</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; </div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; <span class="keyword">auto</span> union_ab = compute_union(sketch_a, sketch_b, seed);</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; <span class="keywordflow">if</span> (identical_sets(sketch_a, sketch_b, union_ab)) <span class="keywordflow">return</span> {1, 1, 1};</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; </div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; <span class="comment">// intersection</span></div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; Intersection i(seed);</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; i.update(sketch_a);</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; i.update(sketch_b);</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; i.update(union_ab); <span class="comment">// ensures that intersection is a subset of the union</span></div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; <span class="keyword">auto</span> inter_abu = i.get_result(<span class="keyword">false</span>);</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; </div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; <span class="keywordflow">return</span> {</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; <a class="code" href="classdatasketches_1_1bounds__on__ratios__in__theta__sketched__sets.html#afca4842e0e5f98bf5eba713429b9e388">bounds_on_ratios_in_theta_sketched_sets&lt;ExtractKey&gt;::lower_bound_for_b_over_a</a>(union_ab, inter_abu),</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; <a class="code" href="classdatasketches_1_1bounds__on__ratios__in__theta__sketched__sets.html#aaf6f3e30b2d0b2f01f2f2196ac97a203">bounds_on_ratios_in_theta_sketched_sets&lt;ExtractKey&gt;::estimate_of_b_over_a</a>(union_ab, inter_abu),</div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; <a class="code" href="classdatasketches_1_1bounds__on__ratios__in__theta__sketched__sets.html#ad293e15d58608067e1e0d6664802bfd2">bounds_on_ratios_in_theta_sketched_sets&lt;ExtractKey&gt;::upper_bound_for_b_over_a</a>(union_ab, inter_abu)</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; };</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; }</div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; </div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> SketchA, <span class="keyword">typename</span> SketchB&gt;</div>
<div class="line"><a name="l00085"></a><span class="lineno"><a class="line" href="classdatasketches_1_1jaccard__similarity__base.html#a18c18c5c7351430540000bf360f523fc"> 85</a></span>&#160; <span class="keyword">static</span> <span class="keywordtype">bool</span> <a class="code" href="classdatasketches_1_1jaccard__similarity__base.html#a18c18c5c7351430540000bf360f523fc">exactly_equal</a>(<span class="keyword">const</span> SketchA&amp; sketch_a, <span class="keyword">const</span> SketchB&amp; sketch_b, uint64_t seed = DEFAULT_SEED) {</div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160; <span class="keywordflow">if</span> (<span class="keyword">reinterpret_cast&lt;</span><span class="keyword">const </span><span class="keywordtype">void</span>*<span class="keyword">&gt;</span>(&amp;sketch_a) == <span class="keyword">reinterpret_cast&lt;</span><span class="keyword">const </span><span class="keywordtype">void</span>*<span class="keyword">&gt;</span>(&amp;sketch_b)) <span class="keywordflow">return</span> <span class="keyword">true</span>;</div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160; <span class="keywordflow">if</span> (sketch_a.is_empty() &amp;&amp; sketch_b.is_empty()) <span class="keywordflow">return</span> <span class="keyword">true</span>;</div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160; <span class="keywordflow">if</span> (sketch_a.is_empty() || sketch_b.is_empty()) <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160; </div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160; <span class="keyword">auto</span> union_ab = compute_union(sketch_a, sketch_b, seed);</div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160; <span class="keywordflow">if</span> (identical_sets(sketch_a, sketch_b, union_ab)) <span class="keywordflow">return</span> <span class="keyword">true</span>;</div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160; <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160; }</div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160; </div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> SketchA, <span class="keyword">typename</span> SketchB&gt;</div>
<div class="line"><a name="l00110"></a><span class="lineno"><a class="line" href="classdatasketches_1_1jaccard__similarity__base.html#a919ce3dd7d15658fe67eb359368e9f07"> 110</a></span>&#160; <span class="keyword">static</span> <span class="keywordtype">bool</span> <a class="code" href="classdatasketches_1_1jaccard__similarity__base.html#a919ce3dd7d15658fe67eb359368e9f07">similarity_test</a>(<span class="keyword">const</span> SketchA&amp; actual, <span class="keyword">const</span> SketchB&amp; expected, <span class="keywordtype">double</span> threshold, uint64_t seed = DEFAULT_SEED) {</div>
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span>&#160; <span class="keyword">auto</span> jc = <a class="code" href="classdatasketches_1_1jaccard__similarity__base.html#a733368dc893af01141bb6dff468bf008">jaccard</a>(actual, expected, seed);</div>
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span>&#160; <span class="keywordflow">return</span> jc[0] &gt;= threshold;</div>
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span>&#160; }</div>
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span>&#160; </div>
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> SketchA, <span class="keyword">typename</span> SketchB&gt;</div>
<div class="line"><a name="l00130"></a><span class="lineno"><a class="line" href="classdatasketches_1_1jaccard__similarity__base.html#a5bc3426c328c625eb345a5c00c755004"> 130</a></span>&#160; <span class="keyword">static</span> <span class="keywordtype">bool</span> <a class="code" href="classdatasketches_1_1jaccard__similarity__base.html#a5bc3426c328c625eb345a5c00c755004">dissimilarity_test</a>(<span class="keyword">const</span> SketchA&amp; actual, <span class="keyword">const</span> SketchB&amp; expected, <span class="keywordtype">double</span> threshold, uint64_t seed = DEFAULT_SEED) {</div>
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span>&#160; <span class="keyword">auto</span> jc = <a class="code" href="classdatasketches_1_1jaccard__similarity__base.html#a733368dc893af01141bb6dff468bf008">jaccard</a>(actual, expected, seed);</div>
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span>&#160; <span class="keywordflow">return</span> jc[2] &lt;= threshold;</div>
<div class="line"><a name="l00133"></a><span class="lineno"> 133</span>&#160; }</div>
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span>&#160; </div>
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span>&#160;<span class="keyword">private</span>:</div>
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span>&#160; </div>
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> SketchA, <span class="keyword">typename</span> SketchB&gt;</div>
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span>&#160; <span class="keyword">static</span> <span class="keyword">typename</span> Union::CompactSketch compute_union(<span class="keyword">const</span> SketchA&amp; sketch_a, <span class="keyword">const</span> SketchB&amp; sketch_b, uint64_t seed) {</div>
<div class="line"><a name="l00139"></a><span class="lineno"> 139</span>&#160; <span class="keyword">const</span> <span class="keyword">auto</span> count_a = sketch_a.get_num_retained();</div>
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span>&#160; <span class="keyword">const</span> <span class="keyword">auto</span> count_b = sketch_b.get_num_retained();</div>
<div class="line"><a name="l00141"></a><span class="lineno"> 141</span>&#160; <span class="keyword">const</span> uint8_t lg_k = std::min(std::max(log2(ceiling_power_of_2(count_a + count_b)), <a class="code" href="namespacedatasketches_1_1theta__constants.html#a80c5dfefaf69318c0894ec34c34d0987">theta_constants::MIN_LG_K</a>), <a class="code" href="namespacedatasketches_1_1theta__constants.html#ad15c7a6b3af91806e0a9743d27943d49">theta_constants::MAX_LG_K</a>);</div>
<div class="line"><a name="l00142"></a><span class="lineno"> 142</span>&#160; <span class="keyword">auto</span> u = <span class="keyword">typename</span> Union::builder().set_lg_k(lg_k).set_seed(seed).build();</div>
<div class="line"><a name="l00143"></a><span class="lineno"> 143</span>&#160; u.update(sketch_a);</div>
<div class="line"><a name="l00144"></a><span class="lineno"> 144</span>&#160; u.update(sketch_b);</div>
<div class="line"><a name="l00145"></a><span class="lineno"> 145</span>&#160; <span class="keywordflow">return</span> u.get_result(<span class="keyword">false</span>);</div>
<div class="line"><a name="l00146"></a><span class="lineno"> 146</span>&#160; }</div>
<div class="line"><a name="l00147"></a><span class="lineno"> 147</span>&#160; </div>
<div class="line"><a name="l00148"></a><span class="lineno"> 148</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> SketchA, <span class="keyword">typename</span> SketchB, <span class="keyword">typename</span> UnionAB&gt;</div>
<div class="line"><a name="l00149"></a><span class="lineno"> 149</span>&#160; <span class="keyword">static</span> <span class="keywordtype">bool</span> identical_sets(<span class="keyword">const</span> SketchA&amp; sketch_a, <span class="keyword">const</span> SketchB&amp; sketch_b, <span class="keyword">const</span> UnionAB&amp; union_ab) {</div>
<div class="line"><a name="l00150"></a><span class="lineno"> 150</span>&#160; <span class="keywordflow">if</span> (union_ab.get_num_retained() == sketch_a.get_num_retained() &amp;&amp;</div>
<div class="line"><a name="l00151"></a><span class="lineno"> 151</span>&#160; union_ab.get_num_retained() == sketch_b.get_num_retained() &amp;&amp;</div>
<div class="line"><a name="l00152"></a><span class="lineno"> 152</span>&#160; union_ab.get_theta64() == sketch_a.get_theta64() &amp;&amp;</div>
<div class="line"><a name="l00153"></a><span class="lineno"> 153</span>&#160; union_ab.get_theta64() == sketch_b.get_theta64()) <span class="keywordflow">return</span> <span class="keyword">true</span>;</div>
<div class="line"><a name="l00154"></a><span class="lineno"> 154</span>&#160; <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
<div class="line"><a name="l00155"></a><span class="lineno"> 155</span>&#160; }</div>
<div class="line"><a name="l00156"></a><span class="lineno"> 156</span>&#160; </div>
<div class="line"><a name="l00157"></a><span class="lineno"> 157</span>&#160;};</div>
<div class="line"><a name="l00158"></a><span class="lineno"> 158</span>&#160; </div>
<div class="line"><a name="l00159"></a><span class="lineno"> 159</span>&#160;} <span class="comment">/* namespace datasketches */</span></div>
<div class="line"><a name="l00160"></a><span class="lineno"> 160</span>&#160; </div>
<div class="line"><a name="l00161"></a><span class="lineno"> 161</span>&#160;<span class="preprocessor"># endif</span></div>
<div class="ttc" id="aclassdatasketches_1_1bounds__on__ratios__in__theta__sketched__sets_html_aaf6f3e30b2d0b2f01f2f2196ac97a203"><div class="ttname"><a href="classdatasketches_1_1bounds__on__ratios__in__theta__sketched__sets.html#aaf6f3e30b2d0b2f01f2f2196ac97a203">datasketches::bounds_on_ratios_in_theta_sketched_sets::estimate_of_b_over_a</a></div><div class="ttdeci">static double estimate_of_b_over_a(const SketchA &amp;sketch_a, const SketchB &amp;sketch_b)</div><div class="ttdoc">Gets the estimate for B over A.</div><div class="ttdef"><b>Definition:</b> bounds_on_ratios_in_theta_sketched_sets.hpp:103</div></div>
<div class="ttc" id="aclassdatasketches_1_1bounds__on__ratios__in__theta__sketched__sets_html_ad293e15d58608067e1e0d6664802bfd2"><div class="ttname"><a href="classdatasketches_1_1bounds__on__ratios__in__theta__sketched__sets.html#ad293e15d58608067e1e0d6664802bfd2">datasketches::bounds_on_ratios_in_theta_sketched_sets::upper_bound_for_b_over_a</a></div><div class="ttdeci">static double upper_bound_for_b_over_a(const SketchA &amp;sketch_a, const SketchB &amp;sketch_b)</div><div class="ttdoc">Gets the approximate upper bound for B over A based on a 95% confidence interval.</div><div class="ttdef"><b>Definition:</b> bounds_on_ratios_in_theta_sketched_sets.hpp:81</div></div>
<div class="ttc" id="aclassdatasketches_1_1bounds__on__ratios__in__theta__sketched__sets_html_afca4842e0e5f98bf5eba713429b9e388"><div class="ttname"><a href="classdatasketches_1_1bounds__on__ratios__in__theta__sketched__sets.html#afca4842e0e5f98bf5eba713429b9e388">datasketches::bounds_on_ratios_in_theta_sketched_sets::lower_bound_for_b_over_a</a></div><div class="ttdeci">static double lower_bound_for_b_over_a(const SketchA &amp;sketch_a, const SketchB &amp;sketch_b)</div><div class="ttdoc">Gets the approximate lower bound for B over A based on a 95% confidence interval.</div><div class="ttdef"><b>Definition:</b> bounds_on_ratios_in_theta_sketched_sets.hpp:59</div></div>
<div class="ttc" id="aclassdatasketches_1_1jaccard__similarity__base_html"><div class="ttname"><a href="classdatasketches_1_1jaccard__similarity__base.html">datasketches::jaccard_similarity_base</a></div><div class="ttdoc">Base class for Jaccard similarity.</div><div class="ttdef"><b>Definition:</b> theta_jaccard_similarity_base.hpp:35</div></div>
<div class="ttc" id="aclassdatasketches_1_1jaccard__similarity__base_html_a18c18c5c7351430540000bf360f523fc"><div class="ttname"><a href="classdatasketches_1_1jaccard__similarity__base.html#a18c18c5c7351430540000bf360f523fc">datasketches::jaccard_similarity_base::exactly_equal</a></div><div class="ttdeci">static bool exactly_equal(const SketchA &amp;sketch_a, const SketchB &amp;sketch_b, uint64_t seed=DEFAULT_SEED)</div><div class="ttdoc">Returns true if the two given sketches are equivalent.</div><div class="ttdef"><b>Definition:</b> theta_jaccard_similarity_base.hpp:85</div></div>
<div class="ttc" id="aclassdatasketches_1_1jaccard__similarity__base_html_a5bc3426c328c625eb345a5c00c755004"><div class="ttname"><a href="classdatasketches_1_1jaccard__similarity__base.html#a5bc3426c328c625eb345a5c00c755004">datasketches::jaccard_similarity_base::dissimilarity_test</a></div><div class="ttdeci">static bool dissimilarity_test(const SketchA &amp;actual, const SketchB &amp;expected, double threshold, uint64_t seed=DEFAULT_SEED)</div><div class="ttdoc">Tests dissimilarity of an actual Sketch against an expected Sketch.</div><div class="ttdef"><b>Definition:</b> theta_jaccard_similarity_base.hpp:130</div></div>
<div class="ttc" id="aclassdatasketches_1_1jaccard__similarity__base_html_a733368dc893af01141bb6dff468bf008"><div class="ttname"><a href="classdatasketches_1_1jaccard__similarity__base.html#a733368dc893af01141bb6dff468bf008">datasketches::jaccard_similarity_base::jaccard</a></div><div class="ttdeci">static std::array&lt; double, 3 &gt; jaccard(const SketchA &amp;sketch_a, const SketchB &amp;sketch_b, uint64_t seed=DEFAULT_SEED)</div><div class="ttdoc">Computes the Jaccard similarity index with upper and lower bounds.</div><div class="ttdef"><b>Definition:</b> theta_jaccard_similarity_base.hpp:55</div></div>
<div class="ttc" id="aclassdatasketches_1_1jaccard__similarity__base_html_a919ce3dd7d15658fe67eb359368e9f07"><div class="ttname"><a href="classdatasketches_1_1jaccard__similarity__base.html#a919ce3dd7d15658fe67eb359368e9f07">datasketches::jaccard_similarity_base::similarity_test</a></div><div class="ttdeci">static bool similarity_test(const SketchA &amp;actual, const SketchB &amp;expected, double threshold, uint64_t seed=DEFAULT_SEED)</div><div class="ttdoc">Tests similarity of an actual Sketch against an expected Sketch.</div><div class="ttdef"><b>Definition:</b> theta_jaccard_similarity_base.hpp:110</div></div>
<div class="ttc" id="anamespacedatasketches_1_1theta__constants_html_a80c5dfefaf69318c0894ec34c34d0987"><div class="ttname"><a href="namespacedatasketches_1_1theta__constants.html#a80c5dfefaf69318c0894ec34c34d0987">datasketches::theta_constants::MIN_LG_K</a></div><div class="ttdeci">const uint8_t MIN_LG_K</div><div class="ttdoc">min log2 of K</div><div class="ttdef"><b>Definition:</b> theta_constants.hpp:38</div></div>
<div class="ttc" id="anamespacedatasketches_1_1theta__constants_html_ad15c7a6b3af91806e0a9743d27943d49"><div class="ttname"><a href="namespacedatasketches_1_1theta__constants.html#ad15c7a6b3af91806e0a9743d27943d49">datasketches::theta_constants::MAX_LG_K</a></div><div class="ttdeci">const uint8_t MAX_LG_K</div><div class="ttdoc">max log2 of K</div><div class="ttdef"><b>Definition:</b> theta_constants.hpp:40</div></div>
<div class="ttc" id="anamespacedatasketches_html"><div class="ttname"><a href="namespacedatasketches.html">datasketches</a></div><div class="ttdoc">DataSketches namespace.</div><div class="ttdef"><b>Definition:</b> binomial_bounds.hpp:38</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
</small></address>
</body>
</html>