| <!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: compact_theta_sketch_alloc< Allocator > 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 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&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&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="namespacedatasketches.html">datasketches</a></li><li class="navelem"><a class="el" href="classdatasketches_1_1compact__theta__sketch__alloc.html">compact_theta_sketch_alloc</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="#pub-static-methods">Static Public Member Functions</a> | |
| <a href="classdatasketches_1_1compact__theta__sketch__alloc-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">compact_theta_sketch_alloc< Allocator > Class Template Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Compact Theta sketch. |
| <a href="classdatasketches_1_1compact__theta__sketch__alloc.html#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="theta__sketch_8hpp_source.html">theta_sketch.hpp</a>></code></p> |
| <div class="dynheader"> |
| Inheritance diagram for compact_theta_sketch_alloc< Allocator >:</div> |
| <div class="dyncontent"> |
| <div class="center"> |
| <img src="classdatasketches_1_1compact__theta__sketch__alloc.png" usemap="#compact_5Ftheta_5Fsketch_5Falloc_3C_20Allocator_20_3E_map" alt=""/> |
| <map id="compact_5Ftheta_5Fsketch_5Falloc_3C_20Allocator_20_3E_map" name="compact_5Ftheta_5Fsketch_5Falloc_3C_20Allocator_20_3E_map"> |
| <area href="classdatasketches_1_1theta__sketch__alloc.html" alt="theta_sketch_alloc< std::allocator< uint64_t > >" shape="rect" coords="0,56,313,80"/> |
| <area href="classdatasketches_1_1base__theta__sketch__alloc.html" alt="base_theta_sketch_alloc< std::allocator< uint64_t > >" shape="rect" coords="0,0,313,24"/> |
| </map> |
| </div></div> |
| <table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> |
| Public Member Functions</h2></td></tr> |
| <tr class="memitem:a0eaea2a9894acb7b92f5c3f3224c618c"><td class="memTemplParams" colspan="2">template<typename Other > </td></tr> |
| <tr class="memitem:a0eaea2a9894acb7b92f5c3f3224c618c"><td class="memTemplItemLeft" align="right" valign="top"> </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1compact__theta__sketch__alloc.html#a0eaea2a9894acb7b92f5c3f3224c618c">compact_theta_sketch_alloc</a> (const Other &other, bool ordered)</td></tr> |
| <tr class="memdesc:a0eaea2a9894acb7b92f5c3f3224c618c"><td class="mdescLeft"> </td><td class="mdescRight">Copy constructor. <a href="classdatasketches_1_1compact__theta__sketch__alloc.html#a0eaea2a9894acb7b92f5c3f3224c618c">More...</a><br /></td></tr> |
| <tr class="separator:a0eaea2a9894acb7b92f5c3f3224c618c"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a0f097d346334e1ad237b64133d0adf94"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1compact__theta__sketch__alloc.html#a0f097d346334e1ad237b64133d0adf94">compact_theta_sketch_alloc</a> (const <a class="el" href="classdatasketches_1_1compact__theta__sketch__alloc.html">compact_theta_sketch_alloc</a> &other)=default</td></tr> |
| <tr class="memdesc:a0f097d346334e1ad237b64133d0adf94"><td class="mdescLeft"> </td><td class="mdescRight">Copy constructor. <a href="classdatasketches_1_1compact__theta__sketch__alloc.html#a0f097d346334e1ad237b64133d0adf94">More...</a><br /></td></tr> |
| <tr class="separator:a0f097d346334e1ad237b64133d0adf94"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ab261a20e0595a67b16f2fc542443fa45"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1compact__theta__sketch__alloc.html#ab261a20e0595a67b16f2fc542443fa45">compact_theta_sketch_alloc</a> (<a class="el" href="classdatasketches_1_1compact__theta__sketch__alloc.html">compact_theta_sketch_alloc</a> &&other) noexcept=default</td></tr> |
| <tr class="memdesc:ab261a20e0595a67b16f2fc542443fa45"><td class="mdescLeft"> </td><td class="mdescRight">Move constructor. <a href="classdatasketches_1_1compact__theta__sketch__alloc.html#ab261a20e0595a67b16f2fc542443fa45">More...</a><br /></td></tr> |
| <tr class="separator:ab261a20e0595a67b16f2fc542443fa45"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ada3a2bda671ddcc3dd65db48a978251d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classdatasketches_1_1compact__theta__sketch__alloc.html">compact_theta_sketch_alloc</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1compact__theta__sketch__alloc.html#ada3a2bda671ddcc3dd65db48a978251d">operator=</a> (const <a class="el" href="classdatasketches_1_1compact__theta__sketch__alloc.html">compact_theta_sketch_alloc</a> &other)=default</td></tr> |
| <tr class="memdesc:ada3a2bda671ddcc3dd65db48a978251d"><td class="mdescLeft"> </td><td class="mdescRight">Copy assignment. <a href="classdatasketches_1_1compact__theta__sketch__alloc.html#ada3a2bda671ddcc3dd65db48a978251d">More...</a><br /></td></tr> |
| <tr class="separator:ada3a2bda671ddcc3dd65db48a978251d"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ad0d038d5ac22cd84233efba29156b07e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classdatasketches_1_1compact__theta__sketch__alloc.html">compact_theta_sketch_alloc</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1compact__theta__sketch__alloc.html#ad0d038d5ac22cd84233efba29156b07e">operator=</a> (<a class="el" href="classdatasketches_1_1compact__theta__sketch__alloc.html">compact_theta_sketch_alloc</a> &&other)=default</td></tr> |
| <tr class="memdesc:ad0d038d5ac22cd84233efba29156b07e"><td class="mdescLeft"> </td><td class="mdescRight">Move assignment. <a href="classdatasketches_1_1compact__theta__sketch__alloc.html#ad0d038d5ac22cd84233efba29156b07e">More...</a><br /></td></tr> |
| <tr class="separator:ad0d038d5ac22cd84233efba29156b07e"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a9d85cf47c4ecd0580ec623c42006dd1b"><td class="memItemLeft" align="right" valign="top">virtual Allocator </td><td class="memItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1compact__theta__sketch__alloc.html#a9d85cf47c4ecd0580ec623c42006dd1b">get_allocator</a> () const</td></tr> |
| <tr class="separator:a9d85cf47c4ecd0580ec623c42006dd1b"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a5a2b7a58dc85678d08752945ff655362"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1compact__theta__sketch__alloc.html#a5a2b7a58dc85678d08752945ff655362">is_empty</a> () const</td></tr> |
| <tr class="separator:a5a2b7a58dc85678d08752945ff655362"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a5f5b393314c0c1819f79b73232a506e8"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1compact__theta__sketch__alloc.html#a5f5b393314c0c1819f79b73232a506e8">is_ordered</a> () const</td></tr> |
| <tr class="separator:a5f5b393314c0c1819f79b73232a506e8"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a2b072fe55377eb51a6ee477827fc3b95"><td class="memItemLeft" align="right" valign="top">virtual uint64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1compact__theta__sketch__alloc.html#a2b072fe55377eb51a6ee477827fc3b95">get_theta64</a> () const</td></tr> |
| <tr class="separator:a2b072fe55377eb51a6ee477827fc3b95"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a31fa76458d81a17dbebfcb828e531f14"><td class="memItemLeft" align="right" valign="top">virtual uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1compact__theta__sketch__alloc.html#a31fa76458d81a17dbebfcb828e531f14">get_num_retained</a> () const</td></tr> |
| <tr class="separator:a31fa76458d81a17dbebfcb828e531f14"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a6f69b50bc13da11d255d0e583e2376ba"><td class="memItemLeft" align="right" valign="top">virtual uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1compact__theta__sketch__alloc.html#a6f69b50bc13da11d255d0e583e2376ba">get_seed_hash</a> () const</td></tr> |
| <tr class="separator:a6f69b50bc13da11d255d0e583e2376ba"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a1bcdd98ee6e6eb9b501b8dc5de5e8924"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1compact__theta__sketch__alloc.html#a1bcdd98ee6e6eb9b501b8dc5de5e8924">serialize</a> (std::ostream &os) const</td></tr> |
| <tr class="memdesc:a1bcdd98ee6e6eb9b501b8dc5de5e8924"><td class="mdescLeft"> </td><td class="mdescRight">This method serializes the sketch into a given stream in a binary form. <a href="classdatasketches_1_1compact__theta__sketch__alloc.html#a1bcdd98ee6e6eb9b501b8dc5de5e8924">More...</a><br /></td></tr> |
| <tr class="separator:a1bcdd98ee6e6eb9b501b8dc5de5e8924"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a1c7a57911806d47ee3cebe9fad59f836"><td class="memItemLeft" align="right" valign="top">vector_bytes </td><td class="memItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1compact__theta__sketch__alloc.html#a1c7a57911806d47ee3cebe9fad59f836">serialize</a> (unsigned header_size_bytes=0) const</td></tr> |
| <tr class="memdesc:a1c7a57911806d47ee3cebe9fad59f836"><td class="mdescLeft"> </td><td class="mdescRight">This method serializes the sketch as a vector of bytes. <a href="classdatasketches_1_1compact__theta__sketch__alloc.html#a1c7a57911806d47ee3cebe9fad59f836">More...</a><br /></td></tr> |
| <tr class="separator:a1c7a57911806d47ee3cebe9fad59f836"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ad340191a312ae81cd5aa18e4e0145460"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1compact__theta__sketch__alloc.html#ad340191a312ae81cd5aa18e4e0145460">serialize_compressed</a> (std::ostream &os) const</td></tr> |
| <tr class="memdesc:ad340191a312ae81cd5aa18e4e0145460"><td class="mdescLeft"> </td><td class="mdescRight">This method serializes the sketch into a given stream in a compressed binary form. <a href="classdatasketches_1_1compact__theta__sketch__alloc.html#ad340191a312ae81cd5aa18e4e0145460">More...</a><br /></td></tr> |
| <tr class="separator:ad340191a312ae81cd5aa18e4e0145460"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:af3f9c5afb4b31aa40bf248cc96ff5daf"><td class="memItemLeft" align="right" valign="top">vector_bytes </td><td class="memItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1compact__theta__sketch__alloc.html#af3f9c5afb4b31aa40bf248cc96ff5daf">serialize_compressed</a> (unsigned header_size_bytes=0) const</td></tr> |
| <tr class="memdesc:af3f9c5afb4b31aa40bf248cc96ff5daf"><td class="mdescLeft"> </td><td class="mdescRight">This method serializes the sketch as a vector of bytes. <a href="classdatasketches_1_1compact__theta__sketch__alloc.html#af3f9c5afb4b31aa40bf248cc96ff5daf">More...</a><br /></td></tr> |
| <tr class="separator:af3f9c5afb4b31aa40bf248cc96ff5daf"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ad950587c89b4306f927b08b5e5cb7e89"><td class="memItemLeft" align="right" valign="top">virtual iterator </td><td class="memItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1compact__theta__sketch__alloc.html#ad950587c89b4306f927b08b5e5cb7e89">begin</a> ()</td></tr> |
| <tr class="memdesc:ad950587c89b4306f927b08b5e5cb7e89"><td class="mdescLeft"> </td><td class="mdescRight">Iterator over hash values in this sketch. <a href="classdatasketches_1_1compact__theta__sketch__alloc.html#ad950587c89b4306f927b08b5e5cb7e89">More...</a><br /></td></tr> |
| <tr class="separator:ad950587c89b4306f927b08b5e5cb7e89"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a7727305d5e1ec66a181e22c43af9a581"><td class="memItemLeft" align="right" valign="top">virtual iterator </td><td class="memItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1compact__theta__sketch__alloc.html#a7727305d5e1ec66a181e22c43af9a581">end</a> ()</td></tr> |
| <tr class="memdesc:a7727305d5e1ec66a181e22c43af9a581"><td class="mdescLeft"> </td><td class="mdescRight">Iterator pointing past the valid range. <a href="classdatasketches_1_1compact__theta__sketch__alloc.html#a7727305d5e1ec66a181e22c43af9a581">More...</a><br /></td></tr> |
| <tr class="separator:a7727305d5e1ec66a181e22c43af9a581"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ad5c959a538216a09ab28c5283585956c"><td class="memItemLeft" align="right" valign="top">virtual const_iterator </td><td class="memItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1compact__theta__sketch__alloc.html#ad5c959a538216a09ab28c5283585956c">begin</a> () const</td></tr> |
| <tr class="memdesc:ad5c959a538216a09ab28c5283585956c"><td class="mdescLeft"> </td><td class="mdescRight">Const iterator over hash values in this sketch. <a href="classdatasketches_1_1compact__theta__sketch__alloc.html#ad5c959a538216a09ab28c5283585956c">More...</a><br /></td></tr> |
| <tr class="separator:ad5c959a538216a09ab28c5283585956c"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ae11e60e117300685401961e36f196f7a"><td class="memItemLeft" align="right" valign="top">virtual const_iterator </td><td class="memItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1compact__theta__sketch__alloc.html#ae11e60e117300685401961e36f196f7a">end</a> () const</td></tr> |
| <tr class="memdesc:ae11e60e117300685401961e36f196f7a"><td class="mdescLeft"> </td><td class="mdescRight">Const iterator pointing past the valid range. <a href="classdatasketches_1_1compact__theta__sketch__alloc.html#ae11e60e117300685401961e36f196f7a">More...</a><br /></td></tr> |
| <tr class="separator:ae11e60e117300685401961e36f196f7a"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="inherit_header pub_methods_classdatasketches_1_1base__theta__sketch__alloc"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classdatasketches_1_1base__theta__sketch__alloc')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classdatasketches_1_1base__theta__sketch__alloc.html">base_theta_sketch_alloc< std::allocator< uint64_t > ></a></td></tr> |
| <tr class="memitem:a2afb71f2ef2d82290be4c8eafc08f2a2 inherit pub_methods_classdatasketches_1_1base__theta__sketch__alloc"><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1base__theta__sketch__alloc.html#a2afb71f2ef2d82290be4c8eafc08f2a2">get_estimate</a> () const</td></tr> |
| <tr class="separator:a2afb71f2ef2d82290be4c8eafc08f2a2 inherit pub_methods_classdatasketches_1_1base__theta__sketch__alloc"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a2e5c990494331d901c3b38cd4eb316e6 inherit pub_methods_classdatasketches_1_1base__theta__sketch__alloc"><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1base__theta__sketch__alloc.html#a2e5c990494331d901c3b38cd4eb316e6">get_lower_bound</a> (uint8_t num_std_devs) const</td></tr> |
| <tr class="memdesc:a2e5c990494331d901c3b38cd4eb316e6 inherit pub_methods_classdatasketches_1_1base__theta__sketch__alloc"><td class="mdescLeft"> </td><td class="mdescRight">Returns the approximate lower error bound given a number of standard deviations. <a href="classdatasketches_1_1base__theta__sketch__alloc.html#a2e5c990494331d901c3b38cd4eb316e6">More...</a><br /></td></tr> |
| <tr class="separator:a2e5c990494331d901c3b38cd4eb316e6 inherit pub_methods_classdatasketches_1_1base__theta__sketch__alloc"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aa408e90fef0f988eca7d132875c7c7e1 inherit pub_methods_classdatasketches_1_1base__theta__sketch__alloc"><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1base__theta__sketch__alloc.html#aa408e90fef0f988eca7d132875c7c7e1">get_upper_bound</a> (uint8_t num_std_devs) const</td></tr> |
| <tr class="memdesc:aa408e90fef0f988eca7d132875c7c7e1 inherit pub_methods_classdatasketches_1_1base__theta__sketch__alloc"><td class="mdescLeft"> </td><td class="mdescRight">Returns the approximate upper error bound given a number of standard deviations. <a href="classdatasketches_1_1base__theta__sketch__alloc.html#aa408e90fef0f988eca7d132875c7c7e1">More...</a><br /></td></tr> |
| <tr class="separator:aa408e90fef0f988eca7d132875c7c7e1 inherit pub_methods_classdatasketches_1_1base__theta__sketch__alloc"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ae95a04b1d7dccb3d9b3f3c3d087aa8e6 inherit pub_methods_classdatasketches_1_1base__theta__sketch__alloc"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1base__theta__sketch__alloc.html#ae95a04b1d7dccb3d9b3f3c3d087aa8e6">is_estimation_mode</a> () const</td></tr> |
| <tr class="separator:ae95a04b1d7dccb3d9b3f3c3d087aa8e6 inherit pub_methods_classdatasketches_1_1base__theta__sketch__alloc"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aa784d7f8ac02e9c4e26e7fe9f177a7aa inherit pub_methods_classdatasketches_1_1base__theta__sketch__alloc"><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1base__theta__sketch__alloc.html#aa784d7f8ac02e9c4e26e7fe9f177a7aa">get_theta</a> () const</td></tr> |
| <tr class="separator:aa784d7f8ac02e9c4e26e7fe9f177a7aa inherit pub_methods_classdatasketches_1_1base__theta__sketch__alloc"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a60a5fe73c86554c313705666f8fb227a inherit pub_methods_classdatasketches_1_1base__theta__sketch__alloc"><td class="memItemLeft" align="right" valign="top">virtual string< std::allocator< uint64_t > > </td><td class="memItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1base__theta__sketch__alloc.html#a60a5fe73c86554c313705666f8fb227a">to_string</a> (bool print_items=false) const</td></tr> |
| <tr class="memdesc:a60a5fe73c86554c313705666f8fb227a inherit pub_methods_classdatasketches_1_1base__theta__sketch__alloc"><td class="mdescLeft"> </td><td class="mdescRight">Provides a human-readable summary of this sketch as a string. <a href="classdatasketches_1_1base__theta__sketch__alloc.html#a60a5fe73c86554c313705666f8fb227a">More...</a><br /></td></tr> |
| <tr class="separator:a60a5fe73c86554c313705666f8fb227a inherit pub_methods_classdatasketches_1_1base__theta__sketch__alloc"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a> |
| Static Public Member Functions</h2></td></tr> |
| <tr class="memitem:a8fd020f8f0f495f6adee994e872b9883"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classdatasketches_1_1compact__theta__sketch__alloc.html">compact_theta_sketch_alloc</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1compact__theta__sketch__alloc.html#a8fd020f8f0f495f6adee994e872b9883">deserialize</a> (std::istream &is, uint64_t seed=DEFAULT_SEED, const Allocator &allocator=Allocator())</td></tr> |
| <tr class="memdesc:a8fd020f8f0f495f6adee994e872b9883"><td class="mdescLeft"> </td><td class="mdescRight">This method deserializes a sketch from a given stream. <a href="classdatasketches_1_1compact__theta__sketch__alloc.html#a8fd020f8f0f495f6adee994e872b9883">More...</a><br /></td></tr> |
| <tr class="separator:a8fd020f8f0f495f6adee994e872b9883"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a2ee872dc2dadbb9244dcae2631c8fc2d"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classdatasketches_1_1compact__theta__sketch__alloc.html">compact_theta_sketch_alloc</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1compact__theta__sketch__alloc.html#a2ee872dc2dadbb9244dcae2631c8fc2d">deserialize</a> (const void *bytes, size_t size, uint64_t seed=DEFAULT_SEED, const Allocator &allocator=Allocator())</td></tr> |
| <tr class="memdesc:a2ee872dc2dadbb9244dcae2631c8fc2d"><td class="mdescLeft"> </td><td class="mdescRight">This method deserializes a sketch from a given array of bytes. <a href="classdatasketches_1_1compact__theta__sketch__alloc.html#a2ee872dc2dadbb9244dcae2631c8fc2d">More...</a><br /></td></tr> |
| <tr class="separator:a2ee872dc2dadbb9244dcae2631c8fc2d"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><h3>template<typename Allocator = std::allocator<uint64_t>><br /> |
| class datasketches::compact_theta_sketch_alloc< Allocator ></h3> |
| |
| <p>Compact Theta sketch. </p> |
| <p>This is an immutable form of the Theta sketch, the form that can be serialized and deserialized. </p> |
| </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a id="a0eaea2a9894acb7b92f5c3f3224c618c"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a0eaea2a9894acb7b92f5c3f3224c618c">◆ </a></span>compact_theta_sketch_alloc() <span class="overload">[1/3]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classdatasketches_1_1compact__theta__sketch__alloc.html">compact_theta_sketch_alloc</a> </td> |
| <td>(</td> |
| <td class="paramtype">const Other & </td> |
| <td class="paramname"><em>other</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">bool </td> |
| <td class="paramname"><em>ordered</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Copy constructor. </p> |
| <p>Constructs a compact sketch from any other type of Theta sketch </p><dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">other</td><td>sketch to be constructed from </td></tr> |
| <tr><td class="paramname">ordered</td><td>if true make the resulting sketch ordered </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="a0f097d346334e1ad237b64133d0adf94"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a0f097d346334e1ad237b64133d0adf94">◆ </a></span>compact_theta_sketch_alloc() <span class="overload">[2/3]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classdatasketches_1_1compact__theta__sketch__alloc.html">compact_theta_sketch_alloc</a> </td> |
| <td>(</td> |
| <td class="paramtype">const <a class="el" href="classdatasketches_1_1compact__theta__sketch__alloc.html">compact_theta_sketch_alloc</a>< Allocator > & </td> |
| <td class="paramname"><em>other</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">default</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Copy constructor. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">other</td><td>sketch to be copied </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="ab261a20e0595a67b16f2fc542443fa45"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ab261a20e0595a67b16f2fc542443fa45">◆ </a></span>compact_theta_sketch_alloc() <span class="overload">[3/3]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classdatasketches_1_1compact__theta__sketch__alloc.html">compact_theta_sketch_alloc</a> </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="classdatasketches_1_1compact__theta__sketch__alloc.html">compact_theta_sketch_alloc</a>< Allocator > && </td> |
| <td class="paramname"><em>other</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">default</span><span class="mlabel">noexcept</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Move constructor. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">other</td><td>sketch to be moved </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a id="ada3a2bda671ddcc3dd65db48a978251d"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ada3a2bda671ddcc3dd65db48a978251d">◆ </a></span>operator=() <span class="overload">[1/2]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classdatasketches_1_1compact__theta__sketch__alloc.html">compact_theta_sketch_alloc</a>& operator= </td> |
| <td>(</td> |
| <td class="paramtype">const <a class="el" href="classdatasketches_1_1compact__theta__sketch__alloc.html">compact_theta_sketch_alloc</a>< Allocator > & </td> |
| <td class="paramname"><em>other</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">default</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Copy assignment. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">other</td><td>sketch to be copied </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>reference to this sketch </dd></dl> |
| |
| </div> |
| </div> |
| <a id="ad0d038d5ac22cd84233efba29156b07e"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ad0d038d5ac22cd84233efba29156b07e">◆ </a></span>operator=() <span class="overload">[2/2]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classdatasketches_1_1compact__theta__sketch__alloc.html">compact_theta_sketch_alloc</a>& operator= </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="classdatasketches_1_1compact__theta__sketch__alloc.html">compact_theta_sketch_alloc</a>< Allocator > && </td> |
| <td class="paramname"><em>other</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">default</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Move assignment. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">other</td><td>sketch to be moved </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>reference to this sketch </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a9d85cf47c4ecd0580ec623c42006dd1b"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a9d85cf47c4ecd0580ec623c42006dd1b">◆ </a></span>get_allocator()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">A get_allocator</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <dl class="section return"><dt>Returns</dt><dd>allocator </dd></dl> |
| |
| <p>Implements <a class="el" href="classdatasketches_1_1base__theta__sketch__alloc.html#ae99d253473075b7c10569d4565d7ee90">base_theta_sketch_alloc< std::allocator< uint64_t > ></a>.</p> |
| |
| </div> |
| </div> |
| <a id="a5a2b7a58dc85678d08752945ff655362"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a5a2b7a58dc85678d08752945ff655362">◆ </a></span>is_empty()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool is_empty</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <dl class="section return"><dt>Returns</dt><dd>true if this sketch represents an empty set (not the same as no retained entries!) </dd></dl> |
| |
| <p>Implements <a class="el" href="classdatasketches_1_1base__theta__sketch__alloc.html#a501185051053fcccae5f73f324febcdf">base_theta_sketch_alloc< std::allocator< uint64_t > ></a>.</p> |
| |
| </div> |
| </div> |
| <a id="a5f5b393314c0c1819f79b73232a506e8"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a5f5b393314c0c1819f79b73232a506e8">◆ </a></span>is_ordered()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool is_ordered</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <dl class="section return"><dt>Returns</dt><dd>true if retained entries are ordered </dd></dl> |
| |
| <p>Implements <a class="el" href="classdatasketches_1_1base__theta__sketch__alloc.html#a358923431da50e8d43651795e2515c01">base_theta_sketch_alloc< std::allocator< uint64_t > ></a>.</p> |
| |
| </div> |
| </div> |
| <a id="a2b072fe55377eb51a6ee477827fc3b95"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a2b072fe55377eb51a6ee477827fc3b95">◆ </a></span>get_theta64()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">uint64_t get_theta64</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <dl class="section return"><dt>Returns</dt><dd>theta as a positive integer between 0 and LLONG_MAX </dd></dl> |
| |
| <p>Implements <a class="el" href="classdatasketches_1_1base__theta__sketch__alloc.html#aef2e47ecd9c33fc2a6a9e905a2a0516a">base_theta_sketch_alloc< std::allocator< uint64_t > ></a>.</p> |
| |
| </div> |
| </div> |
| <a id="a31fa76458d81a17dbebfcb828e531f14"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a31fa76458d81a17dbebfcb828e531f14">◆ </a></span>get_num_retained()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">uint32_t get_num_retained</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <dl class="section return"><dt>Returns</dt><dd>the number of retained entries in the sketch </dd></dl> |
| |
| <p>Implements <a class="el" href="classdatasketches_1_1base__theta__sketch__alloc.html#a9c71f891e4b0d3d3dc6a6f4b30ed9261">base_theta_sketch_alloc< std::allocator< uint64_t > ></a>.</p> |
| |
| </div> |
| </div> |
| <a id="a6f69b50bc13da11d255d0e583e2376ba"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a6f69b50bc13da11d255d0e583e2376ba">◆ </a></span>get_seed_hash()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">uint16_t get_seed_hash</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <dl class="section return"><dt>Returns</dt><dd>hash of the seed that was used to hash the input </dd></dl> |
| |
| <p>Implements <a class="el" href="classdatasketches_1_1base__theta__sketch__alloc.html#ab76bd6487f5a75a356083bfe163a7079">base_theta_sketch_alloc< std::allocator< uint64_t > ></a>.</p> |
| |
| </div> |
| </div> |
| <a id="a1bcdd98ee6e6eb9b501b8dc5de5e8924"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a1bcdd98ee6e6eb9b501b8dc5de5e8924">◆ </a></span>serialize() <span class="overload">[1/2]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void serialize </td> |
| <td>(</td> |
| <td class="paramtype">std::ostream & </td> |
| <td class="paramname"><em>os</em></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>This method serializes the sketch into a given stream in a binary form. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">os</td><td>output stream </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="a1c7a57911806d47ee3cebe9fad59f836"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a1c7a57911806d47ee3cebe9fad59f836">◆ </a></span>serialize() <span class="overload">[2/2]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">auto serialize </td> |
| <td>(</td> |
| <td class="paramtype">unsigned </td> |
| <td class="paramname"><em>header_size_bytes</em> = <code>0</code></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>This method serializes the sketch as a vector of bytes. </p> |
| <p>An optional header can be reserved in front of the sketch. It is an uninitialized space of a given size. This header is used in Datasketches PostgreSQL extension. </p><dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">header_size_bytes</td><td>space to reserve in front of the sketch </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="ad340191a312ae81cd5aa18e4e0145460"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ad340191a312ae81cd5aa18e4e0145460">◆ </a></span>serialize_compressed() <span class="overload">[1/2]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void serialize_compressed </td> |
| <td>(</td> |
| <td class="paramtype">std::ostream & </td> |
| <td class="paramname"><em>os</em></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>This method serializes the sketch into a given stream in a compressed binary form. </p> |
| <p>Compression is applied to ordered sketches except empty and single item. For unordered, empty and single item sketches this method is equivalent to <a class="el" href="classdatasketches_1_1compact__theta__sketch__alloc.html#a1bcdd98ee6e6eb9b501b8dc5de5e8924" title="This method serializes the sketch into a given stream in a binary form.">serialize()</a> </p><dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">os</td><td>output stream </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="af3f9c5afb4b31aa40bf248cc96ff5daf"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#af3f9c5afb4b31aa40bf248cc96ff5daf">◆ </a></span>serialize_compressed() <span class="overload">[2/2]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">auto serialize_compressed </td> |
| <td>(</td> |
| <td class="paramtype">unsigned </td> |
| <td class="paramname"><em>header_size_bytes</em> = <code>0</code></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>This method serializes the sketch as a vector of bytes. </p> |
| <p>An optional header can be reserved in front of the sketch. It is an uninitialized space of a given size. This header is used in Datasketches PostgreSQL extension. Compression is applied to ordered sketches except empty and single item. For unordered, empty and single item sketches this method is equivalent to <a class="el" href="classdatasketches_1_1compact__theta__sketch__alloc.html#a1bcdd98ee6e6eb9b501b8dc5de5e8924" title="This method serializes the sketch into a given stream in a binary form.">serialize()</a> </p><dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">header_size_bytes</td><td>space to reserve in front of the sketch </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="ad950587c89b4306f927b08b5e5cb7e89"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ad950587c89b4306f927b08b5e5cb7e89">◆ </a></span>begin() <span class="overload">[1/2]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">auto begin</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Iterator over hash values in this sketch. </p> |
| <dl class="section return"><dt>Returns</dt><dd>begin iterator </dd></dl> |
| |
| <p>Implements <a class="el" href="classdatasketches_1_1theta__sketch__alloc.html#ad1d91335a83907ae2ef026786e12ba0c">theta_sketch_alloc< std::allocator< uint64_t > ></a>.</p> |
| |
| </div> |
| </div> |
| <a id="a7727305d5e1ec66a181e22c43af9a581"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a7727305d5e1ec66a181e22c43af9a581">◆ </a></span>end() <span class="overload">[1/2]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">auto end</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Iterator pointing past the valid range. </p> |
| <p>Not to be incremented or dereferenced. </p><dl class="section return"><dt>Returns</dt><dd>end iterator </dd></dl> |
| |
| <p>Implements <a class="el" href="classdatasketches_1_1theta__sketch__alloc.html#aa7f5423261c0a178f37911746353c0b7">theta_sketch_alloc< std::allocator< uint64_t > ></a>.</p> |
| |
| </div> |
| </div> |
| <a id="ad5c959a538216a09ab28c5283585956c"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ad5c959a538216a09ab28c5283585956c">◆ </a></span>begin() <span class="overload">[2/2]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">auto begin</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Const iterator over hash values in this sketch. </p> |
| <dl class="section return"><dt>Returns</dt><dd>begin iterator </dd></dl> |
| |
| <p>Implements <a class="el" href="classdatasketches_1_1theta__sketch__alloc.html#a250dc1485aaf4ef61332af5c5fdb4715">theta_sketch_alloc< std::allocator< uint64_t > ></a>.</p> |
| |
| </div> |
| </div> |
| <a id="ae11e60e117300685401961e36f196f7a"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ae11e60e117300685401961e36f196f7a">◆ </a></span>end() <span class="overload">[2/2]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">auto end</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Const iterator pointing past the valid range. </p> |
| <p>Not to be incremented or dereferenced. </p><dl class="section return"><dt>Returns</dt><dd>end iterator </dd></dl> |
| |
| <p>Implements <a class="el" href="classdatasketches_1_1theta__sketch__alloc.html#a47bfa611ed719e4b41ceb653376c1677">theta_sketch_alloc< std::allocator< uint64_t > ></a>.</p> |
| |
| </div> |
| </div> |
| <a id="a8fd020f8f0f495f6adee994e872b9883"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a8fd020f8f0f495f6adee994e872b9883">◆ </a></span>deserialize() <span class="overload">[1/2]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">static <a class="el" href="classdatasketches_1_1compact__theta__sketch__alloc.html">compact_theta_sketch_alloc</a> deserialize </td> |
| <td>(</td> |
| <td class="paramtype">std::istream & </td> |
| <td class="paramname"><em>is</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 class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const Allocator & </td> |
| <td class="paramname"><em>allocator</em> = <code>Allocator()</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">static</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>This method deserializes a sketch from a given stream. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">is</td><td>input stream </td></tr> |
| <tr><td class="paramname">seed</td><td>the seed for the hash function that was used to create the sketch </td></tr> |
| <tr><td class="paramname">allocator</td><td>instance of an Allocator </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>an instance of the sketch </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a2ee872dc2dadbb9244dcae2631c8fc2d"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a2ee872dc2dadbb9244dcae2631c8fc2d">◆ </a></span>deserialize() <span class="overload">[2/2]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">static <a class="el" href="classdatasketches_1_1compact__theta__sketch__alloc.html">compact_theta_sketch_alloc</a> deserialize </td> |
| <td>(</td> |
| <td class="paramtype">const void * </td> |
| <td class="paramname"><em>bytes</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">size_t </td> |
| <td class="paramname"><em>size</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 class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const Allocator & </td> |
| <td class="paramname"><em>allocator</em> = <code>Allocator()</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">static</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>This method deserializes a sketch from a given array of bytes. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">bytes</td><td>pointer to the array of bytes </td></tr> |
| <tr><td class="paramname">size</td><td>the size of the array </td></tr> |
| <tr><td class="paramname">seed</td><td>the seed for the hash function that was used to create the sketch </td></tr> |
| <tr><td class="paramname">allocator</td><td>instance of an Allocator </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>an instance of the sketch </dd></dl> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following files:<ul> |
| <li>theta/include/<a class="el" href="theta__sketch_8hpp_source.html">theta_sketch.hpp</a></li> |
| <li>theta/include/<a class="el" href="theta__sketch__impl_8hpp_source.html">theta_sketch_impl.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.1 |
| </small></address> |
| </body> |
| </html> |
