docs/5.2.0/classdatasketches_1_1density__sketch.html - datasketches-cpp - Git at Google

 <!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" lang="en-US">
 <head>
 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
 <meta http-equiv="X-UA-Compatible" content="IE=11"/>
 <meta name="generator" content="Doxygen 1.9.8"/>
 <meta name="viewport" content="width=device-width, initial-scale=1"/>
 <title>datasketches-cpp: density_sketch&lt; T, Kernel, Allocator &gt; 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 id="projectrow">
   <td id="projectalign">
    <div id="projectname">datasketches-cpp
    </div>
   </td>
  </tr>
  </tbody>
 </table>
 </div>
 <!-- end header part -->
 <!-- Generated by Doxygen 1.9.8 -->
 <script type="text/javascript">
 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
 var searchBox = new SearchBox("searchBox", "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:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
 $(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">
 <div id="MSearchResults">
 <div class="SRPage">
 <div id="SRIndex">
 <div id="SRResults"></div>
 <div class="SRStatus" id="Loading">Loading...</div>
 <div class="SRStatus" id="Searching">Searching...</div>
 <div class="SRStatus" id="NoMatches">No Matches</div>
 </div>
 </div>
 </div>
 </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_1density__sketch.html">density_sketch</a></li>  </ul>
 </div>
 </div><!-- top -->
 <div class="header">
   <div class="summary">
 <a href="#pub-methods">Public Member Functions</a> &#124;
 <a href="#pub-static-methods">Static Public Member Functions</a> &#124;
 <a href="classdatasketches_1_1density__sketch-members.html">List of all members</a>  </div>
   <div class="headertitle"><div class="title">density_sketch&lt; T, Kernel, Allocator &gt; Class Template Reference</div></div>
 </div><!--header-->
 <div class="contents">

 <p>Density sketch.
  <a href="classdatasketches_1_1density__sketch.html#details">More...</a></p>

 <p><code>#include &lt;<a class="el" href="density__sketch_8hpp_source.html">density_sketch.hpp</a>&gt;</code></p>
 <table class="memberdecls">
 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
 Public Member Functions</h2></td></tr>
 <tr class="memitem:a08daaa6a0d62a61b612a0dbbbd0b22d5" id="r_a08daaa6a0d62a61b612a0dbbbd0b22d5"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1density__sketch.html#a08daaa6a0d62a61b612a0dbbbd0b22d5">density_sketch</a> (uint16_t k, uint32_t dim, const Kernel &amp;kernel=Kernel(), const Allocator &amp;allocator=Allocator())</td></tr>
 <tr class="memdesc:a08daaa6a0d62a61b612a0dbbbd0b22d5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <br /></td></tr>
 <tr class="separator:a08daaa6a0d62a61b612a0dbbbd0b22d5"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a59f4c39b9f2e762e8e3445ef89e1d264" id="r_a59f4c39b9f2e762e8e3445ef89e1d264"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1density__sketch.html#a59f4c39b9f2e762e8e3445ef89e1d264">get_k</a> () const</td></tr>
 <tr class="memdesc:a59f4c39b9f2e762e8e3445ef89e1d264"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns configured parameter K.  <br /></td></tr>
 <tr class="separator:a59f4c39b9f2e762e8e3445ef89e1d264"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a57bff8d89cd2bde903090aa30208f610" id="r_a57bff8d89cd2bde903090aa30208f610"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1density__sketch.html#a57bff8d89cd2bde903090aa30208f610">get_dim</a> () const</td></tr>
 <tr class="memdesc:a57bff8d89cd2bde903090aa30208f610"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns configured dimensions.  <br /></td></tr>
 <tr class="separator:a57bff8d89cd2bde903090aa30208f610"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a5a2b7a58dc85678d08752945ff655362" id="r_a5a2b7a58dc85678d08752945ff655362"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1density__sketch.html#a5a2b7a58dc85678d08752945ff655362">is_empty</a> () const</td></tr>
 <tr class="memdesc:a5a2b7a58dc85678d08752945ff655362"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns true if this sketch is empty.  <br /></td></tr>
 <tr class="separator:a5a2b7a58dc85678d08752945ff655362"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:af857be9469a7565252626f27e1f9d74d" id="r_af857be9469a7565252626f27e1f9d74d"><td class="memItemLeft" align="right" valign="top">uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1density__sketch.html#af857be9469a7565252626f27e1f9d74d">get_n</a> () const</td></tr>
 <tr class="memdesc:af857be9469a7565252626f27e1f9d74d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the length of the input stream (number of points observed by this sketch).  <br /></td></tr>
 <tr class="separator:af857be9469a7565252626f27e1f9d74d"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a31fa76458d81a17dbebfcb828e531f14" id="r_a31fa76458d81a17dbebfcb828e531f14"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1density__sketch.html#a31fa76458d81a17dbebfcb828e531f14">get_num_retained</a> () const</td></tr>
 <tr class="memdesc:a31fa76458d81a17dbebfcb828e531f14"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the number of retained points in the sketch.  <br /></td></tr>
 <tr class="separator:a31fa76458d81a17dbebfcb828e531f14"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:ae95a04b1d7dccb3d9b3f3c3d087aa8e6" id="r_ae95a04b1d7dccb3d9b3f3c3d087aa8e6"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1density__sketch.html#ae95a04b1d7dccb3d9b3f3c3d087aa8e6">is_estimation_mode</a> () const</td></tr>
 <tr class="memdesc:ae95a04b1d7dccb3d9b3f3c3d087aa8e6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns true if this sketch is in estimation mode.  <br /></td></tr>
 <tr class="separator:ae95a04b1d7dccb3d9b3f3c3d087aa8e6"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a5e26f9aae4a59c1345549f9ce512d253" id="r_a5e26f9aae4a59c1345549f9ce512d253"><td class="memTemplParams" colspan="2">template&lt;typename FwdVector &gt; </td></tr>
 <tr class="memitem:a5e26f9aae4a59c1345549f9ce512d253"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1density__sketch.html#a5e26f9aae4a59c1345549f9ce512d253">update</a> (FwdVector &amp;&amp;point)</td></tr>
 <tr class="memdesc:a5e26f9aae4a59c1345549f9ce512d253"><td class="mdescLeft">&#160;</td><td class="mdescRight">Updates this sketch with a given point.  <br /></td></tr>
 <tr class="separator:a5e26f9aae4a59c1345549f9ce512d253"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a1defe87981c9505d416392690b3125c6" id="r_a1defe87981c9505d416392690b3125c6"><td class="memTemplParams" colspan="2">template&lt;typename FwdSketch &gt; </td></tr>
 <tr class="memitem:a1defe87981c9505d416392690b3125c6"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1density__sketch.html#a1defe87981c9505d416392690b3125c6">merge</a> (FwdSketch &amp;&amp;other)</td></tr>
 <tr class="memdesc:a1defe87981c9505d416392690b3125c6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Merges another sketch into this one.  <br /></td></tr>
 <tr class="separator:a1defe87981c9505d416392690b3125c6"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a1ae5f35215393f3272f1b284ec782ef5" id="r_a1ae5f35215393f3272f1b284ec782ef5"><td class="memItemLeft" align="right" valign="top">T&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1density__sketch.html#a1ae5f35215393f3272f1b284ec782ef5">get_estimate</a> (const std::vector&lt; T &gt; &amp;point) const</td></tr>
 <tr class="memdesc:a1ae5f35215393f3272f1b284ec782ef5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Density estimate at a given point.  <br /></td></tr>
 <tr class="separator:a1ae5f35215393f3272f1b284ec782ef5"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a9d85cf47c4ecd0580ec623c42006dd1b" id="r_a9d85cf47c4ecd0580ec623c42006dd1b"><td class="memItemLeft" align="right" valign="top">Allocator&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1density__sketch.html#a9d85cf47c4ecd0580ec623c42006dd1b">get_allocator</a> () const</td></tr>
 <tr class="memdesc:a9d85cf47c4ecd0580ec623c42006dd1b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns an instance of the allocator for this sketch.  <br /></td></tr>
 <tr class="separator:a9d85cf47c4ecd0580ec623c42006dd1b"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a1bcdd98ee6e6eb9b501b8dc5de5e8924" id="r_a1bcdd98ee6e6eb9b501b8dc5de5e8924"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1density__sketch.html#a1bcdd98ee6e6eb9b501b8dc5de5e8924">serialize</a> (std::ostream &amp;os) const</td></tr>
 <tr class="memdesc:a1bcdd98ee6e6eb9b501b8dc5de5e8924"><td class="mdescLeft">&#160;</td><td class="mdescRight">This method serializes the sketch into a given stream in a binary form.  <br /></td></tr>
 <tr class="separator:a1bcdd98ee6e6eb9b501b8dc5de5e8924"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a1c7a57911806d47ee3cebe9fad59f836" id="r_a1c7a57911806d47ee3cebe9fad59f836"><td class="memItemLeft" align="right" valign="top">vector_bytes&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1density__sketch.html#a1c7a57911806d47ee3cebe9fad59f836">serialize</a> (unsigned header_size_bytes=0) const</td></tr>
 <tr class="memdesc:a1c7a57911806d47ee3cebe9fad59f836"><td class="mdescLeft">&#160;</td><td class="mdescRight">This method serializes the sketch as a vector of bytes.  <br /></td></tr>
 <tr class="separator:a1c7a57911806d47ee3cebe9fad59f836"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a592a7af55659ff803b26a45552a68dda" id="r_a592a7af55659ff803b26a45552a68dda"><td class="memItemLeft" align="right" valign="top">string&lt; Allocator &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1density__sketch.html#a592a7af55659ff803b26a45552a68dda">to_string</a> (bool print_levels=false, bool print_items=false) const</td></tr>
 <tr class="memdesc:a592a7af55659ff803b26a45552a68dda"><td class="mdescLeft">&#160;</td><td class="mdescRight">Prints a summary of the sketch.  <br /></td></tr>
 <tr class="separator:a592a7af55659ff803b26a45552a68dda"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:ad5c959a538216a09ab28c5283585956c" id="r_ad5c959a538216a09ab28c5283585956c"><td class="memItemLeft" align="right" valign="top">const_iterator&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1density__sketch.html#ad5c959a538216a09ab28c5283585956c">begin</a> () const</td></tr>
 <tr class="memdesc:ad5c959a538216a09ab28c5283585956c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Iterator pointing to the first item in the sketch.  <br /></td></tr>
 <tr class="separator:ad5c959a538216a09ab28c5283585956c"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:ae11e60e117300685401961e36f196f7a" id="r_ae11e60e117300685401961e36f196f7a"><td class="memItemLeft" align="right" valign="top">const_iterator&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1density__sketch.html#ae11e60e117300685401961e36f196f7a">end</a> () const</td></tr>
 <tr class="memdesc:ae11e60e117300685401961e36f196f7a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Iterator pointing to the past-the-end item in the sketch.  <br /></td></tr>
 <tr class="separator:ae11e60e117300685401961e36f196f7a"><td class="memSeparator" colspan="2">&#160;</td></tr>
 </table><table class="memberdecls">
 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-methods" name="pub-static-methods"></a>
 Static Public Member Functions</h2></td></tr>
 <tr class="memitem:ae1111c0a71921687c58dd661a3c341e2" id="r_ae1111c0a71921687c58dd661a3c341e2"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classdatasketches_1_1density__sketch.html">density_sketch</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1density__sketch.html#ae1111c0a71921687c58dd661a3c341e2">deserialize</a> (std::istream &amp;is, const Kernel &amp;kernel=Kernel(), const Allocator &amp;allocator=Allocator())</td></tr>
 <tr class="memdesc:ae1111c0a71921687c58dd661a3c341e2"><td class="mdescLeft">&#160;</td><td class="mdescRight">This method deserializes a sketch from a given stream.  <br /></td></tr>
 <tr class="separator:ae1111c0a71921687c58dd661a3c341e2"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a1efc2f9373fce7d3ea1b8654b3d862a7" id="r_a1efc2f9373fce7d3ea1b8654b3d862a7"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classdatasketches_1_1density__sketch.html">density_sketch</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdatasketches_1_1density__sketch.html#a1efc2f9373fce7d3ea1b8654b3d862a7">deserialize</a> (const void *bytes, size_t size, const Kernel &amp;kernel=Kernel(), const Allocator &amp;allocator=Allocator())</td></tr>
 <tr class="memdesc:a1efc2f9373fce7d3ea1b8654b3d862a7"><td class="mdescLeft">&#160;</td><td class="mdescRight">This method deserializes a sketch from a given array of bytes.  <br /></td></tr>
 <tr class="separator:a1efc2f9373fce7d3ea1b8654b3d862a7"><td class="memSeparator" colspan="2">&#160;</td></tr>
 </table>
 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 <div class="textblock"><div class="compoundTemplParams">template&lt;typename T, typename Kernel = gaussian_kernel&lt;T&gt;, typename Allocator = std::allocator&lt;T&gt;&gt;<br />
 class datasketches::density_sketch&lt; T, Kernel, Allocator &gt;</div><p>Density sketch. </p>
 <p>Builds a coreset from the given set of input points. Provides density estimate at a given point.</p>
 <p>Based on the following paper: Zohar Karnin, Edo Liberty "Discrepancy, Coresets, and Sketches in Machine Learning" <a href="https://proceedings.mlr.press/v99/karnin19a/karnin19a.pdf">https://proceedings.mlr.press/v99/karnin19a/karnin19a.pdf</a></p>
 <p>Inspired by the following implementation: <a href="https://github.com/edoliberty/streaming-quantiles/blob/f688c8161a25582457b0a09deb4630a81406293b/gde.py">https://github.com/edoliberty/streaming-quantiles/blob/f688c8161a25582457b0a09deb4630a81406293b/gde.py</a> </p>
 </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
 <a id="a08daaa6a0d62a61b612a0dbbbd0b22d5" name="a08daaa6a0d62a61b612a0dbbbd0b22d5"></a>
 <h2 class="memtitle"><span class="permalink"><a href="#a08daaa6a0d62a61b612a0dbbbd0b22d5">&#9670;&#160;</a></span>density_sketch()</h2>

 <div class="memitem">
 <div class="memproto">
 <div class="memtemplate">
 template&lt;typename T , typename Kernel  = gaussian_kernel&lt;T&gt;, typename Allocator  = std::allocator&lt;T&gt;&gt; </div>
       <table class="memname">
         <tr>
           <td class="memname"><a class="el" href="classdatasketches_1_1density__sketch.html">density_sketch</a> </td>
           <td>(</td>
           <td class="paramtype">uint16_t&#160;</td>
           <td class="paramname"><em>k</em>, </td>
         </tr>
         <tr>
           <td class="paramkey"></td>
           <td></td>
           <td class="paramtype">uint32_t&#160;</td>
           <td class="paramname"><em>dim</em>, </td>
         </tr>
         <tr>
           <td class="paramkey"></td>
           <td></td>
           <td class="paramtype">const Kernel &amp;&#160;</td>
           <td class="paramname"><em>kernel</em> = <code>Kernel()</code>, </td>
         </tr>
         <tr>
           <td class="paramkey"></td>
           <td></td>
           <td class="paramtype">const Allocator &amp;&#160;</td>
           <td class="paramname"><em>allocator</em> = <code>Allocator()</code>&#160;</td>
         </tr>
         <tr>
           <td></td>
           <td>)</td>
           <td></td><td></td>
         </tr>
       </table>
 </div><div class="memdoc">

 <p>Constructor. </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
     <tr><td class="paramname">k</td><td>controls the size and error of the sketch. </td></tr>
     <tr><td class="paramname">dim</td><td>dimension of the input domain </td></tr>
     <tr><td class="paramname">kernel</td><td>to use by this instance </td></tr>
     <tr><td class="paramname">allocator</td><td>to use by this instance </td></tr>
   </table>
   </dd>
 </dl>

 </div>
 </div>
 <h2 class="groupheader">Member Function Documentation</h2>
 <a id="a59f4c39b9f2e762e8e3445ef89e1d264" name="a59f4c39b9f2e762e8e3445ef89e1d264"></a>
 <h2 class="memtitle"><span class="permalink"><a href="#a59f4c39b9f2e762e8e3445ef89e1d264">&#9670;&#160;</a></span>get_k()</h2>

 <div class="memitem">
 <div class="memproto">
 <div class="memtemplate">
 template&lt;typename T , typename K , typename A &gt; </div>
       <table class="memname">
         <tr>
           <td class="memname">uint16_t get_k </td>
           <td>(</td>
           <td class="paramname"></td><td>)</td>
           <td> const</td>
         </tr>
       </table>
 </div><div class="memdoc">

 <p>Returns configured parameter K. </p>
 <dl class="section return"><dt>Returns</dt><dd>parameter K </dd></dl>

 </div>
 </div>
 <a id="a57bff8d89cd2bde903090aa30208f610" name="a57bff8d89cd2bde903090aa30208f610"></a>
 <h2 class="memtitle"><span class="permalink"><a href="#a57bff8d89cd2bde903090aa30208f610">&#9670;&#160;</a></span>get_dim()</h2>

 <div class="memitem">
 <div class="memproto">
 <div class="memtemplate">
 template&lt;typename T , typename K , typename A &gt; </div>
       <table class="memname">
         <tr>
           <td class="memname">uint32_t get_dim </td>
           <td>(</td>
           <td class="paramname"></td><td>)</td>
           <td> const</td>
         </tr>
       </table>
 </div><div class="memdoc">

 <p>Returns configured dimensions. </p>
 <dl class="section return"><dt>Returns</dt><dd>dimensions </dd></dl>

 </div>
 </div>
 <a id="a5a2b7a58dc85678d08752945ff655362" name="a5a2b7a58dc85678d08752945ff655362"></a>
 <h2 class="memtitle"><span class="permalink"><a href="#a5a2b7a58dc85678d08752945ff655362">&#9670;&#160;</a></span>is_empty()</h2>

 <div class="memitem">
 <div class="memproto">
 <div class="memtemplate">
 template&lt;typename T , typename K , typename A &gt; </div>
       <table class="memname">
         <tr>
           <td class="memname">bool is_empty </td>
           <td>(</td>
           <td class="paramname"></td><td>)</td>
           <td> const</td>
         </tr>
       </table>
 </div><div class="memdoc">

 <p>Returns true if this sketch is empty. </p>
 <dl class="section return"><dt>Returns</dt><dd>empty flag </dd></dl>

 </div>
 </div>
 <a id="af857be9469a7565252626f27e1f9d74d" name="af857be9469a7565252626f27e1f9d74d"></a>
 <h2 class="memtitle"><span class="permalink"><a href="#af857be9469a7565252626f27e1f9d74d">&#9670;&#160;</a></span>get_n()</h2>

 <div class="memitem">
 <div class="memproto">
 <div class="memtemplate">
 template&lt;typename T , typename K , typename A &gt; </div>
       <table class="memname">
         <tr>
           <td class="memname">uint64_t get_n </td>
           <td>(</td>
           <td class="paramname"></td><td>)</td>
           <td> const</td>
         </tr>
       </table>
 </div><div class="memdoc">

 <p>Returns the length of the input stream (number of points observed by this sketch). </p>
 <dl class="section return"><dt>Returns</dt><dd>stream length </dd></dl>

 </div>
 </div>
 <a id="a31fa76458d81a17dbebfcb828e531f14" name="a31fa76458d81a17dbebfcb828e531f14"></a>
 <h2 class="memtitle"><span class="permalink"><a href="#a31fa76458d81a17dbebfcb828e531f14">&#9670;&#160;</a></span>get_num_retained()</h2>

 <div class="memitem">
 <div class="memproto">
 <div class="memtemplate">
 template&lt;typename T , typename K , typename A &gt; </div>
       <table class="memname">
         <tr>
           <td class="memname">uint32_t get_num_retained </td>
           <td>(</td>
           <td class="paramname"></td><td>)</td>
           <td> const</td>
         </tr>
       </table>
 </div><div class="memdoc">

 <p>Returns the number of retained points in the sketch. </p>
 <dl class="section return"><dt>Returns</dt><dd>number of retained points </dd></dl>

 </div>
 </div>
 <a id="ae95a04b1d7dccb3d9b3f3c3d087aa8e6" name="ae95a04b1d7dccb3d9b3f3c3d087aa8e6"></a>
 <h2 class="memtitle"><span class="permalink"><a href="#ae95a04b1d7dccb3d9b3f3c3d087aa8e6">&#9670;&#160;</a></span>is_estimation_mode()</h2>

 <div class="memitem">
 <div class="memproto">
 <div class="memtemplate">
 template&lt;typename T , typename K , typename A &gt; </div>
       <table class="memname">
         <tr>
           <td class="memname">bool is_estimation_mode </td>
           <td>(</td>
           <td class="paramname"></td><td>)</td>
           <td> const</td>
         </tr>
       </table>
 </div><div class="memdoc">

 <p>Returns true if this sketch is in estimation mode. </p>
 <dl class="section return"><dt>Returns</dt><dd>estimation mode flag </dd></dl>

 </div>
 </div>
 <a id="a5e26f9aae4a59c1345549f9ce512d253" name="a5e26f9aae4a59c1345549f9ce512d253"></a>
 <h2 class="memtitle"><span class="permalink"><a href="#a5e26f9aae4a59c1345549f9ce512d253">&#9670;&#160;</a></span>update()</h2>

 <div class="memitem">
 <div class="memproto">
 <div class="memtemplate">
 template&lt;typename T , typename K , typename A &gt; </div>
 <div class="memtemplate">
 template&lt;typename FwdVector &gt; </div>
       <table class="memname">
         <tr>
           <td class="memname">void update </td>
           <td>(</td>
           <td class="paramtype">FwdVector &amp;&amp;&#160;</td>
           <td class="paramname"><em>point</em></td><td>)</td>
           <td></td>
         </tr>
       </table>
 </div><div class="memdoc">

 <p>Updates this sketch with a given point. </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
     <tr><td class="paramname">point</td><td>given point </td></tr>
   </table>
   </dd>
 </dl>

 </div>
 </div>
 <a id="a1defe87981c9505d416392690b3125c6" name="a1defe87981c9505d416392690b3125c6"></a>
 <h2 class="memtitle"><span class="permalink"><a href="#a1defe87981c9505d416392690b3125c6">&#9670;&#160;</a></span>merge()</h2>

 <div class="memitem">
 <div class="memproto">
 <div class="memtemplate">
 template&lt;typename T , typename K , typename A &gt; </div>
 <div class="memtemplate">
 template&lt;typename FwdSketch &gt; </div>
       <table class="memname">
         <tr>
           <td class="memname">void merge </td>
           <td>(</td>
           <td class="paramtype">FwdSketch &amp;&amp;&#160;</td>
           <td class="paramname"><em>other</em></td><td>)</td>
           <td></td>
         </tr>
       </table>
 </div><div class="memdoc">

 <p>Merges another sketch into this one. </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
     <tr><td class="paramname">other</td><td>sketch to merge into this one </td></tr>
   </table>
   </dd>
 </dl>

 </div>
 </div>
 <a id="a1ae5f35215393f3272f1b284ec782ef5" name="a1ae5f35215393f3272f1b284ec782ef5"></a>
 <h2 class="memtitle"><span class="permalink"><a href="#a1ae5f35215393f3272f1b284ec782ef5">&#9670;&#160;</a></span>get_estimate()</h2>

 <div class="memitem">
 <div class="memproto">
 <div class="memtemplate">
 template&lt;typename T , typename K , typename A &gt; </div>
       <table class="memname">
         <tr>
           <td class="memname">T get_estimate </td>
           <td>(</td>
           <td class="paramtype">const std::vector&lt; T &gt; &amp;&#160;</td>
           <td class="paramname"><em>point</em></td><td>)</td>
           <td> const</td>
         </tr>
       </table>
 </div><div class="memdoc">

 <p>Density estimate at a given point. </p>
 <dl class="section return"><dt>Returns</dt><dd>density estimate at a given point </dd></dl>

 </div>
 </div>
 <a id="a9d85cf47c4ecd0580ec623c42006dd1b" name="a9d85cf47c4ecd0580ec623c42006dd1b"></a>
 <h2 class="memtitle"><span class="permalink"><a href="#a9d85cf47c4ecd0580ec623c42006dd1b">&#9670;&#160;</a></span>get_allocator()</h2>

 <div class="memitem">
 <div class="memproto">
 <div class="memtemplate">
 template&lt;typename T , typename K , typename A &gt; </div>
       <table class="memname">
         <tr>
           <td class="memname">A get_allocator </td>
           <td>(</td>
           <td class="paramname"></td><td>)</td>
           <td> const</td>
         </tr>
       </table>
 </div><div class="memdoc">

 <p>Returns an instance of the allocator for this sketch. </p>
 <dl class="section return"><dt>Returns</dt><dd>allocator </dd></dl>

 </div>
 </div>
 <a id="a1bcdd98ee6e6eb9b501b8dc5de5e8924" name="a1bcdd98ee6e6eb9b501b8dc5de5e8924"></a>
 <h2 class="memtitle"><span class="permalink"><a href="#a1bcdd98ee6e6eb9b501b8dc5de5e8924">&#9670;&#160;</a></span>serialize() <span class="overload">[1/2]</span></h2>

 <div class="memitem">
 <div class="memproto">
 <div class="memtemplate">
 template&lt;typename T , typename K , typename A &gt; </div>
       <table class="memname">
         <tr>
           <td class="memname">void serialize </td>
           <td>(</td>
           <td class="paramtype">std::ostream &amp;&#160;</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" name="a1c7a57911806d47ee3cebe9fad59f836"></a>
 <h2 class="memtitle"><span class="permalink"><a href="#a1c7a57911806d47ee3cebe9fad59f836">&#9670;&#160;</a></span>serialize() <span class="overload">[2/2]</span></h2>

 <div class="memitem">
 <div class="memproto">
 <div class="memtemplate">
 template&lt;typename T , typename K , typename A &gt; </div>
       <table class="memname">
         <tr>
           <td class="memname">auto serialize </td>
           <td>(</td>
           <td class="paramtype">unsigned&#160;</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="ae1111c0a71921687c58dd661a3c341e2" name="ae1111c0a71921687c58dd661a3c341e2"></a>
 <h2 class="memtitle"><span class="permalink"><a href="#ae1111c0a71921687c58dd661a3c341e2">&#9670;&#160;</a></span>deserialize() <span class="overload">[1/2]</span></h2>

 <div class="memitem">
 <div class="memproto">
 <div class="memtemplate">
 template&lt;typename T , typename Kernel  = gaussian_kernel&lt;T&gt;, typename Allocator  = std::allocator&lt;T&gt;&gt; </div>
 <table class="mlabels">
   <tr>
   <td class="mlabels-left">
       <table class="memname">
         <tr>
           <td class="memname">static <a class="el" href="classdatasketches_1_1density__sketch.html">density_sketch</a> deserialize </td>
           <td>(</td>
           <td class="paramtype">std::istream &amp;&#160;</td>
           <td class="paramname"><em>is</em>, </td>
         </tr>
         <tr>
           <td class="paramkey"></td>
           <td></td>
           <td class="paramtype">const Kernel &amp;&#160;</td>
           <td class="paramname"><em>kernel</em> = <code>Kernel()</code>, </td>
         </tr>
         <tr>
           <td class="paramkey"></td>
           <td></td>
           <td class="paramtype">const Allocator &amp;&#160;</td>
           <td class="paramname"><em>allocator</em> = <code>Allocator()</code>&#160;</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">kernel</td><td>the kernel function to use for this sketch </td></tr>
     <tr><td class="paramname">allocator</td><td>the memory allocator to use with this sketch </td></tr>
   </table>
   </dd>
 </dl>
 <dl class="section return"><dt>Returns</dt><dd>an instance of the sketch </dd></dl>

 </div>
 </div>
 <a id="a1efc2f9373fce7d3ea1b8654b3d862a7" name="a1efc2f9373fce7d3ea1b8654b3d862a7"></a>
 <h2 class="memtitle"><span class="permalink"><a href="#a1efc2f9373fce7d3ea1b8654b3d862a7">&#9670;&#160;</a></span>deserialize() <span class="overload">[2/2]</span></h2>

 <div class="memitem">
 <div class="memproto">
 <div class="memtemplate">
 template&lt;typename T , typename Kernel  = gaussian_kernel&lt;T&gt;, typename Allocator  = std::allocator&lt;T&gt;&gt; </div>
 <table class="mlabels">
   <tr>
   <td class="mlabels-left">
       <table class="memname">
         <tr>
           <td class="memname">static <a class="el" href="classdatasketches_1_1density__sketch.html">density_sketch</a> deserialize </td>
           <td>(</td>
           <td class="paramtype">const void *&#160;</td>
           <td class="paramname"><em>bytes</em>, </td>
         </tr>
         <tr>
           <td class="paramkey"></td>
           <td></td>
           <td class="paramtype">size_t&#160;</td>
           <td class="paramname"><em>size</em>, </td>
         </tr>
         <tr>
           <td class="paramkey"></td>
           <td></td>
           <td class="paramtype">const Kernel &amp;&#160;</td>
           <td class="paramname"><em>kernel</em> = <code>Kernel()</code>, </td>
         </tr>
         <tr>
           <td class="paramkey"></td>
           <td></td>
           <td class="paramtype">const Allocator &amp;&#160;</td>
           <td class="paramname"><em>allocator</em> = <code>Allocator()</code>&#160;</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">kernel</td><td>the kernel function to use for this sketch </td></tr>
     <tr><td class="paramname">allocator</td><td>the memory allocator to use with this sketch </td></tr>
   </table>
   </dd>
 </dl>
 <dl class="section return"><dt>Returns</dt><dd>an instance of the sketch </dd></dl>

 </div>
 </div>
 <a id="a592a7af55659ff803b26a45552a68dda" name="a592a7af55659ff803b26a45552a68dda"></a>
 <h2 class="memtitle"><span class="permalink"><a href="#a592a7af55659ff803b26a45552a68dda">&#9670;&#160;</a></span>to_string()</h2>

 <div class="memitem">
 <div class="memproto">
 <div class="memtemplate">
 template&lt;typename T , typename K , typename A &gt; </div>
       <table class="memname">
         <tr>
           <td class="memname">string&lt; A &gt; to_string </td>
           <td>(</td>
           <td class="paramtype">bool&#160;</td>
           <td class="paramname"><em>print_levels</em> = <code>false</code>, </td>
         </tr>
         <tr>
           <td class="paramkey"></td>
           <td></td>
           <td class="paramtype">bool&#160;</td>
           <td class="paramname"><em>print_items</em> = <code>false</code>&#160;</td>
         </tr>
         <tr>
           <td></td>
           <td>)</td>
           <td></td><td> const</td>
         </tr>
       </table>
 </div><div class="memdoc">

 <p>Prints a summary of the sketch. </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
     <tr><td class="paramname">print_levels</td><td>if true include information about levels </td></tr>
     <tr><td class="paramname">print_items</td><td>if true include sketch data </td></tr>
   </table>
   </dd>
 </dl>

 </div>
 </div>
 <a id="ad5c959a538216a09ab28c5283585956c" name="ad5c959a538216a09ab28c5283585956c"></a>
 <h2 class="memtitle"><span class="permalink"><a href="#ad5c959a538216a09ab28c5283585956c">&#9670;&#160;</a></span>begin()</h2>

 <div class="memitem">
 <div class="memproto">
 <div class="memtemplate">
 template&lt;typename T , typename K , typename A &gt; </div>
       <table class="memname">
         <tr>
           <td class="memname">auto begin </td>
           <td>(</td>
           <td class="paramname"></td><td>)</td>
           <td> const</td>
         </tr>
       </table>
 </div><div class="memdoc">

 <p>Iterator pointing to the first item in the sketch. </p>
 <p>If the sketch is empty, the returned iterator must not be dereferenced or incremented. </p><dl class="section return"><dt>Returns</dt><dd>iterator pointing to the first item in the sketch </dd></dl>

 </div>
 </div>
 <a id="ae11e60e117300685401961e36f196f7a" name="ae11e60e117300685401961e36f196f7a"></a>
 <h2 class="memtitle"><span class="permalink"><a href="#ae11e60e117300685401961e36f196f7a">&#9670;&#160;</a></span>end()</h2>

 <div class="memitem">
 <div class="memproto">
 <div class="memtemplate">
 template&lt;typename T , typename K , typename A &gt; </div>
       <table class="memname">
         <tr>
           <td class="memname">auto end </td>
           <td>(</td>
           <td class="paramname"></td><td>)</td>
           <td> const</td>
         </tr>
       </table>
 </div><div class="memdoc">

 <p>Iterator pointing to the past-the-end item in the sketch. </p>
 <p>The past-the-end item is the hypothetical item that would follow the last item. It does not point to any item, and must not be dereferenced or incremented. </p><dl class="section return"><dt>Returns</dt><dd>iterator pointing to the past-the-end item in the sketch </dd></dl>

 </div>
 </div>
 <hr/>The documentation for this class was generated from the following files:<ul>
 <li>density/include/<a class="el" href="density__sketch_8hpp_source.html">density_sketch.hpp</a></li>
 <li>density/include/<a class="el" href="density__sketch__impl_8hpp_source.html">density_sketch_impl.hpp</a></li>
 </ul>
 </div><!-- contents -->
 <!-- start footer part -->
 <hr class="footer"/><address class="footer"><small>
 Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
 </small></address>
 </body>
 </html>