blob: 148397256b38120b6ae8acec16594570bb7bb6c4 [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>BinarySearch (Apache Calcite calcite 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="BinarySearch (Apache Calcite calcite API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9,"i5":9,"i6":9,"i7":9};
var tabs = {65535:["t0","All Methods"],1:["t1","Static 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="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 class="aboutLanguage"><b>Apache Calcite</b></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/apache/calcite/runtime/AutomatonBuilder.html" title="class in org.apache.calcite.runtime"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/calcite/runtime/Bindable.html" title="interface in org.apache.calcite.runtime"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/calcite/runtime/BinarySearch.html" target="_top">Frames</a></li>
<li><a href="BinarySearch.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.calcite.runtime</div>
<h2 title="Class BinarySearch" class="title">Class BinarySearch</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.calcite.runtime.BinarySearch</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="typeNameLabel">BinarySearch</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></pre>
<div class="block">Binary search for the implementation of
RANGE BETWEEN XXX PRECEDING/FOLLOWING clause.</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="colFirst" scope="col">Modifier</th>
<th class="colLast" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected </code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/runtime/BinarySearch.html#BinarySearch--">BinarySearch</a></span>()</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="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 &lt;T,K&gt;&nbsp;int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/runtime/BinarySearch.html#lowerBound-T:A-K-org.apache.calcite.linq4j.function.Function1-java.util.Comparator-">lowerBound</a></span>(T[]&nbsp;a,
K&nbsp;key,
<a href="../../../../org/apache/calcite/linq4j/function/Function1.html" title="interface in org.apache.calcite.linq4j.function">Function1</a>&lt;T,K&gt;&nbsp;keySelector,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util">Comparator</a>&lt;K&gt;&nbsp;comparator)</code>
<div class="block">Performs binary search of the lower bound in the given array.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static &lt;T,K&gt;&nbsp;int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/runtime/BinarySearch.html#lowerBound-T:A-K-int-int-org.apache.calcite.linq4j.function.Function1-java.util.Comparator-">lowerBound</a></span>(T[]&nbsp;a,
K&nbsp;key,
int&nbsp;imin,
int&nbsp;imax,
<a href="../../../../org/apache/calcite/linq4j/function/Function1.html" title="interface in org.apache.calcite.linq4j.function">Function1</a>&lt;T,K&gt;&nbsp;keySelector,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util">Comparator</a>&lt;K&gt;&nbsp;comparator)</code>
<div class="block">Taken from http://en.wikipedia.org/wiki/Binary_search_algorithm
#Deferred_detection_of_equality</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>static &lt;T&gt;&nbsp;int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/runtime/BinarySearch.html#lowerBound-T:A-T-java.util.Comparator-">lowerBound</a></span>(T[]&nbsp;a,
T&nbsp;key,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util">Comparator</a>&lt;T&gt;&nbsp;comparator)</code>
<div class="block">Performs binary search of the lower bound in the given array.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>static &lt;T&gt;&nbsp;int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/runtime/BinarySearch.html#lowerBound-T:A-T-int-int-java.util.Comparator-">lowerBound</a></span>(T[]&nbsp;a,
T&nbsp;key,
int&nbsp;imin,
int&nbsp;imax,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util">Comparator</a>&lt;T&gt;&nbsp;comparator)</code>
<div class="block">Performs binary search of the lower bound in the given section of array.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>static &lt;T,K&gt;&nbsp;int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/runtime/BinarySearch.html#upperBound-T:A-K-org.apache.calcite.linq4j.function.Function1-java.util.Comparator-">upperBound</a></span>(T[]&nbsp;a,
K&nbsp;key,
<a href="../../../../org/apache/calcite/linq4j/function/Function1.html" title="interface in org.apache.calcite.linq4j.function">Function1</a>&lt;T,K&gt;&nbsp;keySelector,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util">Comparator</a>&lt;K&gt;&nbsp;comparator)</code>
<div class="block">Performs binary search of the upper bound in the given array.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>static &lt;T,K&gt;&nbsp;int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/runtime/BinarySearch.html#upperBound-T:A-K-int-int-org.apache.calcite.linq4j.function.Function1-java.util.Comparator-">upperBound</a></span>(T[]&nbsp;a,
K&nbsp;key,
int&nbsp;imin,
int&nbsp;imax,
<a href="../../../../org/apache/calcite/linq4j/function/Function1.html" title="interface in org.apache.calcite.linq4j.function">Function1</a>&lt;T,K&gt;&nbsp;keySelector,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util">Comparator</a>&lt;K&gt;&nbsp;comparator)</code>
<div class="block">Taken from http://en.wikipedia.org/wiki/Binary_search_algorithm
#Deferred_detection_of_equality
Adapted to find upper bound.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>static &lt;T&gt;&nbsp;int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/runtime/BinarySearch.html#upperBound-T:A-T-java.util.Comparator-">upperBound</a></span>(T[]&nbsp;a,
T&nbsp;key,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util">Comparator</a>&lt;T&gt;&nbsp;comparator)</code>
<div class="block">Performs binary search of the upper bound in the given array.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>static &lt;T&gt;&nbsp;int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/runtime/BinarySearch.html#upperBound-T:A-T-int-int-java.util.Comparator-">upperBound</a></span>(T[]&nbsp;a,
T&nbsp;key,
int&nbsp;imin,
int&nbsp;imax,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util">Comparator</a>&lt;T&gt;&nbsp;comparator)</code>
<div class="block">Performs binary search of the upper bound in the given array.</div>
</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="BinarySearch--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>BinarySearch</h4>
<pre>protected&nbsp;BinarySearch()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="lowerBound-java.lang.Object:A-java.lang.Object-java.util.Comparator-">
<!-- -->
</a><a name="lowerBound-T:A-T-java.util.Comparator-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>lowerBound</h4>
<pre>public static&nbsp;&lt;T&gt;&nbsp;int&nbsp;lowerBound(T[]&nbsp;a,
T&nbsp;key,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util">Comparator</a>&lt;T&gt;&nbsp;comparator)</pre>
<div class="block">Performs binary search of the lower bound in the given array.
It is assumed that the array is sorted.
The method is guaranteed to return the minimal index of the element that is
greater or equal to the given key.</div>
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>T</code> - the type of elements in array</dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>a</code> - array that holds the values</dd>
<dd><code>key</code> - element to look for</dd>
<dd><code>comparator</code> - comparator that compares keys</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>minimal index of the element that is
greater or equal to the given key. Returns -1 when all elements exceed
the given key or the array is empty. Returns <code>a.length</code> when all
elements are less than the given key.</dd>
</dl>
</li>
</ul>
<a name="upperBound-java.lang.Object:A-java.lang.Object-java.util.Comparator-">
<!-- -->
</a><a name="upperBound-T:A-T-java.util.Comparator-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>upperBound</h4>
<pre>public static&nbsp;&lt;T&gt;&nbsp;int&nbsp;upperBound(T[]&nbsp;a,
T&nbsp;key,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util">Comparator</a>&lt;T&gt;&nbsp;comparator)</pre>
<div class="block">Performs binary search of the upper bound in the given array.
It is assumed that the array is sorted.
The method is guaranteed to return the maximal index of the element that is
less or equal to the given key.</div>
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>T</code> - the type of elements in array</dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>a</code> - array that holds the values</dd>
<dd><code>key</code> - element to look for</dd>
<dd><code>comparator</code> - comparator that compares keys</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>maximal index of the element that is
less or equal to the given key. Returns -1 when all elements are less
than the given key or the array is empty. Returns <code>a.length</code> when
all elements exceed the given key.</dd>
</dl>
</li>
</ul>
<a name="lowerBound-java.lang.Object:A-java.lang.Object-org.apache.calcite.linq4j.function.Function1-java.util.Comparator-">
<!-- -->
</a><a name="lowerBound-T:A-K-org.apache.calcite.linq4j.function.Function1-java.util.Comparator-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>lowerBound</h4>
<pre>public static&nbsp;&lt;T,K&gt;&nbsp;int&nbsp;lowerBound(T[]&nbsp;a,
K&nbsp;key,
<a href="../../../../org/apache/calcite/linq4j/function/Function1.html" title="interface in org.apache.calcite.linq4j.function">Function1</a>&lt;T,K&gt;&nbsp;keySelector,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util">Comparator</a>&lt;K&gt;&nbsp;comparator)</pre>
<div class="block">Performs binary search of the lower bound in the given array.
The elements in the array are transformed before the comparison.
It is assumed that the array is sorted.
The method is guaranteed to return the minimal index of the element that is
greater or equal to the given key.</div>
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>T</code> - the type of elements in array</dd>
<dd><code>K</code> - the type of lookup key</dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>a</code> - array that holds the values</dd>
<dd><code>key</code> - element to look for</dd>
<dd><code>keySelector</code> - function that transforms array contents to the type
of the key</dd>
<dd><code>comparator</code> - comparator that compares keys</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>minimal index of the element that is
greater or equal to the given key. Returns -1 when all elements exceed
the given key or the array is empty. Returns <code>a.length</code> when all
elements are less than the given key.</dd>
</dl>
</li>
</ul>
<a name="upperBound-java.lang.Object:A-java.lang.Object-org.apache.calcite.linq4j.function.Function1-java.util.Comparator-">
<!-- -->
</a><a name="upperBound-T:A-K-org.apache.calcite.linq4j.function.Function1-java.util.Comparator-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>upperBound</h4>
<pre>public static&nbsp;&lt;T,K&gt;&nbsp;int&nbsp;upperBound(T[]&nbsp;a,
K&nbsp;key,
<a href="../../../../org/apache/calcite/linq4j/function/Function1.html" title="interface in org.apache.calcite.linq4j.function">Function1</a>&lt;T,K&gt;&nbsp;keySelector,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util">Comparator</a>&lt;K&gt;&nbsp;comparator)</pre>
<div class="block">Performs binary search of the upper bound in the given array.
The elements in the array are transformed before the comparison.
It is assumed that the array is sorted.
The method is guaranteed to return the maximal index of the element that is
less or equal to the given key.</div>
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>T</code> - the type of elements in array</dd>
<dd><code>K</code> - the type of lookup key</dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>a</code> - array that holds the values</dd>
<dd><code>key</code> - element to look for</dd>
<dd><code>keySelector</code> - function that transforms array contents to the type
of the key</dd>
<dd><code>comparator</code> - comparator that compares keys</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>maximal index of the element that is
less or equal to the given key. Returns -1 when all elements are less
than the given key or the array is empty. Returns <code>a.length</code> when
all elements exceed the given key.</dd>
</dl>
</li>
</ul>
<a name="lowerBound-java.lang.Object:A-java.lang.Object-int-int-java.util.Comparator-">
<!-- -->
</a><a name="lowerBound-T:A-T-int-int-java.util.Comparator-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>lowerBound</h4>
<pre>public static&nbsp;&lt;T&gt;&nbsp;int&nbsp;lowerBound(T[]&nbsp;a,
T&nbsp;key,
int&nbsp;imin,
int&nbsp;imax,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util">Comparator</a>&lt;T&gt;&nbsp;comparator)</pre>
<div class="block">Performs binary search of the lower bound in the given section of array.
It is assumed that the array is sorted.
The method is guaranteed to return the minimal index of the element that is
greater or equal to the given key.</div>
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>T</code> - the type of elements in array</dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>a</code> - array that holds the values</dd>
<dd><code>key</code> - element to look for</dd>
<dd><code>imin</code> - the minimal index (inclusive) to look for</dd>
<dd><code>imax</code> - the maximum index (inclusive) to look for</dd>
<dd><code>comparator</code> - comparator that compares keys</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>minimal index of the element that is
greater or equal to the given key. Returns -1 when all elements exceed
the given key or the array is empty. Returns <code>a.length</code> when all
elements are less than the given key.</dd>
</dl>
</li>
</ul>
<a name="upperBound-java.lang.Object:A-java.lang.Object-int-int-java.util.Comparator-">
<!-- -->
</a><a name="upperBound-T:A-T-int-int-java.util.Comparator-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>upperBound</h4>
<pre>public static&nbsp;&lt;T&gt;&nbsp;int&nbsp;upperBound(T[]&nbsp;a,
T&nbsp;key,
int&nbsp;imin,
int&nbsp;imax,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util">Comparator</a>&lt;T&gt;&nbsp;comparator)</pre>
<div class="block">Performs binary search of the upper bound in the given array.
It is assumed that the array is sorted.
The method is guaranteed to return the maximal index of the element that is
less or equal to the given key.</div>
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>T</code> - the type of elements in array</dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>a</code> - array that holds the values</dd>
<dd><code>key</code> - element to look for</dd>
<dd><code>imin</code> - the minimal index (inclusive) to look for</dd>
<dd><code>imax</code> - the maximum index (inclusive) to look for</dd>
<dd><code>comparator</code> - comparator that compares keys</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>maximal index of the element that is
less or equal to the given key. Returns -1 when all elements are less
than the given key or the array is empty. Returns <code>a.length</code> when
all elements exceed the given key.</dd>
</dl>
</li>
</ul>
<a name="lowerBound-java.lang.Object:A-java.lang.Object-int-int-org.apache.calcite.linq4j.function.Function1-java.util.Comparator-">
<!-- -->
</a><a name="lowerBound-T:A-K-int-int-org.apache.calcite.linq4j.function.Function1-java.util.Comparator-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>lowerBound</h4>
<pre>public static&nbsp;&lt;T,K&gt;&nbsp;int&nbsp;lowerBound(T[]&nbsp;a,
K&nbsp;key,
int&nbsp;imin,
int&nbsp;imax,
<a href="../../../../org/apache/calcite/linq4j/function/Function1.html" title="interface in org.apache.calcite.linq4j.function">Function1</a>&lt;T,K&gt;&nbsp;keySelector,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util">Comparator</a>&lt;K&gt;&nbsp;comparator)</pre>
<div class="block">Taken from http://en.wikipedia.org/wiki/Binary_search_algorithm
#Deferred_detection_of_equality</div>
</li>
</ul>
<a name="upperBound-java.lang.Object:A-java.lang.Object-int-int-org.apache.calcite.linq4j.function.Function1-java.util.Comparator-">
<!-- -->
</a><a name="upperBound-T:A-K-int-int-org.apache.calcite.linq4j.function.Function1-java.util.Comparator-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>upperBound</h4>
<pre>public static&nbsp;&lt;T,K&gt;&nbsp;int&nbsp;upperBound(T[]&nbsp;a,
K&nbsp;key,
int&nbsp;imin,
int&nbsp;imax,
<a href="../../../../org/apache/calcite/linq4j/function/Function1.html" title="interface in org.apache.calcite.linq4j.function">Function1</a>&lt;T,K&gt;&nbsp;keySelector,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util">Comparator</a>&lt;K&gt;&nbsp;comparator)</pre>
<div class="block">Taken from http://en.wikipedia.org/wiki/Binary_search_algorithm
#Deferred_detection_of_equality
Adapted to find upper bound.</div>
</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="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 class="aboutLanguage"><b>Apache Calcite</b></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/apache/calcite/runtime/AutomatonBuilder.html" title="class in org.apache.calcite.runtime"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/calcite/runtime/Bindable.html" title="interface in org.apache.calcite.runtime"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/calcite/runtime/BinarySearch.html" target="_top">Frames</a></li>
<li><a href="BinarySearch.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 &copy; 2012-2020 Apache Software Foundation. All Rights Reserved.</small></p>
</body>
</html>