| <!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: cpc_union_alloc< A > 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_1cpc__union__alloc.html">cpc_union_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_1cpc__union__alloc-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">cpc_union_alloc< A > Class Template Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>High performance C++ implementation of Compressed Probabilistic Counting (CPC) Union. |
| <a href="classdatasketches_1_1cpc__union__alloc.html#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="cpc__union_8hpp_source.html">cpc_union.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:a7d54d46a338588afe9fb768cb0e22082"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1cpc__union__alloc.html#a7d54d46a338588afe9fb768cb0e22082">cpc_union_alloc</a> (uint8_t lg_k=<a class="el" href="namespacedatasketches_1_1cpc__constants.html#a78468167a70640384c2de5e04fabe4fd">cpc_constants::DEFAULT_LG_K</a>, uint64_t seed=DEFAULT_SEED, const A &allocator=A())</td></tr> |
| <tr class="memdesc:a7d54d46a338588afe9fb768cb0e22082"><td class="mdescLeft"> </td><td class="mdescRight">Creates an instance of the union given the lg_k parameter and hash seed. <a href="classdatasketches_1_1cpc__union__alloc.html#a7d54d46a338588afe9fb768cb0e22082">More...</a><br /></td></tr> |
| <tr class="separator:a7d54d46a338588afe9fb768cb0e22082"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a58b7403d28fc1784030af8671a979a16"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1cpc__union__alloc.html#a58b7403d28fc1784030af8671a979a16">cpc_union_alloc</a> (const <a class="el" href="classdatasketches_1_1cpc__union__alloc.html">cpc_union_alloc</a>< A > &other)</td></tr> |
| <tr class="memdesc:a58b7403d28fc1784030af8671a979a16"><td class="mdescLeft"> </td><td class="mdescRight">Copy constructor. <a href="classdatasketches_1_1cpc__union__alloc.html#a58b7403d28fc1784030af8671a979a16">More...</a><br /></td></tr> |
| <tr class="separator:a58b7403d28fc1784030af8671a979a16"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ace6ac3b163bb5b47c0a90c860e73ee9e"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1cpc__union__alloc.html#ace6ac3b163bb5b47c0a90c860e73ee9e">cpc_union_alloc</a> (<a class="el" href="classdatasketches_1_1cpc__union__alloc.html">cpc_union_alloc</a>< A > &&other) noexcept</td></tr> |
| <tr class="memdesc:ace6ac3b163bb5b47c0a90c860e73ee9e"><td class="mdescLeft"> </td><td class="mdescRight">Move constructor. <a href="classdatasketches_1_1cpc__union__alloc.html#ace6ac3b163bb5b47c0a90c860e73ee9e">More...</a><br /></td></tr> |
| <tr class="separator:ace6ac3b163bb5b47c0a90c860e73ee9e"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ae7b219e0931e711ebea10684e30cb538"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classdatasketches_1_1cpc__union__alloc.html">cpc_union_alloc</a>< A > & </td><td class="memItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1cpc__union__alloc.html#ae7b219e0931e711ebea10684e30cb538">operator=</a> (const <a class="el" href="classdatasketches_1_1cpc__union__alloc.html">cpc_union_alloc</a>< A > &other)</td></tr> |
| <tr class="memdesc:ae7b219e0931e711ebea10684e30cb538"><td class="mdescLeft"> </td><td class="mdescRight">Copy assignment. <a href="classdatasketches_1_1cpc__union__alloc.html#ae7b219e0931e711ebea10684e30cb538">More...</a><br /></td></tr> |
| <tr class="separator:ae7b219e0931e711ebea10684e30cb538"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ae9b7627c7be9e2d8c386225668e3ed9b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classdatasketches_1_1cpc__union__alloc.html">cpc_union_alloc</a>< A > & </td><td class="memItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1cpc__union__alloc.html#ae9b7627c7be9e2d8c386225668e3ed9b">operator=</a> (<a class="el" href="classdatasketches_1_1cpc__union__alloc.html">cpc_union_alloc</a>< A > &&other) noexcept</td></tr> |
| <tr class="memdesc:ae9b7627c7be9e2d8c386225668e3ed9b"><td class="mdescLeft"> </td><td class="mdescRight">Move assignment. <a href="classdatasketches_1_1cpc__union__alloc.html#ae9b7627c7be9e2d8c386225668e3ed9b">More...</a><br /></td></tr> |
| <tr class="separator:ae9b7627c7be9e2d8c386225668e3ed9b"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a3f9778e8f70f04ba8fbb0e1ccacc9fea"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1cpc__union__alloc.html#a3f9778e8f70f04ba8fbb0e1ccacc9fea">update</a> (const <a class="el" href="classdatasketches_1_1cpc__sketch__alloc.html">cpc_sketch_alloc</a>< A > &sketch)</td></tr> |
| <tr class="memdesc:a3f9778e8f70f04ba8fbb0e1ccacc9fea"><td class="mdescLeft"> </td><td class="mdescRight">This method is to update the union with a given sketch (lvalue) <a href="classdatasketches_1_1cpc__union__alloc.html#a3f9778e8f70f04ba8fbb0e1ccacc9fea">More...</a><br /></td></tr> |
| <tr class="separator:a3f9778e8f70f04ba8fbb0e1ccacc9fea"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a7246a5fbecd788c3eb06206506058518"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1cpc__union__alloc.html#a7246a5fbecd788c3eb06206506058518">update</a> (<a class="el" href="classdatasketches_1_1cpc__sketch__alloc.html">cpc_sketch_alloc</a>< A > &&sketch)</td></tr> |
| <tr class="memdesc:a7246a5fbecd788c3eb06206506058518"><td class="mdescLeft"> </td><td class="mdescRight">This method is to update the union with a given sketch (rvalue) <a href="classdatasketches_1_1cpc__union__alloc.html#a7246a5fbecd788c3eb06206506058518">More...</a><br /></td></tr> |
| <tr class="separator:a7246a5fbecd788c3eb06206506058518"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a5ea0b7d39e7f95016af67975b743ec8b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classdatasketches_1_1cpc__sketch__alloc.html">cpc_sketch_alloc</a>< A > </td><td class="memItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1cpc__union__alloc.html#a5ea0b7d39e7f95016af67975b743ec8b">get_result</a> () const</td></tr> |
| <tr class="memdesc:a5ea0b7d39e7f95016af67975b743ec8b"><td class="mdescLeft"> </td><td class="mdescRight">This method produces a copy of the current state of the union as a sketch. <a href="classdatasketches_1_1cpc__union__alloc.html#a5ea0b7d39e7f95016af67975b743ec8b">More...</a><br /></td></tr> |
| <tr class="separator:a5ea0b7d39e7f95016af67975b743ec8b"><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 A><br /> |
| class datasketches::cpc_union_alloc< A ></h3> |
| |
| <p>High performance C++ implementation of Compressed Probabilistic Counting (CPC) Union. </p> |
| <p>author Kevin Lang author Alexander Saydakov </p> |
| </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a id="a7d54d46a338588afe9fb768cb0e22082"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a7d54d46a338588afe9fb768cb0e22082">◆ </a></span>cpc_union_alloc() <span class="overload">[1/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_1cpc__union__alloc.html">cpc_union_alloc</a> </td> |
| <td>(</td> |
| <td class="paramtype">uint8_t </td> |
| <td class="paramname"><em>lg_k</em> = <code><a class="el" href="namespacedatasketches_1_1cpc__constants.html#a78468167a70640384c2de5e04fabe4fd">cpc_constants::DEFAULT_LG_K</a></code>, </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 A & </td> |
| <td class="paramname"><em>allocator</em> = <code>A()</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">explicit</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Creates an instance of the union given the lg_k parameter and hash seed. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">lg_k</td><td>base 2 logarithm of the number of bins in the sketch </td></tr> |
| <tr><td class="paramname">seed</td><td>for hash function </td></tr> |
| <tr><td class="paramname">allocator</td><td>instance of an allocator </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="a58b7403d28fc1784030af8671a979a16"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a58b7403d28fc1784030af8671a979a16">◆ </a></span>cpc_union_alloc() <span class="overload">[2/3]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classdatasketches_1_1cpc__union__alloc.html">cpc_union_alloc</a> </td> |
| <td>(</td> |
| <td class="paramtype">const <a class="el" href="classdatasketches_1_1cpc__union__alloc.html">cpc_union_alloc</a>< A > & </td> |
| <td class="paramname"><em>other</em></td><td>)</td> |
| <td></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>union to be copied </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="ace6ac3b163bb5b47c0a90c860e73ee9e"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ace6ac3b163bb5b47c0a90c860e73ee9e">◆ </a></span>cpc_union_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_1cpc__union__alloc.html">cpc_union_alloc</a> </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="classdatasketches_1_1cpc__union__alloc.html">cpc_union_alloc</a>< A > && </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">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>union to be moved </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a id="ae7b219e0931e711ebea10684e30cb538"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ae7b219e0931e711ebea10684e30cb538">◆ </a></span>operator=() <span class="overload">[1/2]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classdatasketches_1_1cpc__union__alloc.html">cpc_union_alloc</a>< A > & operator= </td> |
| <td>(</td> |
| <td class="paramtype">const <a class="el" href="classdatasketches_1_1cpc__union__alloc.html">cpc_union_alloc</a>< A > & </td> |
| <td class="paramname"><em>other</em></td><td>)</td> |
| <td></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>union to be copied </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>reference to this union </dd></dl> |
| |
| </div> |
| </div> |
| <a id="ae9b7627c7be9e2d8c386225668e3ed9b"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ae9b7627c7be9e2d8c386225668e3ed9b">◆ </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_1cpc__union__alloc.html">cpc_union_alloc</a>< A > & operator= </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="classdatasketches_1_1cpc__union__alloc.html">cpc_union_alloc</a>< A > && </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">noexcept</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>union to be moved </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>reference to this union </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a3f9778e8f70f04ba8fbb0e1ccacc9fea"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a3f9778e8f70f04ba8fbb0e1ccacc9fea">◆ </a></span>update() <span class="overload">[1/2]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void update </td> |
| <td>(</td> |
| <td class="paramtype">const <a class="el" href="classdatasketches_1_1cpc__sketch__alloc.html">cpc_sketch_alloc</a>< A > & </td> |
| <td class="paramname"><em>sketch</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>This method is to update the union with a given sketch (lvalue) </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">sketch</td><td>to update the union with </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="a7246a5fbecd788c3eb06206506058518"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a7246a5fbecd788c3eb06206506058518">◆ </a></span>update() <span class="overload">[2/2]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void update </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="classdatasketches_1_1cpc__sketch__alloc.html">cpc_sketch_alloc</a>< A > && </td> |
| <td class="paramname"><em>sketch</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>This method is to update the union with a given sketch (rvalue) </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">sketch</td><td>to update the union with </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="a5ea0b7d39e7f95016af67975b743ec8b"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a5ea0b7d39e7f95016af67975b743ec8b">◆ </a></span>get_result()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classdatasketches_1_1cpc__sketch__alloc.html">cpc_sketch_alloc</a>< A > get_result</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>This method produces a copy of the current state of the union as a sketch. </p> |
| <dl class="section return"><dt>Returns</dt><dd>the result of the union </dd></dl> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following files:<ul> |
| <li>cpc/include/<a class="el" href="cpc__sketch_8hpp_source.html">cpc_sketch.hpp</a></li> |
| <li>cpc/include/<a class="el" href="cpc__union_8hpp_source.html">cpc_union.hpp</a></li> |
| <li>cpc/include/<a class="el" href="cpc__union__impl_8hpp_source.html">cpc_union_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> |
