| <!DOCTYPE HTML> |
| <html lang> |
| <head> |
| <!-- Generated by javadoc (25) --> |
| <title>Overview (datasketches-java 9.0.1-SNAPSHOT API)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="description" content="package index"> |
| <meta name="generator" content="javadoc/PackageIndexWriter"> |
| <link rel="stylesheet" type="text/css" href="resource-files/jquery-ui.min.css"> |
| <link rel="stylesheet" type="text/css" href="resource-files/stylesheet.css"> |
| <script type="text/javascript" src="script-files/script.js"></script> |
| <script type="text/javascript" src="script-files/jquery-3.7.1.min.js"></script> |
| <script type="text/javascript" src="script-files/jquery-ui.min.js"></script> |
| </head> |
| <body class="package-index-page"> |
| <script type="text/javascript">const pathtoroot = "./"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <header role="banner"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar-top"> |
| <div class="nav-content"> |
| <div class="nav-menu-button"><button id="navbar-toggle-button" aria-controls="navbar-top" aria-expanded="false" aria-label="Toggle navigation links"><span class="nav-bar-toggle-icon"> </span><span class="nav-bar-toggle-icon"> </span><span class="nav-bar-toggle-icon"> </span></button></div> |
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
| <li class="nav-bar-cell1-rev">Overview</li> |
| <li><a href="overview-tree.html">Tree</a></li> |
| <li><a href="deprecated-list.html">Deprecated</a></li> |
| <li><a href="index-all.html">Index</a></li> |
| <li><a href="search.html">Search</a></li> |
| <li><a href="help-doc.html#overview">Help</a></li> |
| </ul> |
| </div> |
| </div> |
| <div class="sub-nav"> |
| <div class="nav-content"> |
| <ol class="sub-nav-list"></ol> |
| <div class="nav-list-search"><input type="text" id="search-input" disabled placeholder="Search documentation (type /)" aria-label="Search in documentation" autocomplete="off" spellcheck="false"><input type="reset" id="reset-search" disabled value="Reset"></div> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="main-grid"> |
| <main role="main"> |
| <div class="header"> |
| <h1 class="title">datasketches-java 9.0.1-SNAPSHOT API</h1> |
| </div> |
| <div class="block"><h1 id="sketching-core-library-heading">Sketching Core Library</h1> |
| <h2 id="overview-heading">Overview</h2> |
| |
| <p>The Sketching Core Library provides a range of stochastic streaming algorithms and closely |
| related java technologies that are particularly useful when integrating this technology into |
| systems that must deal with massive data. |
| </p> |
| |
| <p>This library is divided into packages that constitute distinct groups of functionality:</p> |
| |
| Note: In general, if the requirements or promises of any method's contract are not fulfilled |
| (that is, if there is a bug in either the method or its caller), |
| then an unchecked exception will be thrown. |
| The precise type of such an unchecked exception does not form part of any method's contract.</div> |
| <div id="all-packages-table"> |
| <div class="caption"><span>Packages</span></div> |
| <div class="summary-table two-column-summary"> |
| <div class="table-header col-first">Package</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color all-packages-table all-packages-table-tab1"><a href="org/apache/datasketches/package-summary.html">org.apache.datasketches</a></div> |
| <div class="col-last even-row-color all-packages-table all-packages-table-tab1"> |
| <div class="block">This package is the parent package for all sketch families and common code areas.</div> |
| </div> |
| <div class="col-first odd-row-color all-packages-table all-packages-table-tab1"><a href="org/apache/datasketches/common/package-summary.html">org.apache.datasketches.common</a></div> |
| <div class="col-last odd-row-color all-packages-table all-packages-table-tab1"> |
| <div class="block">This package is for common classes that may be used across all the sketch families.</div> |
| </div> |
| <div class="col-first even-row-color all-packages-table all-packages-table-tab1"><a href="org/apache/datasketches/common/positional/package-summary.html">org.apache.datasketches.common.positional</a></div> |
| <div class="col-last even-row-color all-packages-table all-packages-table-tab1"> |
| <div class="block">This package provides the classes that define and implement a relative positional API.</div> |
| </div> |
| <div class="col-first odd-row-color all-packages-table all-packages-table-tab1"><a href="org/apache/datasketches/count/package-summary.html">org.apache.datasketches.count</a></div> |
| <div class="col-last odd-row-color all-packages-table all-packages-table-tab1"> |
| <div class="block">This package in intended for implementations of the the Count Sketch and the Count-min Sketch both of which can be used to estimate |
| frequency-moments of a stream of distinct elements.</div> |
| </div> |
| <div class="col-first even-row-color all-packages-table all-packages-table-tab1"><a href="org/apache/datasketches/cpc/package-summary.html">org.apache.datasketches.cpc</a></div> |
| <div class="col-last even-row-color all-packages-table all-packages-table-tab1"> |
| <div class="block">Compressed Probabilistic Counting sketch family</div> |
| </div> |
| <div class="col-first odd-row-color all-packages-table all-packages-table-tab1"><a href="org/apache/datasketches/fdt/package-summary.html">org.apache.datasketches.fdt</a></div> |
| <div class="col-last odd-row-color all-packages-table all-packages-table-tab1"> |
| <div class="block">Frequent Distinct Tuples Sketch</div> |
| </div> |
| <div class="col-first even-row-color all-packages-table all-packages-table-tab1"><a href="org/apache/datasketches/filters/package-summary.html">org.apache.datasketches.filters</a></div> |
| <div class="col-last even-row-color all-packages-table all-packages-table-tab1"> |
| <div class="block">The filters package contains data structures used to determine |
| approximate set-membership.</div> |
| </div> |
| <div class="col-first odd-row-color all-packages-table all-packages-table-tab1"><a href="org/apache/datasketches/filters/bloomfilter/package-summary.html">org.apache.datasketches.filters.bloomfilter</a></div> |
| <div class="col-last odd-row-color all-packages-table all-packages-table-tab1"> |
| <div class="block">BloomFilter package</div> |
| </div> |
| <div class="col-first even-row-color all-packages-table all-packages-table-tab1"><a href="org/apache/datasketches/frequencies/package-summary.html">org.apache.datasketches.frequencies</a></div> |
| <div class="col-last even-row-color all-packages-table all-packages-table-tab1"> |
| <div class="block">This package contains the implementations of the paper <a href="https://arxiv.org/abs/1705.07001">https://arxiv.org/abs/1705.07001</a>.</div> |
| </div> |
| <div class="col-first odd-row-color all-packages-table all-packages-table-tab1"><a href="org/apache/datasketches/hash/package-summary.html">org.apache.datasketches.hash</a></div> |
| <div class="col-last odd-row-color all-packages-table all-packages-table-tab1"> |
| <div class="block">The hash package contains a high-performing and extended Java implementations |
| of Austin Appleby's 128-bit MurmurHash3 hash function originally coded in C.</div> |
| </div> |
| <div class="col-first even-row-color all-packages-table all-packages-table-tab1"><a href="org/apache/datasketches/hll/package-summary.html">org.apache.datasketches.hll</a></div> |
| <div class="col-last even-row-color all-packages-table all-packages-table-tab1"> |
| <div class="block">The DataSketches™ HllSketch family package</div> |
| </div> |
| <div class="col-first odd-row-color all-packages-table all-packages-table-tab1"><a href="org/apache/datasketches/hllmap/package-summary.html">org.apache.datasketches.hllmap</a></div> |
| <div class="col-last odd-row-color all-packages-table all-packages-table-tab1"> |
| <div class="block">The hllmap package contains a space efficient HLL mapping sketch of keys to approximate unique |
| count of identifiers.</div> |
| </div> |
| <div class="col-first even-row-color all-packages-table all-packages-table-tab1"><a href="org/apache/datasketches/kll/package-summary.html">org.apache.datasketches.kll</a></div> |
| <div class="col-last even-row-color all-packages-table all-packages-table-tab1"> |
| <div class="block">This package is for the implementations of the sketch algorithm developed by Zohar Karnin, Kevin Lang, |
| and Edo Liberty that is commonly referred to as the "KLL" sketch after the authors' last names.</div> |
| </div> |
| <div class="col-first odd-row-color all-packages-table all-packages-table-tab1"><a href="org/apache/datasketches/partitions/package-summary.html">org.apache.datasketches.partitions</a></div> |
| <div class="col-last odd-row-color all-packages-table all-packages-table-tab1"> |
| <div class="block">This package is for classes that simplify the task of partitioning large data into many approximately equal-sized |
| partitions.</div> |
| </div> |
| <div class="col-first even-row-color all-packages-table all-packages-table-tab1"><a href="org/apache/datasketches/quantiles/package-summary.html">org.apache.datasketches.quantiles</a></div> |
| <div class="col-last even-row-color all-packages-table all-packages-table-tab1"> |
| <div class="block">The quantiles package contains stochastic streaming algorithms that enable single-pass |
| analysis of the distribution of a stream of quantiles.</div> |
| </div> |
| <div class="col-first odd-row-color all-packages-table all-packages-table-tab1"><a href="org/apache/datasketches/quantilescommon/package-summary.html">org.apache.datasketches.quantilescommon</a></div> |
| <div class="col-last odd-row-color all-packages-table all-packages-table-tab1"> |
| <div class="block">This package contains common tools and methods for the <i>quantiles</i>, <i>kll</i> and |
| <i>req</i> packages.</div> |
| </div> |
| <div class="col-first even-row-color all-packages-table all-packages-table-tab1"><a href="org/apache/datasketches/req/package-summary.html">org.apache.datasketches.req</a></div> |
| <div class="col-last even-row-color all-packages-table all-packages-table-tab1"> |
| <div class="block">This package is for the implementation of the Relative Error Quantiles sketch algorithm.</div> |
| </div> |
| <div class="col-first odd-row-color all-packages-table all-packages-table-tab1"><a href="org/apache/datasketches/sampling/package-summary.html">org.apache.datasketches.sampling</a></div> |
| <div class="col-last odd-row-color all-packages-table all-packages-table-tab1"> |
| <div class="block">This package is dedicated to streaming algorithms that enable fixed size, uniform sampling of |
| weighted and unweighted items from a stream.</div> |
| </div> |
| <div class="col-first even-row-color all-packages-table all-packages-table-tab1"><a href="org/apache/datasketches/tdigest/package-summary.html">org.apache.datasketches.tdigest</a></div> |
| <div class="col-last even-row-color all-packages-table all-packages-table-tab1"> |
| <div class="block">t-Digest for estimating quantiles and ranks.</div> |
| </div> |
| <div class="col-first odd-row-color all-packages-table all-packages-table-tab1"><a href="org/apache/datasketches/theta/package-summary.html">org.apache.datasketches.theta</a></div> |
| <div class="col-last odd-row-color all-packages-table all-packages-table-tab1"> |
| <div class="block">The <i>theta</i> package contains the basic sketch classes that are members of the |
| <a href="https://github.com/apache/datasketches-website/blob/master/docs/pdf/ThetaSketchFramework.pdf">Theta-Sketch Framework</a>.</div> |
| </div> |
| <div class="col-first even-row-color all-packages-table all-packages-table-tab1"><a href="org/apache/datasketches/thetacommon/package-summary.html">org.apache.datasketches.thetacommon</a></div> |
| <div class="col-last even-row-color all-packages-table all-packages-table-tab1"> |
| <div class="block">This package contains common tools and methods for the <i>theta</i>, |
| <i>tuple</i>, <i>tuple/*</i> and <i>fdt</i> packages.</div> |
| </div> |
| <div class="col-first odd-row-color all-packages-table all-packages-table-tab1"><a href="org/apache/datasketches/tuple/package-summary.html">org.apache.datasketches.tuple</a></div> |
| <div class="col-last odd-row-color all-packages-table all-packages-table-tab1"> |
| <div class="block">The <i>tuple</i> package contains a number of sketches based on the same |
| fundamental algorithms of the Theta Sketch Framework and extend these |
| concepts for whole new families of sketches.</div> |
| </div> |
| <div class="col-first even-row-color all-packages-table all-packages-table-tab1"><a href="org/apache/datasketches/tuple/adouble/package-summary.html">org.apache.datasketches.tuple.adouble</a></div> |
| <div class="col-last even-row-color all-packages-table all-packages-table-tab1"> |
| <div class="block">This package is for a generic implementation of the Tuple sketch for single Double value.</div> |
| </div> |
| <div class="col-first odd-row-color all-packages-table all-packages-table-tab1"><a href="org/apache/datasketches/tuple/aninteger/package-summary.html">org.apache.datasketches.tuple.aninteger</a></div> |
| <div class="col-last odd-row-color all-packages-table all-packages-table-tab1"> |
| <div class="block">This package is for a generic implementation of the Tuple sketch for single Integer value.</div> |
| </div> |
| <div class="col-first even-row-color all-packages-table all-packages-table-tab1"><a href="org/apache/datasketches/tuple/arrayofdoubles/package-summary.html">org.apache.datasketches.tuple.arrayofdoubles</a></div> |
| <div class="col-last even-row-color all-packages-table all-packages-table-tab1"> |
| <div class="block">This package is for a concrete implementation of the Tuple sketch for an array of double values.</div> |
| </div> |
| <div class="col-first odd-row-color all-packages-table all-packages-table-tab1"><a href="org/apache/datasketches/tuple/strings/package-summary.html">org.apache.datasketches.tuple.strings</a></div> |
| <div class="col-last odd-row-color all-packages-table all-packages-table-tab1"> |
| <div class="block">This package is for a generic implementation of the Tuple sketch for single String value.</div> |
| </div> |
| </div> |
| </div> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 2015–2025 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </main> |
| </div> |
| </body> |
| </html> |
