blob: 05bc39ca5d4be95e89063ede7b0cb99206c5d3b4 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>NumericEquiDepthHistogram (Drill : 1.20.3 API)</title>
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="NumericEquiDepthHistogram (Drill : 1.20.3 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":9,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/NumericEquiDepthHistogram.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">
<li><a href="../../../../../../org/apache/drill/exec/planner/common/JoinControl.html" title="class in org.apache.drill.exec.planner.common"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/apache/drill/exec/planner/common/OrderedRel.html" title="interface in org.apache.drill.exec.planner.common"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/drill/exec/planner/common/NumericEquiDepthHistogram.html" target="_top">Frames</a></li>
<li><a href="NumericEquiDepthHistogram.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../allclasses-noframe.html">All&nbsp;Classes</a></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>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.drill.exec.planner.common</div>
<h2 title="Class NumericEquiDepthHistogram" class="title">Class NumericEquiDepthHistogram</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>org.apache.drill.exec.planner.common.NumericEquiDepthHistogram</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../../../org/apache/drill/metastore/statistics/Histogram.html" title="interface in org.apache.drill.metastore.statistics">Histogram</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">NumericEquiDepthHistogram</span>
extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>
implements <a href="../../../../../../org/apache/drill/metastore/statistics/Histogram.html" title="interface in org.apache.drill.metastore.statistics">Histogram</a></pre>
<div class="block">A column specific equi-depth histogram which is meant for numeric data types</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/planner/common/NumericEquiDepthHistogram.html#NumericEquiDepthHistogram--">NumericEquiDepthHistogram</a></span>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/planner/common/NumericEquiDepthHistogram.html#NumericEquiDepthHistogram-int-">NumericEquiDepthHistogram</a></span>(int&nbsp;numBuckets)</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>static <a href="../../../../../../org/apache/drill/exec/planner/common/NumericEquiDepthHistogram.html" title="class in org.apache.drill.exec.planner.common">NumericEquiDepthHistogram</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/planner/common/NumericEquiDepthHistogram.html#buildFromTDigest-byte:A-int-long-">buildFromTDigest</a></span>(byte[]&nbsp;tdigest_array,
int&nbsp;numBuckets,
long&nbsp;nonNullCount)</code>
<div class="block">Build a Numeric Equi-Depth Histogram from a t-digest byte array</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Double.html?is-external=true" title="class or interface in java.lang">Double</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/planner/common/NumericEquiDepthHistogram.html#estimatedSelectivity-org.apache.calcite.rex.RexNode-long-long-">estimatedSelectivity</a></span>(org.apache.calcite.rex.RexNode&nbsp;columnFilter,
long&nbsp;totalRowCount,
long&nbsp;ndv)</code>
<div class="block">Estimate the selectivity of a filter which may contain several range predicates and in the general case is of
type: col op value1 AND col op value2 AND col op value3 ...</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Double.html?is-external=true" title="class or interface in java.lang">Double</a>[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/planner/common/NumericEquiDepthHistogram.html#getBuckets--">getBuckets</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/planner/common/NumericEquiDepthHistogram.html#getNumBuckets--">getNumBuckets</a></span>()</code>
<div class="block">Get the number of buckets in the histogram
number of buckets is 1 less than the total # entries in the buckets array since last
entry is the end point of the last bucket</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/planner/common/NumericEquiDepthHistogram.html#getNumRowsPerBucket--">getNumRowsPerBucket</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>protected long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/planner/common/NumericEquiDepthHistogram.html#getSelectedRows-org.apache.drill.shaded.guava.com.google.common.collect.Range-long-">getSelectedRows</a></span>(org.apache.drill.shaded.guava.com.google.common.collect.Range&nbsp;range,
long&nbsp;ndv)</code>&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/planner/common/NumericEquiDepthHistogram.html#setBucketValue-int-java.lang.Double-">setBucketValue</a></span>(int&nbsp;index,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Double.html?is-external=true" title="class or interface in java.lang">Double</a>&nbsp;value)</code>&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/planner/common/NumericEquiDepthHistogram.html#setNumRowsPerBucket-double-">setNumRowsPerBucket</a></span>(double&nbsp;numRows)</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="NumericEquiDepthHistogram--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>NumericEquiDepthHistogram</h4>
<pre>public&nbsp;NumericEquiDepthHistogram()</pre>
</li>
</ul>
<a name="NumericEquiDepthHistogram-int-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>NumericEquiDepthHistogram</h4>
<pre>public&nbsp;NumericEquiDepthHistogram(int&nbsp;numBuckets)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getNumRowsPerBucket--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNumRowsPerBucket</h4>
<pre>public&nbsp;double&nbsp;getNumRowsPerBucket()</pre>
</li>
</ul>
<a name="setNumRowsPerBucket-double-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setNumRowsPerBucket</h4>
<pre>public&nbsp;void&nbsp;setNumRowsPerBucket(double&nbsp;numRows)</pre>
</li>
</ul>
<a name="getBuckets--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBuckets</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Double.html?is-external=true" title="class or interface in java.lang">Double</a>[]&nbsp;getBuckets()</pre>
</li>
</ul>
<a name="setBucketValue-int-java.lang.Double-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setBucketValue</h4>
<pre>protected&nbsp;void&nbsp;setBucketValue(int&nbsp;index,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Double.html?is-external=true" title="class or interface in java.lang">Double</a>&nbsp;value)</pre>
</li>
</ul>
<a name="getNumBuckets--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNumBuckets</h4>
<pre>public&nbsp;int&nbsp;getNumBuckets()</pre>
<div class="block">Get the number of buckets in the histogram
number of buckets is 1 less than the total # entries in the buckets array since last
entry is the end point of the last bucket</div>
</li>
</ul>
<a name="estimatedSelectivity-org.apache.calcite.rex.RexNode-long-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>estimatedSelectivity</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Double.html?is-external=true" title="class or interface in java.lang">Double</a>&nbsp;estimatedSelectivity(org.apache.calcite.rex.RexNode&nbsp;columnFilter,
long&nbsp;totalRowCount,
long&nbsp;ndv)</pre>
<div class="block">Estimate the selectivity of a filter which may contain several range predicates and in the general case is of
type: col op value1 AND col op value2 AND col op value3 ...
<p>
e.g a > 10 AND a < 50 AND a >= 20 AND a <= 70 ...
</p>
Even though in most cases it will have either 1 or 2 range conditions, we still have to handle the general case
For each conjunct, we will find the histogram bucket ranges and intersect them, taking into account that the
first and last bucket may be partially covered and all other buckets in the middle are fully covered.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/apache/drill/metastore/statistics/Histogram.html#estimatedSelectivity-org.apache.calcite.rex.RexNode-long-long-">estimatedSelectivity</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org/apache/drill/metastore/statistics/Histogram.html" title="interface in org.apache.drill.metastore.statistics">Histogram</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>estimated selectivity or NULL if it could not be estimated for any reason</dd>
</dl>
</li>
</ul>
<a name="getSelectedRows-org.apache.drill.shaded.guava.com.google.common.collect.Range-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSelectedRows</h4>
<pre>protected&nbsp;long&nbsp;getSelectedRows(org.apache.drill.shaded.guava.com.google.common.collect.Range&nbsp;range,
long&nbsp;ndv)</pre>
</li>
</ul>
<a name="buildFromTDigest-byte:A-int-long-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>buildFromTDigest</h4>
<pre>public static&nbsp;<a href="../../../../../../org/apache/drill/exec/planner/common/NumericEquiDepthHistogram.html" title="class in org.apache.drill.exec.planner.common">NumericEquiDepthHistogram</a>&nbsp;buildFromTDigest(byte[]&nbsp;tdigest_array,
int&nbsp;numBuckets,
long&nbsp;nonNullCount)</pre>
<div class="block">Build a Numeric Equi-Depth Histogram from a t-digest byte array</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>tdigest_array</code> - </dd>
<dd><code>numBuckets</code> - </dd>
<dd><code>nonNullCount</code> - </dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>An instance of NumericEquiDepthHistogram</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/NumericEquiDepthHistogram.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">
<li><a href="../../../../../../org/apache/drill/exec/planner/common/JoinControl.html" title="class in org.apache.drill.exec.planner.common"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/apache/drill/exec/planner/common/OrderedRel.html" title="interface in org.apache.drill.exec.planner.common"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/drill/exec/planner/common/NumericEquiDepthHistogram.html" target="_top">Frames</a></li>
<li><a href="NumericEquiDepthHistogram.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../allclasses-noframe.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>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 1970 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>