deploy: 78cc913

Author: proost

docs/master/count__min_8hpp_source.html

@@ -256,42 +256,43 @@
 <div class="line"><a id="l00389" name="l00389"></a><span class="lineno">  389</span>  <span class="keyword">static</span> <span class="keywordtype">void</span> check_header_validity(uint8_t preamble_longs, uint8_t serial_version, uint8_t family_id, uint8_t flags_byte);</div>
 <div class="line"><a id="l00390" name="l00390"></a><span class="lineno">  390</span> </div>
 <div class="line"><a id="l00391" name="l00391"></a><span class="lineno">  391</span>  <span class="comment">/*</span></div>
-<div class="line"><a id="l00392" name="l00392"></a><span class="lineno">  392</span><span class="comment">   * Obtain the hash values when inserting an item into the sketch.</span></div>
-<div class="line"><a id="l00393" name="l00393"></a><span class="lineno">  393</span><span class="comment">   * @param item pointer to the data item to be inserted into the sketch.</span></div>
+<div class="line"><a id="l00392" name="l00392"></a><span class="lineno">  392</span><span class="comment">   * Compute the hash locations for an input item</span></div>
+<div class="line"><a id="l00393" name="l00393"></a><span class="lineno">  393</span><span class="comment">   * @param item pointer to the data item to be inserted into or queried from the sketch.</span></div>
 <div class="line"><a id="l00394" name="l00394"></a><span class="lineno">  394</span><span class="comment">   * @param size of the data in bytes</span></div>
-<div class="line"><a id="l00395" name="l00395"></a><span class="lineno">  395</span><span class="comment">   * @return vector of uint64_t which each represent the index to which `value&#39; must update in the sketch</span></div>
+<div class="line"><a id="l00395" name="l00395"></a><span class="lineno">  395</span><span class="comment">   * @param callback function to invoke for each sketch array location</span></div>
 <div class="line"><a id="l00396" name="l00396"></a><span class="lineno">  396</span><span class="comment">   */</span></div>
-<div class="line"><a id="l00397" name="l00397"></a><span class="lineno">  397</span>  std::vector&lt;uint64_t&gt; get_hashes(<span class="keyword">const</span> <span class="keywordtype">void</span>* item, <span class="keywordtype">size_t</span> size) <span class="keyword">const</span>;</div>
-<div class="line"><a id="l00398" name="l00398"></a><span class="lineno">  398</span> </div>
-<div class="line"><a id="l00399" name="l00399"></a><span class="lineno">  399</span>};</div>
+<div class="line"><a id="l00397" name="l00397"></a><span class="lineno">  397</span>  <span class="keyword">template</span>&lt;<span class="keyword">typename</span> F&gt;</div>
+<div class="line"><a id="l00398" name="l00398"></a><span class="lineno">  398</span>  <span class="keywordtype">void</span> foreach_hash_location(<span class="keyword">const</span> <span class="keywordtype">void</span>* item, <span class="keywordtype">size_t</span> size, F callback) <span class="keyword">const</span>;</div>
+<div class="line"><a id="l00399" name="l00399"></a><span class="lineno">  399</span> </div>
+<div class="line"><a id="l00400" name="l00400"></a><span class="lineno">  400</span>};</div>
 </div>
-<div class="line"><a id="l00400" name="l00400"></a><span class="lineno">  400</span> </div>
-<div class="line"><a id="l00401" name="l00401"></a><span class="lineno">  401</span>} <span class="comment">/* namespace datasketches */</span></div>
-<div class="line"><a id="l00402" name="l00402"></a><span class="lineno">  402</span> </div>
-<div class="line"><a id="l00403" name="l00403"></a><span class="lineno">  403</span><span class="preprocessor">#include &quot;count_min_impl.hpp&quot;</span></div>
-<div class="line"><a id="l00404" name="l00404"></a><span class="lineno">  404</span> </div>
-<div class="line"><a id="l00405" name="l00405"></a><span class="lineno">  405</span><span class="preprocessor">#endif</span></div>
+<div class="line"><a id="l00401" name="l00401"></a><span class="lineno">  401</span> </div>
+<div class="line"><a id="l00402" name="l00402"></a><span class="lineno">  402</span>} <span class="comment">/* namespace datasketches */</span></div>
+<div class="line"><a id="l00403" name="l00403"></a><span class="lineno">  403</span> </div>
+<div class="line"><a id="l00404" name="l00404"></a><span class="lineno">  404</span><span class="preprocessor">#include &quot;count_min_impl.hpp&quot;</span></div>
+<div class="line"><a id="l00405" name="l00405"></a><span class="lineno">  405</span> </div>
+<div class="line"><a id="l00406" name="l00406"></a><span class="lineno">  406</span><span class="preprocessor">#endif</span></div>
 <div class="ttc" id="aclassdatasketches_1_1count__min__sketch_html"><div class="ttname"><a href="classdatasketches_1_1count__min__sketch.html">datasketches::count_min_sketch</a></div><div class="ttdoc">C++ implementation of the CountMin sketch data structure of Cormode and Muthukrishnan.</div><div class="ttdef"><b>Definition</b> count_min.hpp:37</div></div>
 <div class="ttc" id="aclassdatasketches_1_1count__min__sketch_html_a0a9f344e0399b775f82358b8807727af"><div class="ttname"><a href="classdatasketches_1_1count__min__sketch.html#a0a9f344e0399b775f82358b8807727af">datasketches::count_min_sketch::deserialize</a></div><div class="ttdeci">static count_min_sketch deserialize(std::istream &amp;is, uint64_t seed=DEFAULT_SEED, const Allocator &amp;allocator=Allocator())</div><div class="ttdoc">This method deserializes a sketch from a given stream.</div></div>
