| <!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: base_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_1base__theta__sketch__alloc.html">base_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="classdatasketches_1_1base__theta__sketch__alloc-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">base_theta_sketch_alloc< Allocator > Class Template Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Abstract base class for Theta sketch. |
| <a href="classdatasketches_1_1base__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> |
| <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:ae99d253473075b7c10569d4565d7ee90"><td class="memItemLeft" align="right" valign="top">virtual Allocator </td><td class="memItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1base__theta__sketch__alloc.html#ae99d253473075b7c10569d4565d7ee90">get_allocator</a> () const =0</td></tr> |
| <tr class="separator:ae99d253473075b7c10569d4565d7ee90"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a501185051053fcccae5f73f324febcdf"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1base__theta__sketch__alloc.html#a501185051053fcccae5f73f324febcdf">is_empty</a> () const =0</td></tr> |
| <tr class="separator:a501185051053fcccae5f73f324febcdf"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a2afb71f2ef2d82290be4c8eafc08f2a2"><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"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a2e5c990494331d901c3b38cd4eb316e6"><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"><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"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aa408e90fef0f988eca7d132875c7c7e1"><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"><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"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ae95a04b1d7dccb3d9b3f3c3d087aa8e6"><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"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aa784d7f8ac02e9c4e26e7fe9f177a7aa"><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"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aef2e47ecd9c33fc2a6a9e905a2a0516a"><td class="memItemLeft" align="right" valign="top">virtual uint64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1base__theta__sketch__alloc.html#aef2e47ecd9c33fc2a6a9e905a2a0516a">get_theta64</a> () const =0</td></tr> |
| <tr class="separator:aef2e47ecd9c33fc2a6a9e905a2a0516a"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a9c71f891e4b0d3d3dc6a6f4b30ed9261"><td class="memItemLeft" align="right" valign="top">virtual uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1base__theta__sketch__alloc.html#a9c71f891e4b0d3d3dc6a6f4b30ed9261">get_num_retained</a> () const =0</td></tr> |
| <tr class="separator:a9c71f891e4b0d3d3dc6a6f4b30ed9261"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ab76bd6487f5a75a356083bfe163a7079"><td class="memItemLeft" align="right" valign="top">virtual uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1base__theta__sketch__alloc.html#ab76bd6487f5a75a356083bfe163a7079">get_seed_hash</a> () const =0</td></tr> |
| <tr class="separator:ab76bd6487f5a75a356083bfe163a7079"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a358923431da50e8d43651795e2515c01"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1base__theta__sketch__alloc.html#a358923431da50e8d43651795e2515c01">is_ordered</a> () const =0</td></tr> |
| <tr class="separator:a358923431da50e8d43651795e2515c01"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a60a5fe73c86554c313705666f8fb227a"><td class="memItemLeft" align="right" valign="top">virtual string< Allocator > </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"><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"><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::base_theta_sketch_alloc< Allocator ></h3> |
| |
| <p>Abstract base class for Theta sketch. </p> |
| </div><h2 class="groupheader">Member Function Documentation</h2> |
| <a id="ae99d253473075b7c10569d4565d7ee90"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ae99d253473075b7c10569d4565d7ee90">◆ </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">virtual Allocator get_allocator </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <dl class="section return"><dt>Returns</dt><dd>allocator </dd></dl> |
| |
| <p>Implemented in <a class="el" href="classdatasketches_1_1wrapped__compact__theta__sketch__alloc.html#a9d85cf47c4ecd0580ec623c42006dd1b">wrapped_compact_theta_sketch_alloc< Allocator ></a>, <a class="el" href="classdatasketches_1_1compact__theta__sketch__alloc.html#a9d85cf47c4ecd0580ec623c42006dd1b">compact_theta_sketch_alloc< Allocator ></a>, and <a class="el" href="classdatasketches_1_1update__theta__sketch__alloc.html#a9d85cf47c4ecd0580ec623c42006dd1b">update_theta_sketch_alloc< Allocator ></a>.</p> |
| |
| </div> |
| </div> |
| <a id="a501185051053fcccae5f73f324febcdf"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a501185051053fcccae5f73f324febcdf">◆ </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">virtual bool is_empty </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">pure 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>Implemented in <a class="el" href="classdatasketches_1_1wrapped__compact__theta__sketch__alloc.html#a5a2b7a58dc85678d08752945ff655362">wrapped_compact_theta_sketch_alloc< Allocator ></a>, <a class="el" href="classdatasketches_1_1compact__theta__sketch__alloc.html#a5a2b7a58dc85678d08752945ff655362">compact_theta_sketch_alloc< Allocator ></a>, and <a class="el" href="classdatasketches_1_1update__theta__sketch__alloc.html#a5a2b7a58dc85678d08752945ff655362">update_theta_sketch_alloc< Allocator ></a>.</p> |
| |
| </div> |
| </div> |
| <a id="a2afb71f2ef2d82290be4c8eafc08f2a2"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a2afb71f2ef2d82290be4c8eafc08f2a2">◆ </a></span>get_estimate()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">double get_estimate</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <dl class="section return"><dt>Returns</dt><dd>estimate of the distinct count of the input stream </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a2e5c990494331d901c3b38cd4eb316e6"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a2e5c990494331d901c3b38cd4eb316e6">◆ </a></span>get_lower_bound()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">double get_lower_bound </td> |
| <td>(</td> |
| <td class="paramtype">uint8_t </td> |
| <td class="paramname"><em>num_std_devs</em></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Returns the approximate lower error bound given a number of standard deviations. </p> |
| <p>This parameter is similar to the number of standard deviations of the normal distribution and corresponds to approximately 67%, 95% and 99% confidence intervals. </p><dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">num_std_devs</td><td>number of Standard Deviations (1, 2 or 3) </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>the lower bound </dd></dl> |
| |
| </div> |
| </div> |
| <a id="aa408e90fef0f988eca7d132875c7c7e1"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aa408e90fef0f988eca7d132875c7c7e1">◆ </a></span>get_upper_bound()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">double get_upper_bound </td> |
| <td>(</td> |
| <td class="paramtype">uint8_t </td> |
| <td class="paramname"><em>num_std_devs</em></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Returns the approximate upper error bound given a number of standard deviations. </p> |
| <p>This parameter is similar to the number of standard deviations of the normal distribution and corresponds to approximately 67%, 95% and 99% confidence intervals. </p><dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">num_std_devs</td><td>number of Standard Deviations (1, 2 or 3) </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>the upper bound </dd></dl> |
| |
| </div> |
| </div> |
| <a id="ae95a04b1d7dccb3d9b3f3c3d087aa8e6"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ae95a04b1d7dccb3d9b3f3c3d087aa8e6">◆ </a></span>is_estimation_mode()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool is_estimation_mode</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <dl class="section return"><dt>Returns</dt><dd>true if the sketch is in estimation mode (as opposed to exact mode) </dd></dl> |
| |
| </div> |
| </div> |
| <a id="aa784d7f8ac02e9c4e26e7fe9f177a7aa"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aa784d7f8ac02e9c4e26e7fe9f177a7aa">◆ </a></span>get_theta()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">double get_theta</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <dl class="section return"><dt>Returns</dt><dd>theta as a fraction from 0 to 1 (effective sampling rate) </dd></dl> |
| |
| </div> |
| </div> |
| <a id="aef2e47ecd9c33fc2a6a9e905a2a0516a"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aef2e47ecd9c33fc2a6a9e905a2a0516a">◆ </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">virtual uint64_t get_theta64 </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">pure 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>Implemented in <a class="el" href="classdatasketches_1_1wrapped__compact__theta__sketch__alloc.html#a2b072fe55377eb51a6ee477827fc3b95">wrapped_compact_theta_sketch_alloc< Allocator ></a>, <a class="el" href="classdatasketches_1_1compact__theta__sketch__alloc.html#a2b072fe55377eb51a6ee477827fc3b95">compact_theta_sketch_alloc< Allocator ></a>, and <a class="el" href="classdatasketches_1_1update__theta__sketch__alloc.html#a2b072fe55377eb51a6ee477827fc3b95">update_theta_sketch_alloc< Allocator ></a>.</p> |
| |
| </div> |
| </div> |
| <a id="a9c71f891e4b0d3d3dc6a6f4b30ed9261"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a9c71f891e4b0d3d3dc6a6f4b30ed9261">◆ </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">virtual uint32_t get_num_retained </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">pure 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>Implemented in <a class="el" href="classdatasketches_1_1wrapped__compact__theta__sketch__alloc.html#a31fa76458d81a17dbebfcb828e531f14">wrapped_compact_theta_sketch_alloc< Allocator ></a>, <a class="el" href="classdatasketches_1_1compact__theta__sketch__alloc.html#a31fa76458d81a17dbebfcb828e531f14">compact_theta_sketch_alloc< Allocator ></a>, and <a class="el" href="classdatasketches_1_1update__theta__sketch__alloc.html#a31fa76458d81a17dbebfcb828e531f14">update_theta_sketch_alloc< Allocator ></a>.</p> |
| |
| </div> |
| </div> |
| <a id="ab76bd6487f5a75a356083bfe163a7079"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ab76bd6487f5a75a356083bfe163a7079">◆ </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">virtual uint16_t get_seed_hash </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">pure 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>Implemented in <a class="el" href="classdatasketches_1_1wrapped__compact__theta__sketch__alloc.html#a6f69b50bc13da11d255d0e583e2376ba">wrapped_compact_theta_sketch_alloc< Allocator ></a>, <a class="el" href="classdatasketches_1_1compact__theta__sketch__alloc.html#a6f69b50bc13da11d255d0e583e2376ba">compact_theta_sketch_alloc< Allocator ></a>, and <a class="el" href="classdatasketches_1_1update__theta__sketch__alloc.html#a6f69b50bc13da11d255d0e583e2376ba">update_theta_sketch_alloc< Allocator ></a>.</p> |
| |
| </div> |
| </div> |
| <a id="a358923431da50e8d43651795e2515c01"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a358923431da50e8d43651795e2515c01">◆ </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">virtual bool is_ordered </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">pure 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>Implemented in <a class="el" href="classdatasketches_1_1wrapped__compact__theta__sketch__alloc.html#a5f5b393314c0c1819f79b73232a506e8">wrapped_compact_theta_sketch_alloc< Allocator ></a>, <a class="el" href="classdatasketches_1_1compact__theta__sketch__alloc.html#a5f5b393314c0c1819f79b73232a506e8">compact_theta_sketch_alloc< Allocator ></a>, and <a class="el" href="classdatasketches_1_1update__theta__sketch__alloc.html#a5f5b393314c0c1819f79b73232a506e8">update_theta_sketch_alloc< Allocator ></a>.</p> |
| |
| </div> |
| </div> |
| <a id="a60a5fe73c86554c313705666f8fb227a"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a60a5fe73c86554c313705666f8fb227a">◆ </a></span>to_string()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">string< A > to_string </td> |
| <td>(</td> |
| <td class="paramtype">bool </td> |
| <td class="paramname"><em>print_items</em> = <code>false</code></td><td>)</td> |
| <td> const</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>Provides a human-readable summary of this sketch as a string. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">print_items</td><td>if true include the list of items retained by the sketch </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>sketch summary as a string </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> |
