| <!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_302) on Wed Jan 26 15:15:50 PST 2022 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>InequalitySearch (datasketches-java 3.1.0 API)</title> |
| <meta name="date" content="2022-01-26"> |
| <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="InequalitySearch (datasketches-java 3.1.0 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":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/InequalitySearch.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../index-all.html">Index</a></li> |
| <li><a href="../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../org/apache/datasketches/HashOperations.html" title="class in org.apache.datasketches"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../org/apache/datasketches/QuantilesHelper.html" title="class in org.apache.datasketches"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?org/apache/datasketches/InequalitySearch.html" target="_top">Frames</a></li> |
| <li><a href="InequalitySearch.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../allclasses-noframe.html">All 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: </li> |
| <li>Nested | </li> |
| <li><a href="#enum.constant.summary">Enum Constants</a> | </li> |
| <li>Field | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#enum.constant.detail">Enum Constants</a> | </li> |
| <li>Field | </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.datasketches</div> |
| <h2 title="Enum InequalitySearch" class="title">Enum InequalitySearch</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><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang">java.lang.Enum</a><<a href="../../../org/apache/datasketches/InequalitySearch.html" title="enum in org.apache.datasketches">InequalitySearch</a>></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.datasketches.InequalitySearch</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</a><<a href="../../../org/apache/datasketches/InequalitySearch.html" title="enum in org.apache.datasketches">InequalitySearch</a>></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public enum <span class="typeNameLabel">InequalitySearch</span> |
| extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang">Enum</a><<a href="../../../org/apache/datasketches/InequalitySearch.html" title="enum in org.apache.datasketches">InequalitySearch</a>></pre> |
| <div class="block">This provides efficient, unique and unambiguous binary searching for inequality comparison criteria |
| for ordered arrays of values that may include duplicate values. The inequality criteria include |
| <, ≤, ==, ≥, >. All the inequality criteria use the same search algorithm. |
| (Although == is not an inequality, it is included for convenience.) |
| |
| <p>In order to make the searching unique and unambiguous, we modified the traditional binary |
| search algorithm to search for adjacent pairs of values <i>{A, B}</i> in the values array |
| instead of just a single value, where <i>A</i> and <i>B</i> are the array indicies of two |
| adjacent values in the array. For all the search criteria, if the algorithm reaches the ends of |
| the search range, the algorithm calls the <i>resolve()</i> method to determine what to |
| return to the caller. If the key value cannot be resolved, it returns a -1 to the caller. |
| |
| <p>Given an array of values <i>arr[]</i> and the search key value <i>v</i>, the algorithms for |
| the searching criteria are as follows:</p> |
| <ul> |
| <li><b>LT:</b> Find the highest ranked adjacent pair <i>{A, B}</i> such that:<br> |
| <i>arr[A] < v ≤ arr[B]</i>. The normal return is the index <i>A</i>. |
| </li> |
| <li><b>LE:</b> Find the highest ranked adjacent pair <i>{A, B}</i> such that:<br> |
| <i>arr[A] ≤ v < arr[B]</i>. The normal return is the index <i>A</i>. |
| </li> |
| <li><b>EQ:</b> Find the adjacent pair <i>{A, B}</i> such that:<br> |
| <i>arr[A] ≤ v ≤ arr[B]</i>. The normal return is the index <i>A</i> or <i>B</i> whichever |
| equals <i>v</i>, otherwise it returns -1. |
| </li> |
| <li><b>GE:</b> Find the lowest ranked adjacent pair <i>{A, B}</i> such that:<br> |
| <i>arr[A] < v ≤ arr[B]</i>. The normal return is the index <i>B</i>. |
| </li> |
| <li><b>GT:</b> Find the lowest ranked adjacent pair <i>{A, B}</i> such that:<br> |
| <i>arr[A] ≤ v < arr[B]</i>. The normal return is the index <i>B</i>. |
| </li> |
| </ul></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"> |
| <!-- =========== ENUM CONSTANT SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="enum.constant.summary"> |
| <!-- --> |
| </a> |
| <h3>Enum Constant Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Constant Summary table, listing enum constants, and an explanation"> |
| <caption><span>Enum Constants</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Enum Constant and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../org/apache/datasketches/InequalitySearch.html#EQ">EQ</a></span></code> |
| <div class="block">Given a sorted array of increasing values <i>arr[]</i> and a key value <i>V</i>, |
| this criterion instructs the binary search algorithm to find the adjacent pair of |
| values <i>{A,B}</i> such that <i>A ≤ V ≤ B</i>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../org/apache/datasketches/InequalitySearch.html#GE">GE</a></span></code> |
| <div class="block">Given a sorted array of increasing values <i>arr[]</i> and a key value <i>V</i>, |
| this criterion instructs the binary search algorithm to find the lowest adjacent pair of |
| values <i>{A,B}</i> such that <i>A < V ≤ B</i>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../org/apache/datasketches/InequalitySearch.html#GT">GT</a></span></code> |
| <div class="block">Given a sorted array of increasing values <i>arr[]</i> and a key value <i>V</i>, |
| this criterion instructs the binary search algorithm to find the lowest adjacent pair of |
| values <i>{A,B}</i> such that <i>A ≤ V < B</i>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../org/apache/datasketches/InequalitySearch.html#LE">LE</a></span></code> |
| <div class="block">Given a sorted array of increasing values <i>arr[]</i> and a key value <i>V</i>, |
| this criterion instructs the binary search algorithm to find the highest adjacent pair of |
| values <i>{A,B}</i> such that <i>A ≤ V < B</i>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../org/apache/datasketches/InequalitySearch.html#LT">LT</a></span></code> |
| <div class="block">Given a sorted array of increasing values <i>arr[]</i> and a key value <i>V</i>, |
| this criterion instructs the binary search algorithm to find the highest adjacent pair of |
| values <i>{A,B}</i> such that <i>A < V ≤ B</i>.</div> |
| </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"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </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 int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/datasketches/InequalitySearch.html#find-double:A-int-int-double-org.apache.datasketches.InequalitySearch-">find</a></span>(double[] arr, |
| int low, |
| int high, |
| double v, |
| <a href="../../../org/apache/datasketches/InequalitySearch.html" title="enum in org.apache.datasketches">InequalitySearch</a> crit)</code> |
| <div class="block">Binary Search for the index of the double value in the given search range that satisfies |
| the given InequalitySearch criterion.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/datasketches/InequalitySearch.html#find-float:A-int-int-float-org.apache.datasketches.InequalitySearch-">find</a></span>(float[] arr, |
| int low, |
| int high, |
| float v, |
| <a href="../../../org/apache/datasketches/InequalitySearch.html" title="enum in org.apache.datasketches">InequalitySearch</a> crit)</code> |
| <div class="block">Binary Search for the index of the float value in the given search range that satisfies |
| the given InequalitySearch criterion.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/datasketches/InequalitySearch.html#find-long:A-int-int-long-org.apache.datasketches.InequalitySearch-">find</a></span>(long[] arr, |
| int low, |
| int high, |
| long v, |
| <a href="../../../org/apache/datasketches/InequalitySearch.html" title="enum in org.apache.datasketches">InequalitySearch</a> crit)</code> |
| <div class="block">Binary Search for the index of the long value in the given search range that satisfies |
| the given InequalitySearch criterion.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../org/apache/datasketches/InequalitySearch.html" title="enum in org.apache.datasketches">InequalitySearch</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/datasketches/InequalitySearch.html#valueOf-java.lang.String-">valueOf</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</code> |
| <div class="block">Returns the enum constant of this type with the specified name.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../org/apache/datasketches/InequalitySearch.html" title="enum in org.apache.datasketches">InequalitySearch</a>[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/datasketches/InequalitySearch.html#values--">values</a></span>()</code> |
| <div class="block">Returns an array containing the constants of this enum type, in |
| the order they are declared.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Enum"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang">Enum</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.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/Enum.html?is-external=true#compareTo-E-" title="class or interface in java.lang">compareTo</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.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/Enum.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/Enum.html?is-external=true#getDeclaringClass--" title="class or interface in java.lang">getDeclaringClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.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/Enum.html?is-external=true#name--" title="class or interface in java.lang">name</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#ordinal--" title="class or interface in java.lang">ordinal</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.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/Enum.html?is-external=true#valueOf-java.lang.Class-java.lang.String-" title="class or interface in java.lang">valueOf</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class 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#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#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#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"> |
| <!-- ============ ENUM CONSTANT DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="enum.constant.detail"> |
| <!-- --> |
| </a> |
| <h3>Enum Constant Detail</h3> |
| <a name="LT"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>LT</h4> |
| <pre>public static final <a href="../../../org/apache/datasketches/InequalitySearch.html" title="enum in org.apache.datasketches">InequalitySearch</a> LT</pre> |
| <div class="block">Given a sorted array of increasing values <i>arr[]</i> and a key value <i>V</i>, |
| this criterion instructs the binary search algorithm to find the highest adjacent pair of |
| values <i>{A,B}</i> such that <i>A < V ≤ B</i>. |
| The returned value from the binary search algorithm will be the index of <i>A</i> |
| or -1, if the value <i>V</i> ≤ the lowest value in the selected range of the array.</div> |
| </li> |
| </ul> |
| <a name="LE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>LE</h4> |
| <pre>public static final <a href="../../../org/apache/datasketches/InequalitySearch.html" title="enum in org.apache.datasketches">InequalitySearch</a> LE</pre> |
| <div class="block">Given a sorted array of increasing values <i>arr[]</i> and a key value <i>V</i>, |
| this criterion instructs the binary search algorithm to find the highest adjacent pair of |
| values <i>{A,B}</i> such that <i>A ≤ V < B</i>. |
| The returned value from the binary search algorithm will be the index of <i>A</i> |
| or -1, if the value <i>V</i> < the lowest value in the selected range of the array.</div> |
| </li> |
| </ul> |
| <a name="EQ"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>EQ</h4> |
| <pre>public static final <a href="../../../org/apache/datasketches/InequalitySearch.html" title="enum in org.apache.datasketches">InequalitySearch</a> EQ</pre> |
| <div class="block">Given a sorted array of increasing values <i>arr[]</i> and a key value <i>V</i>, |
| this criterion instructs the binary search algorithm to find the adjacent pair of |
| values <i>{A,B}</i> such that <i>A ≤ V ≤ B</i>. |
| The returned value from the binary search algorithm will be the index of <i>A</i> or <i>B</i>, |
| if one of them is equal to <i>V</i>, or -1 if V is not equal to either one.</div> |
| </li> |
| </ul> |
| <a name="GE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>GE</h4> |
| <pre>public static final <a href="../../../org/apache/datasketches/InequalitySearch.html" title="enum in org.apache.datasketches">InequalitySearch</a> GE</pre> |
| <div class="block">Given a sorted array of increasing values <i>arr[]</i> and a key value <i>V</i>, |
| this criterion instructs the binary search algorithm to find the lowest adjacent pair of |
| values <i>{A,B}</i> such that <i>A < V ≤ B</i>. |
| The returned value from the binary search algorithm will be the index of <i>B</i> |
| or -1, if the value <i>V</i> > the highest value in the selected range of the array.</div> |
| </li> |
| </ul> |
| <a name="GT"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>GT</h4> |
| <pre>public static final <a href="../../../org/apache/datasketches/InequalitySearch.html" title="enum in org.apache.datasketches">InequalitySearch</a> GT</pre> |
| <div class="block">Given a sorted array of increasing values <i>arr[]</i> and a key value <i>V</i>, |
| this criterion instructs the binary search algorithm to find the lowest adjacent pair of |
| values <i>{A,B}</i> such that <i>A ≤ V < B</i>. |
| The returned value from the binary search algorithm will be the index of <i>B</i> |
| or -1, if the value <i>V</i> ≥ the highest value in the selected range of the array.</div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="values--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>values</h4> |
| <pre>public static <a href="../../../org/apache/datasketches/InequalitySearch.html" title="enum in org.apache.datasketches">InequalitySearch</a>[] values()</pre> |
| <div class="block">Returns an array containing the constants of this enum type, in |
| the order they are declared. This method may be used to iterate |
| over the constants as follows: |
| <pre> |
| for (InequalitySearch c : InequalitySearch.values()) |
| System.out.println(c); |
| </pre></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>an array containing the constants of this enum type, in the order they are declared</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="valueOf-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>valueOf</h4> |
| <pre>public static <a href="../../../org/apache/datasketches/InequalitySearch.html" title="enum in org.apache.datasketches">InequalitySearch</a> valueOf(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</pre> |
| <div class="block">Returns the enum constant of this type with the specified name. |
| The string must match <i>exactly</i> an identifier used to declare an |
| enum constant in this type. (Extraneous whitespace characters are |
| not permitted.)</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - the name of the enum constant to be returned.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the enum constant with the specified name</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if this enum type has no constant with the specified name</dd> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</a></code> - if the argument is null</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="find-double:A-int-int-double-org.apache.datasketches.InequalitySearch-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>find</h4> |
| <pre>public static int find(double[] arr, |
| int low, |
| int high, |
| double v, |
| <a href="../../../org/apache/datasketches/InequalitySearch.html" title="enum in org.apache.datasketches">InequalitySearch</a> crit)</pre> |
| <div class="block">Binary Search for the index of the double value in the given search range that satisfies |
| the given InequalitySearch criterion. |
| If -1 is returned there are no values in the search range that satisfy the criterion.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>arr</code> - the given array that must be sorted.</dd> |
| <dd><code>low</code> - the index of the lowest value in the search range</dd> |
| <dd><code>high</code> - the index of the highest value in the search range</dd> |
| <dd><code>v</code> - the value to search for.</dd> |
| <dd><code>crit</code> - one of LT, LE, EQ, GT, GE</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the index of the value in the given search range that satisfies the criterion</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="find-float:A-int-int-float-org.apache.datasketches.InequalitySearch-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>find</h4> |
| <pre>public static int find(float[] arr, |
| int low, |
| int high, |
| float v, |
| <a href="../../../org/apache/datasketches/InequalitySearch.html" title="enum in org.apache.datasketches">InequalitySearch</a> crit)</pre> |
| <div class="block">Binary Search for the index of the float value in the given search range that satisfies |
| the given InequalitySearch criterion. |
| If -1 is returned there are no values in the search range that satisfy the criterion.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>arr</code> - the given array that must be sorted.</dd> |
| <dd><code>low</code> - the index of the lowest value in the search range</dd> |
| <dd><code>high</code> - the index of the highest value in the search range</dd> |
| <dd><code>v</code> - the value to search for.</dd> |
| <dd><code>crit</code> - one of LT, LE, EQ, GT, GE</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the index of the value in the given search range that satisfies the criterion</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="find-long:A-int-int-long-org.apache.datasketches.InequalitySearch-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>find</h4> |
| <pre>public static int find(long[] arr, |
| int low, |
| int high, |
| long v, |
| <a href="../../../org/apache/datasketches/InequalitySearch.html" title="enum in org.apache.datasketches">InequalitySearch</a> crit)</pre> |
| <div class="block">Binary Search for the index of the long value in the given search range that satisfies |
| the given InequalitySearch criterion. |
| If -1 is returned there are no values in the search range that satisfy the criterion.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>arr</code> - the given array that must be sorted.</dd> |
| <dd><code>low</code> - the index of the lowest value in the search range</dd> |
| <dd><code>high</code> - the index of the highest value in the search range</dd> |
| <dd><code>v</code> - the value to search for.</dd> |
| <dd><code>crit</code> - one of LT, LE, EQ, GT, GE</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the index of the value in the given search range that satisfies the criterion</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/InequalitySearch.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../index-all.html">Index</a></li> |
| <li><a href="../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../org/apache/datasketches/HashOperations.html" title="class in org.apache.datasketches"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../org/apache/datasketches/QuantilesHelper.html" title="class in org.apache.datasketches"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?org/apache/datasketches/InequalitySearch.html" target="_top">Frames</a></li> |
| <li><a href="InequalitySearch.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../allclasses-noframe.html">All 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: </li> |
| <li>Nested | </li> |
| <li><a href="#enum.constant.summary">Enum Constants</a> | </li> |
| <li>Field | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#enum.constant.detail">Enum Constants</a> | </li> |
| <li>Field | </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 © 2015–2020 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |