blob: 88624a5299b97fb0bddf725945389465a8573d76 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>org.apache.datasketches.quantilescommon (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="org.apache.datasketches.quantilescommon (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 class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.html">Use</a></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="Package" class="title">Package&nbsp;org.apache.datasketches.quantilescommon</h1>
</div>
<div class="contentContainer">
<section><a id="package.description">
<!-- -->
</a>
<div class="block">This package contains common tools and methods for the <i>quantiles</i>, <i>kll</i> and
<i>req</i> packages.</div>
</section>
<ul class="blockList">
<li class="blockList">
<table class="typeSummary">
<caption><span>Interface Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Interface</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="DoublesSortedView.html" title="interface in org.apache.datasketches.quantilescommon">DoublesSortedView</a></th>
<td class="colLast">
<div class="block">The Sorted View for quantiles of primitive type double.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="DoublesSortedViewIterator.html" title="interface in org.apache.datasketches.quantilescommon">DoublesSortedViewIterator</a></th>
<td class="colLast">
<div class="block">The quantiles SortedView iterator for type double.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="FloatsSortedView.html" title="interface in org.apache.datasketches.quantilescommon">FloatsSortedView</a></th>
<td class="colLast">
<div class="block">The Sorted View for quantiles of primitive type float.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="FloatsSortedViewIterator.html" title="interface in org.apache.datasketches.quantilescommon">FloatsSortedViewIterator</a></th>
<td class="colLast">
<div class="block">The quantiles SortedView Iterator for type float.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="GenericSortedView.html" title="interface in org.apache.datasketches.quantilescommon">GenericSortedView</a>&lt;T&gt;</th>
<td class="colLast">
<div class="block">The Sorted View for quantiles of generic type.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="GenericSortedViewIterator.html" title="interface in org.apache.datasketches.quantilescommon">GenericSortedViewIterator</a>&lt;T&gt;</th>
<td class="colLast">
<div class="block">The quantiles SortedView Iterator for generic types.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></th>
<td class="colLast">
<div class="block">This is a stochastic streaming sketch that enables near-real time analysis of the
approximate distribution of items from a very large stream in a single pass, requiring only
that the items are comparable.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="QuantilesDoublesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesDoublesAPI</a></th>
<td class="colLast">
<div class="block">The Quantiles API for item type <i>double</i>.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="QuantilesDoublesSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesDoublesSketchIterator</a></th>
<td class="colLast">
<div class="block">The quantiles sketch iterator for primitive type double.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="QuantilesFloatsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsAPI</a></th>
<td class="colLast">
<div class="block">The Quantiles API for item type <i>float</i>.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="QuantilesFloatsSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsSketchIterator</a></th>
<td class="colLast">
<div class="block">The quantiles sketch iterator for primitive type float.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="QuantilesGenericAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericAPI</a>&lt;T&gt;</th>
<td class="colLast">
<div class="block">The Quantiles API for item type <i>generic</i>.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="QuantilesGenericSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericSketchIterator</a>&lt;T&gt;</th>
<td class="colLast">
<div class="block">The quantiles sketch iterator for generic types.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="QuantilesSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesSketchIterator</a></th>
<td class="colLast">
<div class="block">This is the base interface for the SketchIterator hierarchy used for viewing the
non-ordered quantiles retained by a sketch.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="SortedView.html" title="interface in org.apache.datasketches.quantilescommon">SortedView</a></th>
<td class="colLast">
<div class="block">This is the base interface for the Sorted View interface hierarchy.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="SortedViewIterator.html" title="interface in org.apache.datasketches.quantilescommon">SortedViewIterator</a></th>
<td class="colLast">
<div class="block">This is the base interface for the SortedViewIterator hierarchy used with a SortedView obtained
from a quantile-type sketch.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary">
<caption><span>Class Summary</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="BinarySearch.html" title="class in org.apache.datasketches.quantilescommon">BinarySearch</a></th>
<td class="colLast">
<div class="block">Contains common equality binary search algorithms.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="GenericInequalitySearch.html" title="class in org.apache.datasketches.quantilescommon">GenericInequalitySearch</a></th>
<td class="colLast">
<div class="block">This provides efficient, unique and unambiguous binary searching for inequality comparison criteria
for ordered arrays of values that may include duplicate values.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="QuantilesDoublesAPI.DoublesPartitionBoundaries.html" title="class in org.apache.datasketches.quantilescommon">QuantilesDoublesAPI.DoublesPartitionBoundaries</a></th>
<td class="colLast">
<div class="block">This encapsulates the essential information needed to construct actual partitions and is returned from the
<i>getPartitionBoundaries(int, QuantileSearchCritera)</i> method.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="QuantilesFloatsAPI.FloatsPartitionBoundaries.html" title="class in org.apache.datasketches.quantilescommon">QuantilesFloatsAPI.FloatsPartitionBoundaries</a></th>
<td class="colLast">
<div class="block">This encapsulates the essential information needed to construct actual partitions and is returned from the
<i>getPartitionBoundaries(int, QuantileSearchCritera)</i> method.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="QuantilesGenericAPI.GenericPartitionBoundaries.html" title="class in org.apache.datasketches.quantilescommon">QuantilesGenericAPI.GenericPartitionBoundaries</a>&lt;T&gt;</th>
<td class="colLast">
<div class="block">This encapsulates the essential information needed to construct actual partitions and is returned from the
<i>getPartitionBoundaries(int, QuantileSearchCritera)</i> method.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="QuantilesUtil.html" title="class in org.apache.datasketches.quantilescommon">QuantilesUtil</a></th>
<td class="colLast">
<div class="block">Utilities for the quantiles sketches.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary">
<caption><span>Enum Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Enum</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="GenericInequalitySearch.Inequality.html" title="enum in org.apache.datasketches.quantilescommon">GenericInequalitySearch.Inequality</a></th>
<td class="colLast">
<div class="block">The enumerator of inequalities</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="InequalitySearch.html" title="enum in org.apache.datasketches.quantilescommon">InequalitySearch</a></th>
<td class="colLast">
<div class="block">This provides efficient, unique and unambiguous binary searching for inequality comparison criteria
for ordered arrays of values that may include duplicate values.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="QuantileSearchCriteria.html" title="enum in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a></th>
<td class="colLast">
<div class="block">These search criteria are used by the KLL, REQ and Classic Quantiles sketches in the DataSketches library.</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 class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.html">Use</a></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>