blob: 5dc5721fda9994e7e618ba041ba48b4b20a4e2d0 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>BinarySearch (Apache Calcite API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<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.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="../../../../script-dir/jquery-3.5.1.min.js"></script>
<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script>
</head>
<body class="class-declaration-page">
<script type="text/javascript">var evenRowColor = "even-row-color";
var oddRowColor = "odd-row-color";
var tableTab = "table-tab";
var activeTableTab = "active-table-tab";
var pathtoroot = "../../../../";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flex-box">
<header role="banner" class="flex-header">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="top-nav" id="navbar-top">
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<div class="about-language"><b>Apache Calcite</b></div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="nav-bar-cell1-rev">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#class">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<div>
<ul class="sub-nav-list">
<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="sub-nav-list">
<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="nav-list-search"><label for="search-input">SEARCH:</label>
<input type="text" id="search-input" value="search" disabled="disabled">
<input type="reset" id="reset-button" value="reset" disabled="disabled">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip-navbar-top"></span></nav>
</header>
<div class="flex-content">
<main role="main">
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="sub-title"><span class="package-label-in-type">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="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
<div class="inheritance">org.apache.calcite.runtime.BinarySearch</div>
</div>
<section class="class-description" id="class-description">
<hr>
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">BinarySearch</span>
<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div>
<div class="block">Binary search for the implementation of
RANGE BETWEEN XXX PRECEDING/FOLLOWING clause.</div>
</section>
<section class="summary">
<ul class="summary-list">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<li>
<section class="constructor-summary" id="constructor-summary">
<h2>Constructor Summary</h2>
<div class="caption"><span>Constructors</span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier</div>
<div class="table-header col-second">Constructor</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>protected </code></div>
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">BinarySearch</a>()</code></div>
<div class="col-last even-row-color">&nbsp;</div>
</div>
</section>
</li>
<!-- ========== METHOD SUMMARY =========== -->
<li>
<section class="method-summary" id="method-summary">
<h2>Method Summary</h2>
<div id="method-summary-table">
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div>
<div id="method-summary-table.tabpanel" role="tabpanel">
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static &lt;T,<wbr>
K&gt;&nbsp;int</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#lowerBound(T%5B%5D,K,int,int,org.apache.calcite.linq4j.function.Function1,java.util.Comparator)" class="member-name-link">lowerBound</a><wbr>(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,<wbr>K&gt;&nbsp;keySelector,
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Comparator.html" title="class or interface in java.util" class="external-link">Comparator</a>&lt;K&gt;&nbsp;comparator)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Taken from http://en.wikipedia.org/wiki/Binary_search_algorithm
#Deferred_detection_of_equality</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static &lt;T,<wbr>
K&gt;&nbsp;int</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#lowerBound(T%5B%5D,K,org.apache.calcite.linq4j.function.Function1,java.util.Comparator)" class="member-name-link">lowerBound</a><wbr>(T[]&nbsp;a,
K&nbsp;key,
<a href="../linq4j/function/Function1.html" title="interface in org.apache.calcite.linq4j.function">Function1</a>&lt;T,<wbr>K&gt;&nbsp;keySelector,
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Comparator.html" title="class or interface in java.util" class="external-link">Comparator</a>&lt;K&gt;&nbsp;comparator)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Performs binary search of the lower bound in the given array.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static &lt;T&gt;&nbsp;int</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#lowerBound(T%5B%5D,T,int,int,java.util.Comparator)" class="member-name-link">lowerBound</a><wbr>(T[]&nbsp;a,
T&nbsp;key,
int&nbsp;imin,
int&nbsp;imax,
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Comparator.html" title="class or interface in java.util" class="external-link">Comparator</a>&lt;T&gt;&nbsp;comparator)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Performs binary search of the lower bound in the given section of array.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static &lt;T&gt;&nbsp;int</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#lowerBound(T%5B%5D,T,java.util.Comparator)" class="member-name-link">lowerBound</a><wbr>(T[]&nbsp;a,
T&nbsp;key,
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Comparator.html" title="class or interface in java.util" class="external-link">Comparator</a>&lt;T&gt;&nbsp;comparator)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Performs binary search of the lower bound in the given array.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static &lt;T,<wbr>
K&gt;&nbsp;int</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#upperBound(T%5B%5D,K,int,int,org.apache.calcite.linq4j.function.Function1,java.util.Comparator)" class="member-name-link">upperBound</a><wbr>(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,<wbr>K&gt;&nbsp;keySelector,
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Comparator.html" title="class or interface in java.util" class="external-link">Comparator</a>&lt;K&gt;&nbsp;comparator)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Taken from http://en.wikipedia.org/wiki/Binary_search_algorithm
#Deferred_detection_of_equality
Adapted to find upper bound.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static &lt;T,<wbr>
K&gt;&nbsp;int</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#upperBound(T%5B%5D,K,org.apache.calcite.linq4j.function.Function1,java.util.Comparator)" class="member-name-link">upperBound</a><wbr>(T[]&nbsp;a,
K&nbsp;key,
<a href="../linq4j/function/Function1.html" title="interface in org.apache.calcite.linq4j.function">Function1</a>&lt;T,<wbr>K&gt;&nbsp;keySelector,
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Comparator.html" title="class or interface in java.util" class="external-link">Comparator</a>&lt;K&gt;&nbsp;comparator)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Performs binary search of the upper bound in the given array.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static &lt;T&gt;&nbsp;int</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#upperBound(T%5B%5D,T,int,int,java.util.Comparator)" class="member-name-link">upperBound</a><wbr>(T[]&nbsp;a,
T&nbsp;key,
int&nbsp;imin,
int&nbsp;imax,
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Comparator.html" title="class or interface in java.util" class="external-link">Comparator</a>&lt;T&gt;&nbsp;comparator)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Performs binary search of the upper bound in the given array.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static &lt;T&gt;&nbsp;int</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#upperBound(T%5B%5D,T,java.util.Comparator)" class="member-name-link">upperBound</a><wbr>(T[]&nbsp;a,
T&nbsp;key,
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Comparator.html" title="class or interface in java.util" class="external-link">Comparator</a>&lt;T&gt;&nbsp;comparator)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Performs binary search of the upper bound in the given array.</div>
</div>
</div>
</div>
</div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="details-list">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<li>
<section class="constructor-details" id="constructor-detail">
<h2>Constructor Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="&lt;init&gt;()">
<h3>BinarySearch</h3>
<div class="member-signature"><span class="modifiers">protected</span>&nbsp;<span class="element-name">BinarySearch</span>()</div>
</section>
</li>
</ul>
</section>
</li>
<!-- ============ METHOD DETAIL ========== -->
<li>
<section class="method-details" id="method-detail">
<h2>Method Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="lowerBound(T[],T,java.util.Comparator)">
<h3 id="lowerBound(java.lang.Object[],java.lang.Object,java.util.Comparator)">lowerBound</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="type-parameters">&lt;T&gt;</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">lowerBound</span><wbr><span class="parameters">(T[]&nbsp;a,
T&nbsp;key,
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Comparator.html" title="class or interface in java.util" class="external-link">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 class="notes">
<dt>Type Parameters:</dt>
<dd><code>T</code> - the type of elements in array</dd>
<dt>Parameters:</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>Returns:</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>
<section class="detail" id="upperBound(T[],T,java.util.Comparator)">
<h3 id="upperBound(java.lang.Object[],java.lang.Object,java.util.Comparator)">upperBound</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="type-parameters">&lt;T&gt;</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">upperBound</span><wbr><span class="parameters">(T[]&nbsp;a,
T&nbsp;key,
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Comparator.html" title="class or interface in java.util" class="external-link">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 class="notes">
<dt>Type Parameters:</dt>
<dd><code>T</code> - the type of elements in array</dd>
<dt>Parameters:</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>Returns:</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>
<section class="detail" id="lowerBound(T[],K,org.apache.calcite.linq4j.function.Function1,java.util.Comparator)">
<h3 id="lowerBound(java.lang.Object[],java.lang.Object,org.apache.calcite.linq4j.function.Function1,java.util.Comparator)">lowerBound</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="type-parameters">&lt;T,<wbr>
K&gt;</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">lowerBound</span><wbr><span class="parameters">(T[]&nbsp;a,
K&nbsp;key,
<a href="../linq4j/function/Function1.html" title="interface in org.apache.calcite.linq4j.function">Function1</a>&lt;T,<wbr>K&gt;&nbsp;keySelector,
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Comparator.html" title="class or interface in java.util" class="external-link">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 class="notes">
<dt>Type Parameters:</dt>
<dd><code>T</code> - the type of elements in array</dd>
<dd><code>K</code> - the type of lookup key</dd>
<dt>Parameters:</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>Returns:</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>
<section class="detail" id="upperBound(T[],K,org.apache.calcite.linq4j.function.Function1,java.util.Comparator)">
<h3 id="upperBound(java.lang.Object[],java.lang.Object,org.apache.calcite.linq4j.function.Function1,java.util.Comparator)">upperBound</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="type-parameters">&lt;T,<wbr>
K&gt;</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">upperBound</span><wbr><span class="parameters">(T[]&nbsp;a,
K&nbsp;key,
<a href="../linq4j/function/Function1.html" title="interface in org.apache.calcite.linq4j.function">Function1</a>&lt;T,<wbr>K&gt;&nbsp;keySelector,
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Comparator.html" title="class or interface in java.util" class="external-link">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 class="notes">
<dt>Type Parameters:</dt>
<dd><code>T</code> - the type of elements in array</dd>
<dd><code>K</code> - the type of lookup key</dd>
<dt>Parameters:</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>Returns:</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>
<section class="detail" id="lowerBound(T[],T,int,int,java.util.Comparator)">
<h3 id="lowerBound(java.lang.Object[],java.lang.Object,int,int,java.util.Comparator)">lowerBound</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="type-parameters">&lt;T&gt;</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">lowerBound</span><wbr><span class="parameters">(T[]&nbsp;a,
T&nbsp;key,
int&nbsp;imin,
int&nbsp;imax,
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Comparator.html" title="class or interface in java.util" class="external-link">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 class="notes">
<dt>Type Parameters:</dt>
<dd><code>T</code> - the type of elements in array</dd>
<dt>Parameters:</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>Returns:</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>
<section class="detail" id="upperBound(T[],T,int,int,java.util.Comparator)">
<h3 id="upperBound(java.lang.Object[],java.lang.Object,int,int,java.util.Comparator)">upperBound</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="type-parameters">&lt;T&gt;</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">upperBound</span><wbr><span class="parameters">(T[]&nbsp;a,
T&nbsp;key,
int&nbsp;imin,
int&nbsp;imax,
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Comparator.html" title="class or interface in java.util" class="external-link">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 class="notes">
<dt>Type Parameters:</dt>
<dd><code>T</code> - the type of elements in array</dd>
<dt>Parameters:</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>Returns:</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>
<section class="detail" id="lowerBound(T[],K,int,int,org.apache.calcite.linq4j.function.Function1,java.util.Comparator)">
<h3 id="lowerBound(java.lang.Object[],java.lang.Object,int,int,org.apache.calcite.linq4j.function.Function1,java.util.Comparator)">lowerBound</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="type-parameters">&lt;T,<wbr>
K&gt;</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">lowerBound</span><wbr><span class="parameters">(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,<wbr>K&gt;&nbsp;keySelector,
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Comparator.html" title="class or interface in java.util" class="external-link">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>
<section class="detail" id="upperBound(T[],K,int,int,org.apache.calcite.linq4j.function.Function1,java.util.Comparator)">
<h3 id="upperBound(java.lang.Object[],java.lang.Object,int,int,org.apache.calcite.linq4j.function.Function1,java.util.Comparator)">upperBound</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="type-parameters">&lt;T,<wbr>
K&gt;</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">upperBound</span><wbr><span class="parameters">(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,<wbr>K&gt;&nbsp;keySelector,
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Comparator.html" title="class or interface in java.util" class="external-link">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>
<!-- ========= END OF CLASS DATA ========= -->
</main>
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small>Copyright &copy; 2012-2023 Apache Software Foundation. All Rights Reserved.</small></p>
</footer>
</div>
</div>
</body>
</html>