-<div class="ttc" id="aclassdatasketches_1_1count__min__sketch_html_a1bcdd98ee6e6eb9b501b8dc5de5e8924"><div class="ttname"><a href="classdatasketches_1_1count__min__sketch.html#a1bcdd98ee6e6eb9b501b8dc5de5e8924">datasketches::count_min_sketch::serialize</a></div><div class="ttdeci">void serialize(std::ostream &amp;os) const</div><div class="ttdoc">This method serializes the sketch into a given stream in a binary form.</div><div class="ttdef"><b>Definition</b> count_min_impl.hpp:268</div></div>
+<div class="ttc" id="aclassdatasketches_1_1count__min__sketch_html_a1bcdd98ee6e6eb9b501b8dc5de5e8924"><div class="ttname"><a href="classdatasketches_1_1count__min__sketch.html#a1bcdd98ee6e6eb9b501b8dc5de5e8924">datasketches::count_min_sketch::serialize</a></div><div class="ttdeci">void serialize(std::ostream &amp;os) const</div><div class="ttdoc">This method serializes the sketch into a given stream in a binary form.</div><div class="ttdef"><b>Definition</b> count_min_impl.hpp:264</div></div>
 <div class="ttc" id="aclassdatasketches_1_1count__min__sketch_html_a2909753e9106aad95a740580c3865d98"><div class="ttname"><a href="classdatasketches_1_1count__min__sketch.html#a2909753e9106aad95a740580c3865d98">datasketches::count_min_sketch::suggest_num_buckets</a></div><div class="ttdeci">static uint32_t suggest_num_buckets(double relative_error)</div><div class="ttdoc">Suggests the number of buckets required to achieve the given relative error.</div><div class="ttdef"><b>Definition</b> count_min_impl.hpp:88</div></div>
-<div class="ttc" id="aclassdatasketches_1_1count__min__sketch_html_a2c2da097065929e9f586049b19039fc9"><div class="ttname"><a href="classdatasketches_1_1count__min__sketch.html#a2c2da097065929e9f586049b19039fc9">datasketches::count_min_sketch::end</a></div><div class="ttdeci">const_iterator end() const</div><div class="ttdoc">Iterator pointing to the past-the-end item in the sketch.</div><div class="ttdef"><b>Definition</b> count_min_impl.hpp:263</div></div>
+<div class="ttc" id="aclassdatasketches_1_1count__min__sketch_html_a2c2da097065929e9f586049b19039fc9"><div class="ttname"><a href="classdatasketches_1_1count__min__sketch.html#a2c2da097065929e9f586049b19039fc9">datasketches::count_min_sketch::end</a></div><div class="ttdeci">const_iterator end() const</div><div class="ttdoc">Iterator pointing to the past-the-end item in the sketch.</div><div class="ttdef"><b>Definition</b> count_min_impl.hpp:259</div></div>
 <div class="ttc" id="aclassdatasketches_1_1count__min__sketch_html_a40b2f93d707496a57b16679be4a58a2f"><div class="ttname"><a href="classdatasketches_1_1count__min__sketch.html#a40b2f93d707496a57b16679be4a58a2f">datasketches::count_min_sketch::suggest_num_hashes</a></div><div class="ttdeci">static uint8_t suggest_num_hashes(double confidence)</div><div class="ttdoc">Suggests the number of hash functions required to achieve the given confidence.</div><div class="ttdef"><b>Definition</b> count_min_impl.hpp:100</div></div>
 <div class="ttc" id="aclassdatasketches_1_1count__min__sketch_html_a5356c92bb629951dcb748e51677a3886"><div class="ttname"><a href="classdatasketches_1_1count__min__sketch.html#a5356c92bb629951dcb748e51677a3886">datasketches::count_min_sketch::get_relative_error</a></div><div class="ttdeci">double get_relative_error() const</div><div class="ttdef"><b>Definition</b> count_min_impl.hpp:78</div></div>
 <div class="ttc" id="aclassdatasketches_1_1count__min__sketch_html_a56843138b87eb57c033f4ad26d8eb146"><div class="ttname"><a href="classdatasketches_1_1count__min__sketch.html#a56843138b87eb57c033f4ad26d8eb146">datasketches::count_min_sketch::get_num_buckets</a></div><div class="ttdeci">uint32_t get_num_buckets() const</div><div class="ttdef"><b>Definition</b> count_min_impl.hpp:68</div></div>
