docs/build/html/hyper_log_log.html - datasketches-python - Git at Google

 <!DOCTYPE html>
 <html class="writer-html5" lang="en" >
 <head>
   <meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />

   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
   <title>HyperLogLog (HLL) &mdash; datasketches 0.1 documentation</title>
       <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
   <!--[if lt IE 9]>
     <script src="_static/js/html5shiv.min.js"></script>
   <![endif]-->

         <script src="_static/jquery.js?v=5d32c60e"></script>
         <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
         <script src="_static/documentation_options.js?v=2709fde1"></script>
         <script src="_static/doctools.js?v=888ff710"></script>
         <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/js/theme.js"></script>
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
     <link rel="next" title="Compressed Probabilistic Counting (CPC)" href="cpc.html" />
     <link rel="prev" title="Apache DataSketches" href="index.html" />
 </head>

 <body class="wy-body-for-nav">
   <div class="wy-grid-for-nav">
     <nav data-toggle="wy-nav-shift" class="wy-nav-side">
       <div class="wy-side-scroll">
         <div class="wy-side-nav-search" >


           <a href="index.html" class="icon icon-home">
             datasketches
           </a>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
     <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
     <input type="hidden" name="check_keywords" value="yes" />
     <input type="hidden" name="area" value="default" />
   </form>
 </div>
         </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
               <ul class="current">
 <li class="toctree-l1 current"><a class="current reference internal" href="#">HyperLogLog (HLL)</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="#datasketches.hll_sketch"><code class="docutils literal notranslate"><span class="pre">hll_sketch</span></code></a><ul>
 <li class="toctree-l3"><a class="reference internal" href="#datasketches.hll_sketch.deserialize"><code class="docutils literal notranslate"><span class="pre">hll_sketch.deserialize()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="#datasketches.hll_sketch.get_compact_serialization_bytes"><code class="docutils literal notranslate"><span class="pre">hll_sketch.get_compact_serialization_bytes()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="#datasketches.hll_sketch.get_estimate"><code class="docutils literal notranslate"><span class="pre">hll_sketch.get_estimate()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="#datasketches.hll_sketch.get_lower_bound"><code class="docutils literal notranslate"><span class="pre">hll_sketch.get_lower_bound()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="#datasketches.hll_sketch.get_max_updatable_serialization_bytes"><code class="docutils literal notranslate"><span class="pre">hll_sketch.get_max_updatable_serialization_bytes()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="#datasketches.hll_sketch.get_rel_err"><code class="docutils literal notranslate"><span class="pre">hll_sketch.get_rel_err()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="#datasketches.hll_sketch.get_updatable_serialization_bytes"><code class="docutils literal notranslate"><span class="pre">hll_sketch.get_updatable_serialization_bytes()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="#datasketches.hll_sketch.get_upper_bound"><code class="docutils literal notranslate"><span class="pre">hll_sketch.get_upper_bound()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="#datasketches.hll_sketch.is_compact"><code class="docutils literal notranslate"><span class="pre">hll_sketch.is_compact()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="#datasketches.hll_sketch.is_empty"><code class="docutils literal notranslate"><span class="pre">hll_sketch.is_empty()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="#datasketches.hll_sketch.lg_config_k"><code class="docutils literal notranslate"><span class="pre">hll_sketch.lg_config_k</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="#datasketches.hll_sketch.reset"><code class="docutils literal notranslate"><span class="pre">hll_sketch.reset()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="#datasketches.hll_sketch.serialize_compact"><code class="docutils literal notranslate"><span class="pre">hll_sketch.serialize_compact()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="#datasketches.hll_sketch.serialize_updatable"><code class="docutils literal notranslate"><span class="pre">hll_sketch.serialize_updatable()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="#datasketches.hll_sketch.tgt_type"><code class="docutils literal notranslate"><span class="pre">hll_sketch.tgt_type</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="#datasketches.hll_sketch.to_string"><code class="docutils literal notranslate"><span class="pre">hll_sketch.to_string()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="#datasketches.hll_sketch.update"><code class="docutils literal notranslate"><span class="pre">hll_sketch.update()</span></code></a></li>
 </ul>
 </li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="cpc.html">Compressed Probabilistic Counting (CPC)</a></li>
 <li class="toctree-l1"><a class="reference internal" href="theta.html">Theta Sketch</a></li>
 </ul>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="count_min_sketch.html">CountMin Sketch</a></li>
 </ul>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="frequent_items.html">Frequent Items</a></li>
 </ul>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="kll.html">KLL Sketch</a></li>
 <li class="toctree-l1"><a class="reference internal" href="req.html">Relative Error Quantiles (REQ) Sketch</a></li>
 </ul>

         </div>
       </div>
     </nav>

     <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
           <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
           <a href="index.html">datasketches</a>
       </nav>

       <div class="wy-nav-content">
         <div class="rst-content">
           <div role="navigation" aria-label="Page navigation">
   <ul class="wy-breadcrumbs">
       <li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
       <li class="breadcrumb-item active">HyperLogLog (HLL)</li>
       <li class="wy-breadcrumbs-aside">
             <a href="_sources/hyper_log_log.rst.txt" rel="nofollow"> View page source</a>
       </li>
   </ul>
   <hr/>
 </div>
           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
            <div itemprop="articleBody">

   <section id="hyperloglog-hll">
 <h1>HyperLogLog (HLL)<a class="headerlink" href="#hyperloglog-hll" title="Link to this heading"></a></h1>
 <p>The HyperLogLog (HLL) sketch is a space-efficient method for estimating cardinalities of sets.</p>
 <dl class="py class">
 <dt class="sig sig-object py" id="datasketches.hll_sketch">
 <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">_datasketches.</span></span><span class="sig-name descname"><span class="pre">hll_sketch</span></span><a class="headerlink" href="#datasketches.hll_sketch" title="Link to this definition"></a></dt>
 <dd><dl class="py method">
 <dt class="sig sig-object py" id="datasketches.hll_sketch.deserialize">
 <em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">deserialize</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">bytes</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#datasketches.hll_sketch" title="_datasketches.hll_sketch"><span class="pre">_datasketches.hll_sketch</span></a></span></span><a class="headerlink" href="#datasketches.hll_sketch.deserialize" title="Link to this definition"></a></dt>
 <dd><p>Reads a bytes object and returns the corresponding hll_sketch</p>
 </dd></dl>

 <dl class="py method">
 <dt class="sig sig-object py" id="datasketches.hll_sketch.get_compact_serialization_bytes">
 <span class="sig-name descname"><span class="pre">get_compact_serialization_bytes</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#datasketches.hll_sketch" title="_datasketches.hll_sketch"><span class="pre">_datasketches.hll_sketch</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">int</span></span></span><a class="headerlink" href="#datasketches.hll_sketch.get_compact_serialization_bytes" title="Link to this definition"></a></dt>
 <dd><p>Returns the size of the serialized sketch when compressing the exception table if HLL_4</p>
 </dd></dl>

 <dl class="py method">
 <dt class="sig sig-object py" id="datasketches.hll_sketch.get_estimate">
 <span class="sig-name descname"><span class="pre">get_estimate</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#datasketches.hll_sketch" title="_datasketches.hll_sketch"><span class="pre">_datasketches.hll_sketch</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">float</span></span></span><a class="headerlink" href="#datasketches.hll_sketch.get_estimate" title="Link to this definition"></a></dt>
 <dd><p>Estimate of the distinct count of the input stream</p>
 </dd></dl>

 <dl class="py method">
 <dt class="sig sig-object py" id="datasketches.hll_sketch.get_lower_bound">
 <span class="sig-name descname"><span class="pre">get_lower_bound</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#datasketches.hll_sketch" title="_datasketches.hll_sketch"><span class="pre">_datasketches.hll_sketch</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">num_std_devs</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">float</span></span></span><a class="headerlink" href="#datasketches.hll_sketch.get_lower_bound" title="Link to this definition"></a></dt>
 <dd><p>Returns the approximate lower error bound given the specified number of standard deviations in {1, 2, 3}</p>
 </dd></dl>

 <dl class="py method">
 <dt class="sig sig-object py" id="datasketches.hll_sketch.get_max_updatable_serialization_bytes">
 <em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_max_updatable_serialization_bytes</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">lg_k</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tgt_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">_datasketches.tgt_hll_type</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">int</span></span></span><a class="headerlink" href="#datasketches.hll_sketch.get_max_updatable_serialization_bytes" title="Link to this definition"></a></dt>
 <dd><p>Provides a likely upper bound on serialization size for the given parameters</p>
 </dd></dl>

 <dl class="py method">
 <dt class="sig sig-object py" id="datasketches.hll_sketch.get_rel_err">
 <em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_rel_err</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">upper_bound</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">unioned</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lg_k</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">num_std_devs</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">float</span></span></span><a class="headerlink" href="#datasketches.hll_sketch.get_rel_err" title="Link to this definition"></a></dt>
 <dd><p>Returns the a priori relative error bound for the given parameters</p>
 </dd></dl>

 <dl class="py method">
 <dt class="sig sig-object py" id="datasketches.hll_sketch.get_updatable_serialization_bytes">
 <span class="sig-name descname"><span class="pre">get_updatable_serialization_bytes</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#datasketches.hll_sketch" title="_datasketches.hll_sketch"><span class="pre">_datasketches.hll_sketch</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">int</span></span></span><a class="headerlink" href="#datasketches.hll_sketch.get_updatable_serialization_bytes" title="Link to this definition"></a></dt>
 <dd><p>Returns the size of the serialized sketch</p>
 </dd></dl>

 <dl class="py method">
 <dt class="sig sig-object py" id="datasketches.hll_sketch.get_upper_bound">
 <span class="sig-name descname"><span class="pre">get_upper_bound</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#datasketches.hll_sketch" title="_datasketches.hll_sketch"><span class="pre">_datasketches.hll_sketch</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">num_std_devs</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">float</span></span></span><a class="headerlink" href="#datasketches.hll_sketch.get_upper_bound" title="Link to this definition"></a></dt>
 <dd><p>Returns the approximate upper error bound given the specified number of standard deviations in {1, 2, 3}</p>
 </dd></dl>

 <dl class="py method">
 <dt class="sig sig-object py" id="datasketches.hll_sketch.is_compact">
 <span class="sig-name descname"><span class="pre">is_compact</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#datasketches.hll_sketch" title="_datasketches.hll_sketch"><span class="pre">_datasketches.hll_sketch</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#datasketches.hll_sketch.is_compact" title="Link to this definition"></a></dt>
 <dd><p>True if the sketch is compact, otherwise False</p>
 </dd></dl>

 <dl class="py method">
 <dt class="sig sig-object py" id="datasketches.hll_sketch.is_empty">
 <span class="sig-name descname"><span class="pre">is_empty</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#datasketches.hll_sketch" title="_datasketches.hll_sketch"><span class="pre">_datasketches.hll_sketch</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#datasketches.hll_sketch.is_empty" title="Link to this definition"></a></dt>
 <dd><p>True if the sketch is empty, otherwise False</p>
 </dd></dl>

 <dl class="py property">
 <dt class="sig sig-object py" id="datasketches.hll_sketch.lg_config_k">
 <em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">lg_config_k</span></span><a class="headerlink" href="#datasketches.hll_sketch.lg_config_k" title="Link to this definition"></a></dt>
 <dd><p>Configured lg_k value for the sketch</p>
 </dd></dl>

 <dl class="py method">
 <dt class="sig sig-object py" id="datasketches.hll_sketch.reset">
 <span class="sig-name descname"><span class="pre">reset</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#datasketches.hll_sketch" title="_datasketches.hll_sketch"><span class="pre">_datasketches.hll_sketch</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#datasketches.hll_sketch.reset" title="Link to this definition"></a></dt>
 <dd><p>Resets the sketch to the empty state in coupon collection mode</p>
 </dd></dl>

 <dl class="py method">
 <dt class="sig sig-object py" id="datasketches.hll_sketch.serialize_compact">
 <span class="sig-name descname"><span class="pre">serialize_compact</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#datasketches.hll_sketch" title="_datasketches.hll_sketch"><span class="pre">_datasketches.hll_sketch</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">bytes</span></span></span><a class="headerlink" href="#datasketches.hll_sketch.serialize_compact" title="Link to this definition"></a></dt>
 <dd><p>Serializes the sketch into a bytes object, compressing the exception table if HLL_4</p>
 </dd></dl>

 <dl class="py method">
 <dt class="sig sig-object py" id="datasketches.hll_sketch.serialize_updatable">
 <span class="sig-name descname"><span class="pre">serialize_updatable</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#datasketches.hll_sketch" title="_datasketches.hll_sketch"><span class="pre">_datasketches.hll_sketch</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">bytes</span></span></span><a class="headerlink" href="#datasketches.hll_sketch.serialize_updatable" title="Link to this definition"></a></dt>
 <dd><p>Serializes the sketch into a bytes object</p>
 </dd></dl>

 <dl class="py property">
 <dt class="sig sig-object py" id="datasketches.hll_sketch.tgt_type">
 <em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">tgt_type</span></span><a class="headerlink" href="#datasketches.hll_sketch.tgt_type" title="Link to this definition"></a></dt>
 <dd><p>Returns the HLL type (4, 6, or 8) when in estimation mode</p>
 </dd></dl>

 <dl class="py method">
 <dt class="sig sig-object py" id="datasketches.hll_sketch.to_string">
 <span class="sig-name descname"><span class="pre">to_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#datasketches.hll_sketch" title="_datasketches.hll_sketch"><span class="pre">_datasketches.hll_sketch</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">summary</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">detail</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">aux_detail</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">all</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#datasketches.hll_sketch.to_string" title="Link to this definition"></a></dt>
 <dd><p>Produces a string summary of the sketch</p>
 </dd></dl>

 <dl class="py method">
 <dt class="sig sig-object py" id="datasketches.hll_sketch.update">
 <span class="sig-name descname"><span class="pre">update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#datasketches.hll_sketch.update" title="Link to this definition"></a></dt>
 <dd><p>Overloaded function.</p>
 <ol class="arabic simple">
 <li><p>update(self: _datasketches.hll_sketch, datum: int) -&gt; None</p></li>
 </ol>
 <p>Updates the sketch with the given integral value</p>
 <ol class="arabic simple" start="2">
 <li><p>update(self: _datasketches.hll_sketch, datum: float) -&gt; None</p></li>
 </ol>
 <p>Updates the sketch with the given floating point value</p>
 <ol class="arabic simple" start="3">
 <li><p>update(self: _datasketches.hll_sketch, datum: str) -&gt; None</p></li>
 </ol>
 <p>Updates the sketch with the given string value</p>
 </dd></dl>

 </dd></dl>

 </section>


            </div>
           </div>
           <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
         <a href="index.html" class="btn btn-neutral float-left" title="Apache DataSketches" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
         <a href="cpc.html" class="btn btn-neutral float-right" title="Compressed Probabilistic Counting (CPC)" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
     </div>

   <hr/>

   <div role="contentinfo">
     <p>&#169; Copyright .</p>
   </div>

   Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
     <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
     provided by <a href="https://readthedocs.org">Read the Docs</a>.


 </footer>
         </div>
       </div>
     </section>
   </div>
   <script>
       jQuery(function () {
           SphinxRtdTheme.Navigation.enable(true);
       });
   </script>

 </body>
 </html>