blob: ea37bb861a3f774ab34cc5cf52b22d212db4ef55 [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 (1.8.0_162) on Thu Mar 14 13:13:08 PDT 2019 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>QuickSelect (com.yahoo.datasketches:sketches-core 0.13.1-SNAPSHOT API)</title>
<meta name="date" content="2019-03-14">
<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="QuickSelect (com.yahoo.datasketches:sketches-core 0.13.1-SNAPSHOT API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9,"i5":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="class-use/QuickSelect.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="../../../com/yahoo/sketches/QuantilesHelper.html" title="class in com.yahoo.sketches"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../com/yahoo/sketches/ResizeFactor.html" title="enum in com.yahoo.sketches"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?com/yahoo/sketches/QuickSelect.html" target="_top">Frames</a></li>
<li><a href="QuickSelect.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>Constr&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>Constr&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">com.yahoo.sketches</div>
<h2 title="Class QuickSelect" class="title">Class QuickSelect</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>com.yahoo.sketches.QuickSelect</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public final class <span class="typeNameLabel">QuickSelect</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">QuickSelect algorithm improved from Sedgewick. Gets the kth order value
(1-based or 0-based) from the array.
Warning! This changes the ordering of elements in the given array!<br>
Also see:<br>
blog.teamleadnet.com/2012/07/quick-select-algorithm-find-kth-element.html<br>
See QuickSelectTest for examples and testNG tests.</div>
<dl>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>Lee Rhodes</dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== 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 double</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/yahoo/sketches/QuickSelect.html#select-double:A-int-int-int-">select</a></span>(double[]&nbsp;arr,
int&nbsp;lo,
int&nbsp;hi,
int&nbsp;pivot)</code>
<div class="block">Gets the 0-based kth order statistic from the array.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/yahoo/sketches/QuickSelect.html#select-long:A-int-int-int-">select</a></span>(long[]&nbsp;arr,
int&nbsp;lo,
int&nbsp;hi,
int&nbsp;pivot)</code>
<div class="block">Gets the 0-based kth order statistic from the array.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>static double</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/yahoo/sketches/QuickSelect.html#selectExcludingZeros-double:A-int-int-">selectExcludingZeros</a></span>(double[]&nbsp;arr,
int&nbsp;nonZeros,
int&nbsp;pivot)</code>
<div class="block">Gets the 1-based kth order statistic from the array excluding any zero values in the
array.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>static long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/yahoo/sketches/QuickSelect.html#selectExcludingZeros-long:A-int-int-">selectExcludingZeros</a></span>(long[]&nbsp;arr,
int&nbsp;nonZeros,
int&nbsp;pivot)</code>
<div class="block">Gets the 1-based kth order statistic from the array excluding any zero values in the
array.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>static double</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/yahoo/sketches/QuickSelect.html#selectIncludingZeros-double:A-int-">selectIncludingZeros</a></span>(double[]&nbsp;arr,
int&nbsp;pivot)</code>
<div class="block">Gets the 1-based kth order statistic from the array including any zero values in the
array.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>static long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/yahoo/sketches/QuickSelect.html#selectIncludingZeros-long:A-int-">selectIncludingZeros</a></span>(long[]&nbsp;arr,
int&nbsp;pivot)</code>
<div class="block">Gets the 1-based kth order statistic from the array including any zero values in the
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">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="select-long:A-int-int-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>select</h4>
<pre>public static&nbsp;long&nbsp;select(long[]&nbsp;arr,
int&nbsp;lo,
int&nbsp;hi,
int&nbsp;pivot)</pre>
<div class="block">Gets the 0-based kth order statistic from the array. Warning! This changes the ordering
of elements in the given array!</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>arr</code> - The array to be re-arranged.</dd>
<dd><code>lo</code> - The lowest 0-based index to be considered.</dd>
<dd><code>hi</code> - The highest 0-based index to be considered.</dd>
<dd><code>pivot</code> - The 0-based index of the value to pivot on.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The value of the smallest (n)th element where n is 0-based.</dd>
</dl>
</li>
</ul>
<a name="selectIncludingZeros-long:A-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>selectIncludingZeros</h4>
<pre>public static&nbsp;long&nbsp;selectIncludingZeros(long[]&nbsp;arr,
int&nbsp;pivot)</pre>
<div class="block">Gets the 1-based kth order statistic from the array including any zero values in the
array. Warning! This changes the ordering of elements in the given array!</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>arr</code> - The hash array.</dd>
<dd><code>pivot</code> - The 1-based index of the value that is chosen as the pivot for the array.
After the operation all values below this 1-based index will be less than this value
and all values above this index will be greater. The 0-based index of the pivot will be
pivot-1.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The value of the smallest (N)th element including zeros, where N is 1-based.</dd>
</dl>
</li>
</ul>
<a name="selectExcludingZeros-long:A-int-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>selectExcludingZeros</h4>
<pre>public static&nbsp;long&nbsp;selectExcludingZeros(long[]&nbsp;arr,
int&nbsp;nonZeros,
int&nbsp;pivot)</pre>
<div class="block">Gets the 1-based kth order statistic from the array excluding any zero values in the
array. Warning! This changes the ordering of elements in the given array!</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>arr</code> - The hash array.</dd>
<dd><code>nonZeros</code> - The number of non-zero values in the array.</dd>
<dd><code>pivot</code> - The 1-based index of the value that is chosen as the pivot for the array.
After the operation all values below this 1-based index will be less than this value
and all values above this index will be greater. The 0-based index of the pivot will be
pivot+arr.length-nonZeros-1.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The value of the smallest (N)th element excluding zeros, where N is 1-based.</dd>
</dl>
</li>
</ul>
<a name="select-double:A-int-int-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>select</h4>
<pre>public static&nbsp;double&nbsp;select(double[]&nbsp;arr,
int&nbsp;lo,
int&nbsp;hi,
int&nbsp;pivot)</pre>
<div class="block">Gets the 0-based kth order statistic from the array. Warning! This changes the ordering
of elements in the given array!</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>arr</code> - The array to be re-arranged.</dd>
<dd><code>lo</code> - The lowest 0-based index to be considered.</dd>
<dd><code>hi</code> - The highest 0-based index to be considered.</dd>
<dd><code>pivot</code> - The 0-based smallest value to pivot on.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The value of the smallest (n)th element where n is 0-based.</dd>
</dl>
</li>
</ul>
<a name="selectIncludingZeros-double:A-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>selectIncludingZeros</h4>
<pre>public static&nbsp;double&nbsp;selectIncludingZeros(double[]&nbsp;arr,
int&nbsp;pivot)</pre>
<div class="block">Gets the 1-based kth order statistic from the array including any zero values in the
array. Warning! This changes the ordering of elements in the given array!</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>arr</code> - The hash array.</dd>
<dd><code>pivot</code> - The 1-based index of the value that is chosen as the pivot for the array.
After the operation all values below this 1-based index will be less than this value
and all values above this index will be greater. The 0-based index of the pivot will be
pivot-1.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The value of the smallest (N)th element including zeros, where N is 1-based.</dd>
</dl>
</li>
</ul>
<a name="selectExcludingZeros-double:A-int-int-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>selectExcludingZeros</h4>
<pre>public static&nbsp;double&nbsp;selectExcludingZeros(double[]&nbsp;arr,
int&nbsp;nonZeros,
int&nbsp;pivot)</pre>
<div class="block">Gets the 1-based kth order statistic from the array excluding any zero values in the
array. Warning! This changes the ordering of elements in the given array!</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>arr</code> - The hash array.</dd>
<dd><code>nonZeros</code> - The number of non-zero values in the array.</dd>
<dd><code>pivot</code> - The 1-based index of the value that is chosen as the pivot for the array.
After the operation all values below this 1-based index will be less than this value
and all values above this index will be greater. The 0-based index of the pivot will be
pivot+arr.length-nonZeros-1.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The value of the smallest (N)th element excluding zeros, where N is 1-based.</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/QuickSelect.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="../../../com/yahoo/sketches/QuantilesHelper.html" title="class in com.yahoo.sketches"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../com/yahoo/sketches/ResizeFactor.html" title="enum in com.yahoo.sketches"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?com/yahoo/sketches/QuickSelect.html" target="_top">Frames</a></li>
<li><a href="QuickSelect.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>Constr&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>Constr&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; 2015&#x2013;2019. All rights reserved.</small></p>
</body>
</html>