-<div class="ttc" id="aclassdatasketches_1_1count__min__sketch_html_a5a2b7a58dc85678d08752945ff655362"><div class="ttname"><a href="classdatasketches_1_1count__min__sketch.html#a5a2b7a58dc85678d08752945ff655362">datasketches::count_min_sketch::is_empty</a></div><div class="ttdeci">bool is_empty() const</div><div class="ttdoc">Returns true if this sketch is empty.</div><div class="ttdef"><b>Definition</b> count_min_impl.hpp:441</div></div>
+<div class="ttc" id="aclassdatasketches_1_1count__min__sketch_html_a5a2b7a58dc85678d08752945ff655362"><div class="ttname"><a href="classdatasketches_1_1count__min__sketch.html#a5a2b7a58dc85678d08752945ff655362">datasketches::count_min_sketch::is_empty</a></div><div class="ttdeci">bool is_empty() const</div><div class="ttdoc">Returns true if this sketch is empty.</div><div class="ttdef"><b>Definition</b> count_min_impl.hpp:437</div></div>
 <div class="ttc" id="aclassdatasketches_1_1count__min__sketch_html_a68bf5133e42650cdfe20a7916037ab4b"><div class="ttname"><a href="classdatasketches_1_1count__min__sketch.html#a68bf5133e42650cdfe20a7916037ab4b">datasketches::count_min_sketch::get_total_weight</a></div><div class="ttdeci">W get_total_weight() const</div><div class="ttdef"><b>Definition</b> count_min_impl.hpp:83</div></div>
 <div class="ttc" id="aclassdatasketches_1_1count__min__sketch_html_a6bd30e22135f7abd37d5b2b45d577d0c"><div class="ttname"><a href="classdatasketches_1_1count__min__sketch.html#a6bd30e22135f7abd37d5b2b45d577d0c">datasketches::count_min_sketch::get_num_hashes</a></div><div class="ttdeci">uint8_t get_num_hashes() const</div><div class="ttdef"><b>Definition</b> count_min_impl.hpp:63</div></div>
 <div class="ttc" id="aclassdatasketches_1_1count__min__sketch_html_a6e99c6263568d88f95ca01dc694f1051"><div class="ttname"><a href="classdatasketches_1_1count__min__sketch.html#a6e99c6263568d88f95ca01dc694f1051">datasketches::count_min_sketch::get_allocator</a></div><div class="ttdeci">allocator_type get_allocator() const</div></div>
