blob: 3858f6411f2e132eb04b343d728fa6a41efdb9c9 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>BinarySearch (Apache Calcite calcite API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="description" content="declaration: package: org.apache.calcite.runtime, class: BinarySearch">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
<script type="text/javascript" src="../../../../script-dir/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../script-dir/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../script-dir/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../script-dir/jquery-3.4.1.js"></script>
<script type="text/javascript" src="../../../../script-dir/jquery-ui.js"></script>
</head>
<body class="class-declaration">
<script type="text/javascript">var data = {"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";
var pathtoroot = "../../../../";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flexBox">
<header role="banner" class="flexHeader">
<nav role="navigation">
<!-- ========= 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="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">
<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>
<div class="navListSearch"><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="skipNav"><a id="skip.navbar.top">
<!-- -->
</a></div>
</nav>
</header>
<div class="flexContent">
<main role="main">
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.apache.calcite.runtime</a></div>
<h1 title="Class BinarySearch" class="title">Class BinarySearch</h1>
</div>
<div class="contentContainer">
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">java.lang.Object</a>
<div class="inheritance">org.apache.calcite.runtime.BinarySearch</div>
</div>
<section class="description">
<hr>
<pre>public class <span class="typeNameLabel">BinarySearch</span>
extends <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></pre>
<div class="block">Binary search for the implementation of
RANGE BETWEEN XXX PRECEDING/FOLLOWING clause.</div>
</section>
<section class="summary">
<ul class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<li class="blockList">
<section class="constructorSummary"><a id="constructor.summary">
<!-- -->
</a>
<h2>Constructor Summary</h2>
<div class="memberSummary">
<table>
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<thead>
<tr>
<th class="colFirst" scope="col">Modifier</th>
<th class="colSecond" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
</thead>
<tbody>
<tr class="altColor">
<td class="colFirst"><code>protected </code></td>
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E()">BinarySearch</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
</table>
</div>
</section>
</li>
<!-- ========== METHOD SUMMARY =========== -->
<li class="blockList">
<section class="methodSummary"><a id="method.summary">
<!-- -->
</a>
<h2>Method Summary</h2>
<div class="memberSummary">
<div role="tablist" aria-orientation="horizontal"><button role="tab" aria-selected="true" aria-controls="memberSummary_tabpanel" tabindex="0" onkeydown="switchTab(event)" id="t0" class="activeTableTab">All Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t1" class="tableTab" onclick="show(1);">Static Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t4" class="tableTab" onclick="show(8);">Concrete Methods</button></div>
<div id="memberSummary_tabpanel" role="tabpanel">
<table aria-labelledby="t0">
<thead>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
</thead>
<tbody>
<tr class="altColor" id="i0">
<td class="colFirst"><code>static &lt;T,&#8203;
K&gt;&nbsp;int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#lowerBound(T%5B%5D,K,int,int,org.apache.calcite.linq4j.function.Function1,java.util.Comparator)">lowerBound</a></span>&#8203;(T[]&nbsp;a,
K&nbsp;key,
int&nbsp;imin,
int&nbsp;imax,
<a href="../linq4j/function/Function1.html" title="interface in org.apache.calcite.linq4j.function">Function1</a>&lt;T,&#8203;K&gt;&nbsp;keySelector,
<a href="https://docs.oracle.com/javase/9/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util" class="externalLink">Comparator</a>&lt;K&gt;&nbsp;comparator)</code></th>
<td class="colLast">
<div class="block">Taken from http://en.wikipedia.org/wiki/Binary_search_algorithm
#Deferred_detection_of_equality</div>
</td>
</tr>
<tr class="rowColor" id="i1">
<td class="colFirst"><code>static &lt;T,&#8203;
K&gt;&nbsp;int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#lowerBound(T%5B%5D,K,org.apache.calcite.linq4j.function.Function1,java.util.Comparator)">lowerBound</a></span>&#8203;(T[]&nbsp;a,
K&nbsp;key,
<a href="../linq4j/function/Function1.html" title="interface in org.apache.calcite.linq4j.function">Function1</a>&lt;T,&#8203;K&gt;&nbsp;keySelector,
<a href="https://docs.oracle.com/javase/9/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util" class="externalLink">Comparator</a>&lt;K&gt;&nbsp;comparator)</code></th>
<td class="colLast">
<div class="block">Performs binary search of the lower bound in the given array.</div>
</td>
</tr>
<tr class="altColor" id="i2">
<td class="colFirst"><code>static &lt;T&gt;&nbsp;int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#lowerBound(T%5B%5D,T,int,int,java.util.Comparator)">lowerBound</a></span>&#8203;(T[]&nbsp;a,
T&nbsp;key,
int&nbsp;imin,
int&nbsp;imax,
<a href="https://docs.oracle.com/javase/9/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util" class="externalLink">Comparator</a>&lt;T&gt;&nbsp;comparator)</code></th>
<td class="colLast">
<div class="block">Performs binary search of the lower bound in the given section of array.</div>
</td>
</tr>
<tr class="rowColor" id="i3">
<td class="colFirst"><code>static &lt;T&gt;&nbsp;int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#lowerBound(T%5B%5D,T,java.util.Comparator)">lowerBound</a></span>&#8203;(T[]&nbsp;a,
T&nbsp;key,
<a href="https://docs.oracle.com/javase/9/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util" class="externalLink">Comparator</a>&lt;T&gt;&nbsp;comparator)</code></th>
<td class="colLast">
<div class="block">Performs binary search of the lower bound in the given array.</div>
</td>
</tr>
<tr class="altColor" id="i4">
<td class="colFirst"><code>static &lt;T,&#8203;
K&gt;&nbsp;int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#upperBound(T%5B%5D,K,int,int,org.apache.calcite.linq4j.function.Function1,java.util.Comparator)">upperBound</a></span>&#8203;(T[]&nbsp;a,
K&nbsp;key,
int&nbsp;imin,
int&nbsp;imax,
<a href="../linq4j/function/Function1.html" title="interface in org.apache.calcite.linq4j.function">Function1</a>&lt;T,&#8203;K&gt;&nbsp;keySelector,
<a href="https://docs.oracle.com/javase/9/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util" class="externalLink">Comparator</a>&lt;K&gt;&nbsp;comparator)</code></th>
<td class="colLast">
<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 class="rowColor" id="i5">
<td class="colFirst"><code>static &lt;T,&#8203;
K&gt;&nbsp;int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#upperBound(T%5B%5D,K,org.apache.calcite.linq4j.function.Function1,java.util.Comparator)">upperBound</a></span>&#8203;(T[]&nbsp;a,
K&nbsp;key,
<a href="../linq4j/function/Function1.html" title="interface in org.apache.calcite.linq4j.function">Function1</a>&lt;T,&#8203;K&gt;&nbsp;keySelector,
<a href="https://docs.oracle.com/javase/9/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util" class="externalLink">Comparator</a>&lt;K&gt;&nbsp;comparator)</code></th>
<td class="colLast">
<div class="block">Performs binary search of the upper bound in the given array.</div>
</td>
</tr>
<tr class="altColor" id="i6">
<td class="colFirst"><code>static &lt;T&gt;&nbsp;int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#upperBound(T%5B%5D,T,int,int,java.util.Comparator)">upperBound</a></span>&#8203;(T[]&nbsp;a,
T&nbsp;key,
int&nbsp;imin,
int&nbsp;imax,
<a href="https://docs.oracle.com/javase/9/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util" class="externalLink">Comparator</a>&lt;T&gt;&nbsp;comparator)</code></th>
<td class="colLast">
<div class="block">Performs binary search of the upper bound in the given array.</div>
</td>
</tr>
<tr class="rowColor" id="i7">
<td class="colFirst"><code>static &lt;T&gt;&nbsp;int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#upperBound(T%5B%5D,T,java.util.Comparator)">upperBound</a></span>&#8203;(T[]&nbsp;a,
T&nbsp;key,
<a href="https://docs.oracle.com/javase/9/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util" class="externalLink">Comparator</a>&lt;T&gt;&nbsp;comparator)</code></th>
<td class="colLast">
<div class="block">Performs binary search of the upper bound in the given array.</div>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="inheritedList">
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></h3>
<a id="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a><code><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang" class="externalLink">clone</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang" class="externalLink">equals</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang" class="externalLink">finalize</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang" class="externalLink">getClass</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang" class="externalLink">hashCode</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang" class="externalLink">notify</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang" class="externalLink">notifyAll</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang" class="externalLink">toString</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#wait(long,int)" title="class or interface in java.lang" class="externalLink">wait</a></code></div>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<li class="blockList">
<section class="constructorDetails"><a id="constructor.detail">
<!-- -->
</a>
<h2>Constructor Details</h2>
<ul class="blockList">
<li class="blockList">
<section class="detail">
<h3><a id="&lt;init&gt;()">BinarySearch</a></h3>
<div class="memberSignature"><span class="modifiers">protected</span>&nbsp;<span class="memberName">BinarySearch</span>()</div>
</section>
</li>
</ul>
</section>
</li>
<!-- ============ METHOD DETAIL ========== -->
<li class="blockList">
<section class="methodDetails"><a id="method.detail">
<!-- -->
</a>
<h2>Method Details</h2>
<ul class="blockList">
<li class="blockList">
<section class="detail">
<h3><a id="lowerBound(java.lang.Object[],java.lang.Object,java.util.Comparator)">
<!-- -->
</a><a id="lowerBound(T[],T,java.util.Comparator)">lowerBound</a></h3>
<div class="memberSignature"><span class="modifiers">public static</span>&nbsp;<span class="typeParameters">&lt;T&gt;</span>&nbsp;<span class="returnType">int</span>&nbsp;<span class="memberName">lowerBound</span>&#8203;(<span class="arguments">T[]&nbsp;a,
T&nbsp;key,
<a href="https://docs.oracle.com/javase/9/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util" class="externalLink">Comparator</a>&lt;T&gt;&nbsp;comparator)</span></div>
<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>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="upperBound(java.lang.Object[],java.lang.Object,java.util.Comparator)">
<!-- -->
</a><a id="upperBound(T[],T,java.util.Comparator)">upperBound</a></h3>
<div class="memberSignature"><span class="modifiers">public static</span>&nbsp;<span class="typeParameters">&lt;T&gt;</span>&nbsp;<span class="returnType">int</span>&nbsp;<span class="memberName">upperBound</span>&#8203;(<span class="arguments">T[]&nbsp;a,
T&nbsp;key,
<a href="https://docs.oracle.com/javase/9/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util" class="externalLink">Comparator</a>&lt;T&gt;&nbsp;comparator)</span></div>
<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>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="lowerBound(java.lang.Object[],java.lang.Object,org.apache.calcite.linq4j.function.Function1,java.util.Comparator)">
<!-- -->
</a><a id="lowerBound(T[],K,org.apache.calcite.linq4j.function.Function1,java.util.Comparator)">lowerBound</a></h3>
<div class="memberSignature"><span class="modifiers">public static</span>&nbsp;<span class="typeParameters">&lt;T,&#8203;
K&gt;</span>&nbsp;<span class="returnType">int</span>&nbsp;<span class="memberName">lowerBound</span>&#8203;(<span class="arguments">T[]&nbsp;a,
K&nbsp;key,
<a href="../linq4j/function/Function1.html" title="interface in org.apache.calcite.linq4j.function">Function1</a>&lt;T,&#8203;K&gt;&nbsp;keySelector,
<a href="https://docs.oracle.com/javase/9/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util" class="externalLink">Comparator</a>&lt;K&gt;&nbsp;comparator)</span></div>
<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>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="upperBound(java.lang.Object[],java.lang.Object,org.apache.calcite.linq4j.function.Function1,java.util.Comparator)">
<!-- -->
</a><a id="upperBound(T[],K,org.apache.calcite.linq4j.function.Function1,java.util.Comparator)">upperBound</a></h3>
<div class="memberSignature"><span class="modifiers">public static</span>&nbsp;<span class="typeParameters">&lt;T,&#8203;
K&gt;</span>&nbsp;<span class="returnType">int</span>&nbsp;<span class="memberName">upperBound</span>&#8203;(<span class="arguments">T[]&nbsp;a,
K&nbsp;key,
<a href="../linq4j/function/Function1.html" title="interface in org.apache.calcite.linq4j.function">Function1</a>&lt;T,&#8203;K&gt;&nbsp;keySelector,
<a href="https://docs.oracle.com/javase/9/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util" class="externalLink">Comparator</a>&lt;K&gt;&nbsp;comparator)</span></div>
<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>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="lowerBound(java.lang.Object[],java.lang.Object,int,int,java.util.Comparator)">
<!-- -->
</a><a id="lowerBound(T[],T,int,int,java.util.Comparator)">lowerBound</a></h3>
<div class="memberSignature"><span class="modifiers">public static</span>&nbsp;<span class="typeParameters">&lt;T&gt;</span>&nbsp;<span class="returnType">int</span>&nbsp;<span class="memberName">lowerBound</span>&#8203;(<span class="arguments">T[]&nbsp;a,
T&nbsp;key,
int&nbsp;imin,
int&nbsp;imax,
<a href="https://docs.oracle.com/javase/9/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util" class="externalLink">Comparator</a>&lt;T&gt;&nbsp;comparator)</span></div>
<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>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="upperBound(java.lang.Object[],java.lang.Object,int,int,java.util.Comparator)">
<!-- -->
</a><a id="upperBound(T[],T,int,int,java.util.Comparator)">upperBound</a></h3>
<div class="memberSignature"><span class="modifiers">public static</span>&nbsp;<span class="typeParameters">&lt;T&gt;</span>&nbsp;<span class="returnType">int</span>&nbsp;<span class="memberName">upperBound</span>&#8203;(<span class="arguments">T[]&nbsp;a,
T&nbsp;key,
int&nbsp;imin,
int&nbsp;imax,
<a href="https://docs.oracle.com/javase/9/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util" class="externalLink">Comparator</a>&lt;T&gt;&nbsp;comparator)</span></div>
<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>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="lowerBound(java.lang.Object[],java.lang.Object,int,int,org.apache.calcite.linq4j.function.Function1,java.util.Comparator)">
<!-- -->
</a><a id="lowerBound(T[],K,int,int,org.apache.calcite.linq4j.function.Function1,java.util.Comparator)">lowerBound</a></h3>
<div class="memberSignature"><span class="modifiers">public static</span>&nbsp;<span class="typeParameters">&lt;T,&#8203;
K&gt;</span>&nbsp;<span class="returnType">int</span>&nbsp;<span class="memberName">lowerBound</span>&#8203;(<span class="arguments">T[]&nbsp;a,
K&nbsp;key,
int&nbsp;imin,
int&nbsp;imax,
<a href="../linq4j/function/Function1.html" title="interface in org.apache.calcite.linq4j.function">Function1</a>&lt;T,&#8203;K&gt;&nbsp;keySelector,
<a href="https://docs.oracle.com/javase/9/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util" class="externalLink">Comparator</a>&lt;K&gt;&nbsp;comparator)</span></div>
<div class="block">Taken from http://en.wikipedia.org/wiki/Binary_search_algorithm
#Deferred_detection_of_equality</div>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="upperBound(java.lang.Object[],java.lang.Object,int,int,org.apache.calcite.linq4j.function.Function1,java.util.Comparator)">
<!-- -->
</a><a id="upperBound(T[],K,int,int,org.apache.calcite.linq4j.function.Function1,java.util.Comparator)">upperBound</a></h3>
<div class="memberSignature"><span class="modifiers">public static</span>&nbsp;<span class="typeParameters">&lt;T,&#8203;
K&gt;</span>&nbsp;<span class="returnType">int</span>&nbsp;<span class="memberName">upperBound</span>&#8203;(<span class="arguments">T[]&nbsp;a,
K&nbsp;key,
int&nbsp;imin,
int&nbsp;imax,
<a href="../linq4j/function/Function1.html" title="interface in org.apache.calcite.linq4j.function">Function1</a>&lt;T,&#8203;K&gt;&nbsp;keySelector,
<a href="https://docs.oracle.com/javase/9/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util" class="externalLink">Comparator</a>&lt;K&gt;&nbsp;comparator)</span></div>
<div class="block">Taken from http://en.wikipedia.org/wiki/Binary_search_algorithm
#Deferred_detection_of_equality
Adapted to find upper bound.</div>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
</div>
<!-- ========= END OF CLASS DATA ========= -->
</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="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">
<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>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Copyright &copy; 2012-2021 Apache Software Foundation. All Rights Reserved.</small></p>
</footer>
</div>
</div>
</body>
</html>