blob: 04968e2aa254210a9db828728dad17a4a6381522 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>Uses of Package org.apache.datasketches.common (datasketches-java 4.0.0 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
<script type="text/javascript" src="../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../jquery/jquery-3.6.0.min.js"></script>
<script type="text/javascript" src="../../../../jquery/jquery-ui.min.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Uses of Package org.apache.datasketches.common (datasketches-java 4.0.0 API)";
}
}
catch(err) {
}
//-->
var pathtoroot = "../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li>Class</li>
<li class="navBarCell1Rev">Use</li>
<li><a href="package-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="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<a id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<main role="main">
<div class="header">
<h1 title="Uses of Package org.apache.datasketches.common" class="title">Uses of Package<br>org.apache.datasketches.common</h1>
</div>
<div class="contentContainer">
<ul class="blockList">
<li class="blockList">
<table class="useSummary">
<caption><span>Packages that use <a href="package-summary.html">org.apache.datasketches.common</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Package</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="#org.apache.datasketches.common">org.apache.datasketches.common</a></th>
<td class="colLast">
<div class="block">This package is for common classes that may be used across all the sketch families.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="#org.apache.datasketches.cpc">org.apache.datasketches.cpc</a></th>
<td class="colLast">
<div class="block">Compressed Probabilistic Counting sketch family</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="#org.apache.datasketches.frequencies">org.apache.datasketches.frequencies</a></th>
<td class="colLast">
<div class="block">This package is dedicated to streaming algorithms that enable estimation of the
frequency of occurrence of items in a weighted multiset stream of items.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="#org.apache.datasketches.kll">org.apache.datasketches.kll</a></th>
<td class="colLast">
<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>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="#org.apache.datasketches.quantiles">org.apache.datasketches.quantiles</a></th>
<td class="colLast">
<div class="block">The quantiles package contains stochastic streaming algorithms that enable single-pass
analysis of the distribution of a stream of quantiles.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="#org.apache.datasketches.sampling">org.apache.datasketches.sampling</a></th>
<td class="colLast">
<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>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="#org.apache.datasketches.theta">org.apache.datasketches.theta</a></th>
<td class="colLast">
<div class="block">The theta package contains the basic sketch classes that are members of the
<a href="../../../../resources/dictionary.html#thetaSketch">Theta Sketch Framework</a>.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="#org.apache.datasketches.tuple">org.apache.datasketches.tuple</a></th>
<td class="colLast">
<div class="block">The tuple 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>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="#org.apache.datasketches.tuple.arrayofdoubles">org.apache.datasketches.tuple.arrayofdoubles</a></th>
<td class="colLast">
<div class="block">This package is for a concrete implementation of the Tuple sketch for an array of double values.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="#org.apache.datasketches.tuple.strings">org.apache.datasketches.tuple.strings</a></th>
<td class="colLast">
<div class="block">This package is for a generic implementation of the Tuple sketch for single String value.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList"><a id="org.apache.datasketches.common">
<!-- -->
</a>
<table class="useSummary">
<caption><span>Classes in <a href="package-summary.html">org.apache.datasketches.common</a> used by <a href="package-summary.html">org.apache.datasketches.common</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="class-use/ArrayOfItemsSerDe.html#org.apache.datasketches.common">ArrayOfItemsSerDe</a></th>
<td class="colLast">
<div class="block">Base class for serializing and deserializing custom types.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="class-use/Family.html#org.apache.datasketches.common">Family</a></th>
<td class="colLast">
<div class="block">Defines the various families of sketch and set operation classes.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="class-use/ResizeFactor.html#org.apache.datasketches.common">ResizeFactor</a></th>
<td class="colLast">
<div class="block">For the Families that accept this configuration parameter, it controls the size multiple that
affects how fast the internal cache grows, when more space is required.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="class-use/SketchesException.html#org.apache.datasketches.common">SketchesException</a></th>
<td class="colLast">
<div class="block">Exception class for the library</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="class-use/SuppressFBWarnings.html#org.apache.datasketches.common">SuppressFBWarnings</a></th>
<td class="colLast">
<div class="block">Used to suppress SpotBug warnings.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList"><a id="org.apache.datasketches.cpc">
<!-- -->
</a>
<table class="useSummary">
<caption><span>Classes in <a href="package-summary.html">org.apache.datasketches.common</a> used by <a href="../cpc/package-summary.html">org.apache.datasketches.cpc</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="class-use/Family.html#org.apache.datasketches.cpc">Family</a></th>
<td class="colLast">
<div class="block">Defines the various families of sketch and set operation classes.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="class-use/SuppressFBWarnings.html#org.apache.datasketches.cpc">SuppressFBWarnings</a></th>
<td class="colLast">
<div class="block">Used to suppress SpotBug warnings.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList"><a id="org.apache.datasketches.frequencies">
<!-- -->
</a>
<table class="useSummary">
<caption><span>Classes in <a href="package-summary.html">org.apache.datasketches.common</a> used by <a href="../frequencies/package-summary.html">org.apache.datasketches.frequencies</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="class-use/ArrayOfItemsSerDe.html#org.apache.datasketches.frequencies">ArrayOfItemsSerDe</a></th>
<td class="colLast">
<div class="block">Base class for serializing and deserializing custom types.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="class-use/SuppressFBWarnings.html#org.apache.datasketches.frequencies">SuppressFBWarnings</a></th>
<td class="colLast">
<div class="block">Used to suppress SpotBug warnings.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList"><a id="org.apache.datasketches.kll">
<!-- -->
</a>
<table class="useSummary">
<caption><span>Classes in <a href="package-summary.html">org.apache.datasketches.common</a> used by <a href="../kll/package-summary.html">org.apache.datasketches.kll</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="class-use/SuppressFBWarnings.html#org.apache.datasketches.kll">SuppressFBWarnings</a></th>
<td class="colLast">
<div class="block">Used to suppress SpotBug warnings.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList"><a id="org.apache.datasketches.quantiles">
<!-- -->
</a>
<table class="useSummary">
<caption><span>Classes in <a href="package-summary.html">org.apache.datasketches.common</a> used by <a href="../quantiles/package-summary.html">org.apache.datasketches.quantiles</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="class-use/ArrayOfItemsSerDe.html#org.apache.datasketches.quantiles">ArrayOfItemsSerDe</a></th>
<td class="colLast">
<div class="block">Base class for serializing and deserializing custom types.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList"><a id="org.apache.datasketches.sampling">
<!-- -->
</a>
<table class="useSummary">
<caption><span>Classes in <a href="package-summary.html">org.apache.datasketches.common</a> used by <a href="../sampling/package-summary.html">org.apache.datasketches.sampling</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="class-use/ArrayOfItemsSerDe.html#org.apache.datasketches.sampling">ArrayOfItemsSerDe</a></th>
<td class="colLast">
<div class="block">Base class for serializing and deserializing custom types.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="class-use/ResizeFactor.html#org.apache.datasketches.sampling">ResizeFactor</a></th>
<td class="colLast">
<div class="block">For the Families that accept this configuration parameter, it controls the size multiple that
affects how fast the internal cache grows, when more space is required.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList"><a id="org.apache.datasketches.theta">
<!-- -->
</a>
<table class="useSummary">
<caption><span>Classes in <a href="package-summary.html">org.apache.datasketches.common</a> used by <a href="../theta/package-summary.html">org.apache.datasketches.theta</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="class-use/Family.html#org.apache.datasketches.theta">Family</a></th>
<td class="colLast">
<div class="block">Defines the various families of sketch and set operation classes.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="class-use/ResizeFactor.html#org.apache.datasketches.theta">ResizeFactor</a></th>
<td class="colLast">
<div class="block">For the Families that accept this configuration parameter, it controls the size multiple that
affects how fast the internal cache grows, when more space is required.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="class-use/SuppressFBWarnings.html#org.apache.datasketches.theta">SuppressFBWarnings</a></th>
<td class="colLast">
<div class="block">Used to suppress SpotBug warnings.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList"><a id="org.apache.datasketches.tuple">
<!-- -->
</a>
<table class="useSummary">
<caption><span>Classes in <a href="package-summary.html">org.apache.datasketches.common</a> used by <a href="../tuple/package-summary.html">org.apache.datasketches.tuple</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="class-use/ResizeFactor.html#org.apache.datasketches.tuple">ResizeFactor</a></th>
<td class="colLast">
<div class="block">For the Families that accept this configuration parameter, it controls the size multiple that
affects how fast the internal cache grows, when more space is required.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="class-use/SuppressFBWarnings.html#org.apache.datasketches.tuple">SuppressFBWarnings</a></th>
<td class="colLast">
<div class="block">Used to suppress SpotBug warnings.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList"><a id="org.apache.datasketches.tuple.arrayofdoubles">
<!-- -->
</a>
<table class="useSummary">
<caption><span>Classes in <a href="package-summary.html">org.apache.datasketches.common</a> used by <a href="../tuple/arrayofdoubles/package-summary.html">org.apache.datasketches.tuple.arrayofdoubles</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="class-use/ResizeFactor.html#org.apache.datasketches.tuple.arrayofdoubles">ResizeFactor</a></th>
<td class="colLast">
<div class="block">For the Families that accept this configuration parameter, it controls the size multiple that
affects how fast the internal cache grows, when more space is required.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="class-use/SuppressFBWarnings.html#org.apache.datasketches.tuple.arrayofdoubles">SuppressFBWarnings</a></th>
<td class="colLast">
<div class="block">Used to suppress SpotBug warnings.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList"><a id="org.apache.datasketches.tuple.strings">
<!-- -->
</a>
<table class="useSummary">
<caption><span>Classes in <a href="package-summary.html">org.apache.datasketches.common</a> used by <a href="../tuple/strings/package-summary.html">org.apache.datasketches.tuple.strings</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="class-use/ResizeFactor.html#org.apache.datasketches.tuple.strings">ResizeFactor</a></th>
<td class="colLast">
<div class="block">For the Families that accept this configuration parameter, it controls the size multiple that
affects how fast the internal cache grows, when more space is required.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
</div>
</main>
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li>Class</li>
<li class="navBarCell1Rev">Use</li>
<li><a href="package-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="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Copyright &#169; 2015&#x2013;2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</body>
</html>