-<div class="ttc" id="aclassdatasketches_1_1count__min__sketch_html_a70356e097d2d952c8f0d843087556b52"><div class="ttname"><a href="classdatasketches_1_1count__min__sketch.html#a70356e097d2d952c8f0d843087556b52">datasketches::count_min_sketch::get_upper_bound</a></div><div class="ttdeci">W get_upper_bound(const void *item, size_t size) const</div><div class="ttdoc">Query the sketch for the upper bound of a given item.</div><div class="ttdef"><b>Definition</b> count_min_impl.hpp:211</div></div>
-<div class="ttc" id="aclassdatasketches_1_1count__min__sketch_html_a7d1d4341a397ae681f03e4dc00423391"><div class="ttname"><a href="classdatasketches_1_1count__min__sketch.html#a7d1d4341a397ae681f03e4dc00423391">datasketches::count_min_sketch::get_lower_bound</a></div><div class="ttdeci">W get_lower_bound(const void *item, size_t size) const</div><div class="ttdoc">Query the sketch for the lower bound of a given item.</div><div class="ttdef"><b>Definition</b> count_min_impl.hpp:228</div></div>
-<div class="ttc" id="aclassdatasketches_1_1count__min__sketch_html_a8c7a3314a5665e9d244acc5c1b5c43d6"><div class="ttname"><a href="classdatasketches_1_1count__min__sketch.html#a8c7a3314a5665e9d244acc5c1b5c43d6">datasketches::count_min_sketch::get_estimate</a></div><div class="ttdeci">W get_estimate(uint64_t item) const</div><div class="ttdoc">Specific get_estimate function for uint64_t type see generic get_estimate function.</div><div class="ttdef"><b>Definition</b> count_min_impl.hpp:145</div></div>
+<div class="ttc" id="aclassdatasketches_1_1count__min__sketch_html_a70356e097d2d952c8f0d843087556b52"><div class="ttname"><a href="classdatasketches_1_1count__min__sketch.html#a70356e097d2d952c8f0d843087556b52">datasketches::count_min_sketch::get_upper_bound</a></div><div class="ttdeci">W get_upper_bound(const void *item, size_t size) const</div><div class="ttdoc">Query the sketch for the upper bound of a given item.</div><div class="ttdef"><b>Definition</b> count_min_impl.hpp:207</div></div>
+<div class="ttc" id="aclassdatasketches_1_1count__min__sketch_html_a7d1d4341a397ae681f03e4dc00423391"><div class="ttname"><a href="classdatasketches_1_1count__min__sketch.html#a7d1d4341a397ae681f03e4dc00423391">datasketches::count_min_sketch::get_lower_bound</a></div><div class="ttdeci">W get_lower_bound(const void *item, size_t size) const</div><div class="ttdoc">Query the sketch for the lower bound of a given item.</div><div class="ttdef"><b>Definition</b> count_min_impl.hpp:224</div></div>
+<div class="ttc" id="aclassdatasketches_1_1count__min__sketch_html_a8c7a3314a5665e9d244acc5c1b5c43d6"><div class="ttname"><a href="classdatasketches_1_1count__min__sketch.html#a8c7a3314a5665e9d244acc5c1b5c43d6">datasketches::count_min_sketch::get_estimate</a></div><div class="ttdeci">W get_estimate(uint64_t item) const</div><div class="ttdoc">Specific get_estimate function for uint64_t type see generic get_estimate function.</div><div class="ttdef"><b>Definition</b> count_min_impl.hpp:143</div></div>
 <div class="ttc" id="aclassdatasketches_1_1count__min__sketch_html_a9004656ac2e34c35d8a7a0773285385a"><div class="ttname"><a href="classdatasketches_1_1count__min__sketch.html#a9004656ac2e34c35d8a7a0773285385a">datasketches::count_min_sketch::get_seed</a></div><div class="ttdeci">uint64_t get_seed() const</div><div class="ttdef"><b>Definition</b> count_min_impl.hpp:73</div></div>
