| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>StableVectorComparator (Apache Arrow Java Root POM 18.0.0-SNAPSHOT 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.arrow.algorithm.sort, class: StableVectorComparator"> |
| <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.6.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> |
| <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="class-use/StableVectorComparator.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#class">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field-summary">Field</a> | </li> |
| <li><a href="#constructor-summary">Constr</a> | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor-detail">Constr</a> | </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> <a href="package-summary.html">org.apache.arrow.algorithm.sort</a></div> |
| <h1 title="Class StableVectorComparator" class="title">Class StableVectorComparator<V extends <a href="../../vector/ValueVector.html" title="interface in org.apache.arrow.vector">ValueVector</a>></h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> |
| <div class="inheritance"><a href="VectorValueComparator.html" title="class in org.apache.arrow.algorithm.sort">org.apache.arrow.algorithm.sort.VectorValueComparator</a><V> |
| <div class="inheritance">org.apache.arrow.algorithm.sort.StableVectorComparator<V></div> |
| </div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>Type Parameters:</dt> |
| <dd><code>V</code> - type of the vector.</dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">StableVectorComparator<V extends <a href="../../vector/ValueVector.html" title="interface in org.apache.arrow.vector">ValueVector</a>></span> |
| <span class="extends-implements">extends <a href="VectorValueComparator.html" title="class in org.apache.arrow.algorithm.sort">VectorValueComparator</a><V></span></div> |
| <div class="block">Stable sorter. It compares values like ordinary comparators. However, when values are equal, it |
| breaks ties by the value indices. Therefore, sort algorithms using this comparator always produce |
| stable sort results.</div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <li> |
| <section class="field-summary" id="field-summary"> |
| <h2>Field Summary</h2> |
| <div class="inherited-list"> |
| <h3 id="fields-inherited-from-class-org.apache.arrow.algorithm.sort.VectorValueComparator">Fields inherited from class org.apache.arrow.algorithm.sort.<a href="VectorValueComparator.html" title="class in org.apache.arrow.algorithm.sort">VectorValueComparator</a></h3> |
| <code><a href="VectorValueComparator.html#valueWidth">valueWidth</a>, <a href="VectorValueComparator.html#vector1">vector1</a>, <a href="VectorValueComparator.html#vector2">vector2</a></code></div> |
| </section> |
| </li> |
| <!-- ======== 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 two-column-summary"> |
| <div class="table-header col-first">Constructor</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(org.apache.arrow.algorithm.sort.VectorValueComparator)" class="member-name-link">StableVectorComparator</a><wbr>(<a href="VectorValueComparator.html" title="class in org.apache.arrow.algorithm.sort">VectorValueComparator</a><<a href="StableVectorComparator.html" title="type parameter in StableVectorComparator">V</a>> innerComparator)</code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Constructs a stable comparator from a given comparator.</div> |
| </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-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance 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-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#attachVector(V)" class="member-name-link">attachVector</a><wbr>(<a href="StableVectorComparator.html" title="type parameter in StableVectorComparator">V</a> vector)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Attach both vectors to compare to the same input vector.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#attachVectors(V,V)" class="member-name-link">attachVectors</a><wbr>(<a href="StableVectorComparator.html" title="type parameter in StableVectorComparator">V</a> vector1, |
| <a href="StableVectorComparator.html" title="type parameter in StableVectorComparator">V</a> vector2)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Attach vectors to compare.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#compareNotNull(int,int)" class="member-name-link">compareNotNull</a><wbr>(int index1, |
| int index2)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Compare two values, given their indices.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="VectorValueComparator.html" title="class in org.apache.arrow.algorithm.sort">VectorValueComparator</a><<a href="StableVectorComparator.html" title="type parameter in StableVectorComparator">V</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#createNew()" class="member-name-link">createNew</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Creates a comparator of the same type.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.arrow.algorithm.sort.VectorValueComparator">Methods inherited from class org.apache.arrow.algorithm.sort.<a href="VectorValueComparator.html" title="class in org.apache.arrow.algorithm.sort">VectorValueComparator</a></h3> |
| <code><a href="VectorValueComparator.html#checkNullsOnCompare()">checkNullsOnCompare</a>, <a href="VectorValueComparator.html#compare(int,int)">compare</a>, <a href="VectorValueComparator.html#getValueWidth()">getValueWidth</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/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/javase/8/docs/api/java/lang/Object.html#finalize--" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/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="<init>(org.apache.arrow.algorithm.sort.VectorValueComparator)"> |
| <h3>StableVectorComparator</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">StableVectorComparator</span><wbr><span class="parameters">(<a href="VectorValueComparator.html" title="class in org.apache.arrow.algorithm.sort">VectorValueComparator</a><<a href="StableVectorComparator.html" title="type parameter in StableVectorComparator">V</a>> innerComparator)</span></div> |
| <div class="block">Constructs a stable comparator from a given comparator.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>innerComparator</code> - the comparator to convert to stable comparator..</dd> |
| </dl> |
| </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="attachVector(V)"> |
| <h3 id="attachVector(org.apache.arrow.vector.ValueVector)">attachVector</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">attachVector</span><wbr><span class="parameters">(<a href="StableVectorComparator.html" title="type parameter in StableVectorComparator">V</a> vector)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="VectorValueComparator.html#attachVector(V)">VectorValueComparator</a></code></span></div> |
| <div class="block">Attach both vectors to compare to the same input vector.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="VectorValueComparator.html#attachVector(V)">attachVector</a></code> in class <code><a href="VectorValueComparator.html" title="class in org.apache.arrow.algorithm.sort">VectorValueComparator</a><<a href="StableVectorComparator.html" title="type parameter in StableVectorComparator">V</a> extends <a href="../../vector/ValueVector.html" title="interface in org.apache.arrow.vector">ValueVector</a>></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>vector</code> - the vector to attach.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="attachVectors(V,V)"> |
| <h3 id="attachVectors(org.apache.arrow.vector.ValueVector,org.apache.arrow.vector.ValueVector)">attachVectors</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">attachVectors</span><wbr><span class="parameters">(<a href="StableVectorComparator.html" title="type parameter in StableVectorComparator">V</a> vector1, |
| <a href="StableVectorComparator.html" title="type parameter in StableVectorComparator">V</a> vector2)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="VectorValueComparator.html#attachVectors(V,V)">VectorValueComparator</a></code></span></div> |
| <div class="block">Attach vectors to compare.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="VectorValueComparator.html#attachVectors(V,V)">attachVectors</a></code> in class <code><a href="VectorValueComparator.html" title="class in org.apache.arrow.algorithm.sort">VectorValueComparator</a><<a href="StableVectorComparator.html" title="type parameter in StableVectorComparator">V</a> extends <a href="../../vector/ValueVector.html" title="interface in org.apache.arrow.vector">ValueVector</a>></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>vector1</code> - the first vector to compare.</dd> |
| <dd><code>vector2</code> - the second vector to compare.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="compareNotNull(int,int)"> |
| <h3>compareNotNull</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">compareNotNull</span><wbr><span class="parameters">(int index1, |
| int index2)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="VectorValueComparator.html#compareNotNull(int,int)">VectorValueComparator</a></code></span></div> |
| <div class="block">Compare two values, given their indices. This is a fast path for comparing non-null values, so |
| the caller must make sure that values at both indices are not null.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="VectorValueComparator.html#compareNotNull(int,int)">compareNotNull</a></code> in class <code><a href="VectorValueComparator.html" title="class in org.apache.arrow.algorithm.sort">VectorValueComparator</a><<a href="StableVectorComparator.html" title="type parameter in StableVectorComparator">V</a> extends <a href="../../vector/ValueVector.html" title="interface in org.apache.arrow.vector">ValueVector</a>></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>index1</code> - index of the first value to compare.</dd> |
| <dd><code>index2</code> - index of the second value to compare.</dd> |
| <dt>Returns:</dt> |
| <dd>an integer greater than 0, if the first value is greater; an integer smaller than 0, if |
| the first value is smaller; or 0, if both values are equal.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="createNew()"> |
| <h3>createNew</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="VectorValueComparator.html" title="class in org.apache.arrow.algorithm.sort">VectorValueComparator</a><<a href="StableVectorComparator.html" title="type parameter in StableVectorComparator">V</a>></span> <span class="element-name">createNew</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="VectorValueComparator.html#createNew()">VectorValueComparator</a></code></span></div> |
| <div class="block">Creates a comparator of the same type.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="VectorValueComparator.html#createNew()">createNew</a></code> in class <code><a href="VectorValueComparator.html" title="class in org.apache.arrow.algorithm.sort">VectorValueComparator</a><<a href="StableVectorComparator.html" title="type parameter in StableVectorComparator">V</a> extends <a href="../../vector/ValueVector.html" title="interface in org.apache.arrow.vector">ValueVector</a>></code></dd> |
| <dt>Returns:</dt> |
| <dd>the newly created comparator.</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 2023 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
