blob: e32fed9d68c243481d9ea8a2eea0f163fdaac5b0 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>Uses of Interface org.apache.datasketches.quantilescommon.QuantilesAPI (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 Interface org.apache.datasketches.quantilescommon.QuantilesAPI (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><a href="../QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">Class</a></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">
<h2 title="Uses of Interface org.apache.datasketches.quantilescommon.QuantilesAPI" class="title">Uses of Interface<br>org.apache.datasketches.quantilescommon.QuantilesAPI</h2>
</div>
<div class="classUseContainer">
<ul class="blockList">
<li class="blockList">
<table class="useSummary">
<caption><span>Packages that use <a href="../QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</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.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="rowColor">
<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="altColor">
<th class="colFirst" scope="row"><a href="#org.apache.datasketches.quantilescommon">org.apache.datasketches.quantilescommon</a></th>
<td class="colLast">
<div class="block">This package contains common tools and methods for the <i>quantiles</i>, <i>kll</i> and
<i>req</i> packages.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="#org.apache.datasketches.req">org.apache.datasketches.req</a></th>
<td class="colLast">
<div class="block">This package is for the implementation of the Relative Error Quantiles sketch algorithm.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<ul class="blockList">
<li class="blockList">
<section><a id="org.apache.datasketches.kll">
<!-- -->
</a>
<h3>Uses of <a href="../QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a> in <a href="../../kll/package-summary.html">org.apache.datasketches.kll</a></h3>
<table class="useSummary">
<caption><span>Classes in <a href="../../kll/package-summary.html">org.apache.datasketches.kll</a> that implement <a href="../QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><code>class&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../kll/KllDoublesSketch.html" title="class in org.apache.datasketches.kll">KllDoublesSketch</a></span></code></th>
<td class="colLast">
<div class="block">This variation of the KllSketch implements primitive doubles.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>class&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../kll/KllFloatsSketch.html" title="class in org.apache.datasketches.kll">KllFloatsSketch</a></span></code></th>
<td class="colLast">
<div class="block">This variation of the KllSketch implements primitive floats.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>class&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../kll/KllSketch.html" title="class in org.apache.datasketches.kll">KllSketch</a></span></code></th>
<td class="colLast">
<div class="block">This class is the root of the KLL sketch class hierarchy.</div>
</td>
</tr>
</tbody>
</table>
</section>
</li>
<li class="blockList">
<section><a id="org.apache.datasketches.quantiles">
<!-- -->
</a>
<h3>Uses of <a href="../QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a> in <a href="../../quantiles/package-summary.html">org.apache.datasketches.quantiles</a></h3>
<table class="useSummary">
<caption><span>Classes in <a href="../../quantiles/package-summary.html">org.apache.datasketches.quantiles</a> that implement <a href="../QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><code>class&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../quantiles/CompactDoublesSketch.html" title="class in org.apache.datasketches.quantiles">CompactDoublesSketch</a></span></code></th>
<td class="colLast">
<div class="block">Compact sketches are inherently <i>read ony</i>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>class&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../quantiles/DoublesSketch.html" title="class in org.apache.datasketches.quantiles">DoublesSketch</a></span></code></th>
<td class="colLast">
<div class="block">This is an implementation of the Low Discrepancy Mergeable Quantiles Sketch, using doubles,
described in section 3.2 of the journal version of the paper "Mergeable Summaries"
by Agarwal, Cormode, Huang, Phillips, Wei, and Yi:</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>class&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../quantiles/ItemsSketch.html" title="class in org.apache.datasketches.quantiles">ItemsSketch</a>&lt;T&gt;</span></code></th>
<td class="colLast">
<div class="block">This is an implementation of the Low Discrepancy Mergeable Quantiles Sketch, using generic items,
described in section 3.2 of the journal version of the paper "Mergeable Summaries"
by Agarwal, Cormode, Huang, Phillips, Wei, and Yi:</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>class&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../quantiles/UpdateDoublesSketch.html" title="class in org.apache.datasketches.quantiles">UpdateDoublesSketch</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
</table>
</section>
</li>
<li class="blockList">
<section><a id="org.apache.datasketches.quantilescommon">
<!-- -->
</a>
<h3>Uses of <a href="../QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a> in <a href="../package-summary.html">org.apache.datasketches.quantilescommon</a></h3>
<table class="useSummary">
<caption><span>Subinterfaces of <a href="../QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a> in <a href="../package-summary.html">org.apache.datasketches.quantilescommon</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Interface</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><code>interface&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../QuantilesDoublesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesDoublesAPI</a></span></code></th>
<td class="colLast">
<div class="block">The Quantiles API for item type <i>double</i>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>interface&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../QuantilesFloatsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsAPI</a></span></code></th>
<td class="colLast">
<div class="block">The Quantiles API for item type <i>float</i>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>interface&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../QuantilesGenericAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericAPI</a>&lt;T&gt;</span></code></th>
<td class="colLast">
<div class="block">The Quantiles API for item type <i>generic</i>.</div>
</td>
</tr>
</tbody>
</table>
</section>
</li>
<li class="blockList">
<section><a id="org.apache.datasketches.req">
<!-- -->
</a>
<h3>Uses of <a href="../QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a> in <a href="../../req/package-summary.html">org.apache.datasketches.req</a></h3>
<table class="useSummary">
<caption><span>Classes in <a href="../../req/package-summary.html">org.apache.datasketches.req</a> that implement <a href="../QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><code>class&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../req/ReqSketch.html" title="class in org.apache.datasketches.req">ReqSketch</a></span></code></th>
<td class="colLast">
<div class="block">This Relative Error Quantiles Sketch is the Java implementation based on the paper
"Relative Error Streaming Quantiles" by Graham Cormode, Zohar Karnin, Edo Liberty,
Justin Thaler, Pavel VeselĂ˝, and loosely derived from a Python prototype written by Pavel VeselĂ˝.</div>
</td>
</tr>
</tbody>
</table>
</section>
</li>
</ul>
</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><a href="../QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">Class</a></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>