-<div class="ttc" id="aclassdatasketches_1_1count__min__sketch_html_ab53a0403cb869426c5eb6a8c70ca3e7f"><div class="ttname"><a href="classdatasketches_1_1count__min__sketch.html#ab53a0403cb869426c5eb6a8c70ca3e7f">datasketches::count_min_sketch::merge</a></div><div class="ttdeci">void merge(const count_min_sketch &amp;other_sketch)</div><div class="ttdoc">Merges another count_min_sketch into this count_min_sketch.</div><div class="ttdef"><b>Definition</b> count_min_impl.hpp:233</div></div>
-<div class="ttc" id="aclassdatasketches_1_1count__min__sketch_html_adf1fad8a6035d808e06ea84fbffb6a86"><div class="ttname"><a href="classdatasketches_1_1count__min__sketch.html#adf1fad8a6035d808e06ea84fbffb6a86">datasketches::count_min_sketch::update</a></div><div class="ttdeci">void update(const void *item, size_t size, W weight)</div><div class="ttdoc">Update this sketch with given data of any type.</div><div class="ttdef"><b>Definition</b> count_min_impl.hpp:186</div></div>
-<div class="ttc" id="aclassdatasketches_1_1count__min__sketch_html_aed372241c10ffd041bee85602edb199a"><div class="ttname"><a href="classdatasketches_1_1count__min__sketch.html#aed372241c10ffd041bee85602edb199a">datasketches::count_min_sketch::to_string</a></div><div class="ttdeci">string&lt; Allocator &gt; to_string() const</div><div class="ttdoc">Returns a string describing the sketch.</div><div class="ttdef"><b>Definition</b> count_min_impl.hpp:446</div></div>
-<div class="ttc" id="aclassdatasketches_1_1count__min__sketch_html_af900f66ecee1991981f6f33c52a10bc9"><div class="ttname"><a href="classdatasketches_1_1count__min__sketch.html#af900f66ecee1991981f6f33c52a10bc9">datasketches::count_min_sketch::get_serialized_size_bytes</a></div><div class="ttdeci">size_t get_serialized_size_bytes() const</div><div class="ttdoc">Computes size needed to serialize the current state of the sketch.</div><div class="ttdef"><b>Definition</b> count_min_impl.hpp:339</div></div>
-<div class="ttc" id="aclassdatasketches_1_1count__min__sketch_html_afa7956f1d2c14624431b3fb7cd976f63"><div class="ttname"><a href="classdatasketches_1_1count__min__sketch.html#afa7956f1d2c14624431b3fb7cd976f63">datasketches::count_min_sketch::begin</a></div><div class="ttdeci">const_iterator begin() const</div><div class="ttdoc">Iterator pointing to the first item in the sketch.</div><div class="ttdef"><b>Definition</b> count_min_impl.hpp:258</div></div>
+<div class="ttc" id="aclassdatasketches_1_1count__min__sketch_html_ab53a0403cb869426c5eb6a8c70ca3e7f"><div class="ttname"><a href="classdatasketches_1_1count__min__sketch.html#ab53a0403cb869426c5eb6a8c70ca3e7f">datasketches::count_min_sketch::merge</a></div><div class="ttdeci">void merge(const count_min_sketch &amp;other_sketch)</div><div class="ttdoc">Merges another count_min_sketch into this count_min_sketch.</div><div class="ttdef"><b>Definition</b> count_min_impl.hpp:229</div></div>
+<div class="ttc" id="aclassdatasketches_1_1count__min__sketch_html_adf1fad8a6035d808e06ea84fbffb6a86"><div class="ttname"><a href="classdatasketches_1_1count__min__sketch.html#adf1fad8a6035d808e06ea84fbffb6a86">datasketches::count_min_sketch::update</a></div><div class="ttdeci">void update(const void *item, size_t size, W weight)</div><div class="ttdoc">Update this sketch with given data of any type.</div><div class="ttdef"><b>Definition</b> count_min_impl.hpp:183</div></div>
+<div class="ttc" id="aclassdatasketches_1_1count__min__sketch_html_aed372241c10ffd041bee85602edb199a"><div class="ttname"><a href="classdatasketches_1_1count__min__sketch.html#aed372241c10ffd041bee85602edb199a">datasketches::count_min_sketch::to_string</a></div><div class="ttdeci">string&lt; Allocator &gt; to_string() const</div><div class="ttdoc">Returns a string describing the sketch.</div><div class="ttdef"><b>Definition</b> count_min_impl.hpp:442</div></div>
+<div class="ttc" id="aclassdatasketches_1_1count__min__sketch_html_af900f66ecee1991981f6f33c52a10bc9"><div class="ttname"><a href="classdatasketches_1_1count__min__sketch.html#af900f66ecee1991981f6f33c52a10bc9">datasketches::count_min_sketch::get_serialized_size_bytes</a></div><div class="ttdeci">size_t get_serialized_size_bytes() const</div><div class="ttdoc">Computes size needed to serialize the current state of the sketch.</div><div class="ttdef"><b>Definition</b> count_min_impl.hpp:335</div></div>
+<div class="ttc" id="aclassdatasketches_1_1count__min__sketch_html_afa7956f1d2c14624431b3fb7cd976f63"><div class="ttname"><a href="classdatasketches_1_1count__min__sketch.html#afa7956f1d2c14624431b3fb7cd976f63">datasketches::count_min_sketch::begin</a></div><div class="ttdeci">const_iterator begin() const</div><div class="ttdoc">Iterator pointing to the first item in the sketch.</div><div class="ttdef"><b>Definition</b> count_min_impl.hpp:254</div></div>
 <div class="ttc" id="aclassdatasketches_1_1count__min__sketch_html_afc0d4bcd3c9df114cec65f2332ec626e"><div class="ttname"><a href="classdatasketches_1_1count__min__sketch.html#afc0d4bcd3c9df114cec65f2332ec626e">datasketches::count_min_sketch::deserialize</a></div><div class="ttdeci">static count_min_sketch deserialize(const void *bytes, size_t size, uint64_t seed=DEFAULT_SEED, const Allocator &amp;allocator=Allocator())</div><div class="ttdoc">This method deserializes a sketch from a given array of bytes.</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 -->