| <!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 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>SearchDictionaryEncoder (Apache Arrow Java Root POM 17.0.0-SNAPSHOT API)</title> |
| <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="SearchDictionaryEncoder (Apache Arrow Java Root POM 17.0.0-SNAPSHOT API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance 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/SearchDictionaryEncoder.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/arrow/algorithm/dictionary/LinearDictionaryEncoder.html" title="class in org.apache.arrow.algorithm.dictionary"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/arrow/algorithm/dictionary/SearchTreeBasedDictionaryBuilder.html" title="class in org.apache.arrow.algorithm.dictionary"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/arrow/algorithm/dictionary/SearchDictionaryEncoder.html" target="_top">Frames</a></li> |
| <li><a href="SearchDictionaryEncoder.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>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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.arrow.algorithm.dictionary</div> |
| <h2 title="Class SearchDictionaryEncoder" class="title">Class SearchDictionaryEncoder<E extends <a href="../../../../../org/apache/arrow/vector/BaseIntVector.html" title="interface in org.apache.arrow.vector">BaseIntVector</a>,D extends <a href="../../../../../org/apache/arrow/vector/ValueVector.html" title="interface in org.apache.arrow.vector">ValueVector</a>></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>org.apache.arrow.algorithm.dictionary.SearchDictionaryEncoder<E,D></li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>E</code> - encoded vector type.</dd> |
| <dd><code>D</code> - decoded vector type, which is also the dictionary type.</dd> |
| </dl> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="../../../../../org/apache/arrow/algorithm/dictionary/DictionaryEncoder.html" title="interface in org.apache.arrow.algorithm.dictionary">DictionaryEncoder</a><E,D></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">SearchDictionaryEncoder<E extends <a href="../../../../../org/apache/arrow/vector/BaseIntVector.html" title="interface in org.apache.arrow.vector">BaseIntVector</a>,D extends <a href="../../../../../org/apache/arrow/vector/ValueVector.html" title="interface in org.apache.arrow.vector">ValueVector</a>></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> |
| implements <a href="../../../../../org/apache/arrow/algorithm/dictionary/DictionaryEncoder.html" title="interface in org.apache.arrow.algorithm.dictionary">DictionaryEncoder</a><E,D></pre> |
| <div class="block">Dictionary encoder based on searching.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/algorithm/dictionary/SearchDictionaryEncoder.html#SearchDictionaryEncoder-D-org.apache.arrow.algorithm.sort.VectorValueComparator-">SearchDictionaryEncoder</a></span>(<a href="../../../../../org/apache/arrow/algorithm/dictionary/SearchDictionaryEncoder.html" title="type parameter in SearchDictionaryEncoder">D</a> dictionary, |
| <a href="../../../../../org/apache/arrow/algorithm/sort/VectorValueComparator.html" title="class in org.apache.arrow.algorithm.sort">VectorValueComparator</a><<a href="../../../../../org/apache/arrow/algorithm/dictionary/SearchDictionaryEncoder.html" title="type parameter in SearchDictionaryEncoder">D</a>> comparator)</code> |
| <div class="block">Constructs a dictionary encoder.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/algorithm/dictionary/SearchDictionaryEncoder.html#SearchDictionaryEncoder-D-org.apache.arrow.algorithm.sort.VectorValueComparator-boolean-">SearchDictionaryEncoder</a></span>(<a href="../../../../../org/apache/arrow/algorithm/dictionary/SearchDictionaryEncoder.html" title="type parameter in SearchDictionaryEncoder">D</a> dictionary, |
| <a href="../../../../../org/apache/arrow/algorithm/sort/VectorValueComparator.html" title="class in org.apache.arrow.algorithm.sort">VectorValueComparator</a><<a href="../../../../../org/apache/arrow/algorithm/dictionary/SearchDictionaryEncoder.html" title="type parameter in SearchDictionaryEncoder">D</a>> comparator, |
| boolean encodeNull)</code> |
| <div class="block">Constructs a dictionary encoder.</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="t2" class="tableTab"><span><a href="javascript:show(2);">Instance 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>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/algorithm/dictionary/SearchDictionaryEncoder.html#encode-D-E-">encode</a></span>(<a href="../../../../../org/apache/arrow/algorithm/dictionary/SearchDictionaryEncoder.html" title="type parameter in SearchDictionaryEncoder">D</a> input, |
| <a href="../../../../../org/apache/arrow/algorithm/dictionary/SearchDictionaryEncoder.html" title="type parameter in SearchDictionaryEncoder">E</a> output)</code> |
| <div class="block">Encodes an input vector by binary search.</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 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"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="SearchDictionaryEncoder-org.apache.arrow.vector.ValueVector-org.apache.arrow.algorithm.sort.VectorValueComparator-"> |
| <!-- --> |
| </a><a name="SearchDictionaryEncoder-D-org.apache.arrow.algorithm.sort.VectorValueComparator-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>SearchDictionaryEncoder</h4> |
| <pre>public SearchDictionaryEncoder(<a href="../../../../../org/apache/arrow/algorithm/dictionary/SearchDictionaryEncoder.html" title="type parameter in SearchDictionaryEncoder">D</a> dictionary, |
| <a href="../../../../../org/apache/arrow/algorithm/sort/VectorValueComparator.html" title="class in org.apache.arrow.algorithm.sort">VectorValueComparator</a><<a href="../../../../../org/apache/arrow/algorithm/dictionary/SearchDictionaryEncoder.html" title="type parameter in SearchDictionaryEncoder">D</a>> comparator)</pre> |
| <div class="block">Constructs a dictionary encoder.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>dictionary</code> - the dictionary. It must be in sorted order.</dd> |
| <dd><code>comparator</code> - the criteria for sorting.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="SearchDictionaryEncoder-org.apache.arrow.vector.ValueVector-org.apache.arrow.algorithm.sort.VectorValueComparator-boolean-"> |
| <!-- --> |
| </a><a name="SearchDictionaryEncoder-D-org.apache.arrow.algorithm.sort.VectorValueComparator-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>SearchDictionaryEncoder</h4> |
| <pre>public SearchDictionaryEncoder(<a href="../../../../../org/apache/arrow/algorithm/dictionary/SearchDictionaryEncoder.html" title="type parameter in SearchDictionaryEncoder">D</a> dictionary, |
| <a href="../../../../../org/apache/arrow/algorithm/sort/VectorValueComparator.html" title="class in org.apache.arrow.algorithm.sort">VectorValueComparator</a><<a href="../../../../../org/apache/arrow/algorithm/dictionary/SearchDictionaryEncoder.html" title="type parameter in SearchDictionaryEncoder">D</a>> comparator, |
| boolean encodeNull)</pre> |
| <div class="block">Constructs a dictionary encoder.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>dictionary</code> - the dictionary. It must be in sorted order.</dd> |
| <dd><code>comparator</code> - the criteria for sorting.</dd> |
| <dd><code>encodeNull</code> - a flag indicating if null should be encoded. |
| It determines the behaviors for processing null values in the input during encoding. |
| When a null is encountered in the input, |
| 1) If the flag is set to true, the encoder searches for the value in the dictionary, |
| and outputs the index in the dictionary. |
| 2) If the flag is set to false, the encoder simply produces a null in the output.</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="encode-org.apache.arrow.vector.ValueVector-org.apache.arrow.vector.BaseIntVector-"> |
| <!-- --> |
| </a><a name="encode-D-E-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>encode</h4> |
| <pre>public void encode(<a href="../../../../../org/apache/arrow/algorithm/dictionary/SearchDictionaryEncoder.html" title="type parameter in SearchDictionaryEncoder">D</a> input, |
| <a href="../../../../../org/apache/arrow/algorithm/dictionary/SearchDictionaryEncoder.html" title="type parameter in SearchDictionaryEncoder">E</a> output)</pre> |
| <div class="block">Encodes an input vector by binary search. |
| So the algorithm takes O(n * log(m)) time, where n is the length of the input vector, |
| and m is the length of the dictionary.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/arrow/algorithm/dictionary/DictionaryEncoder.html#encode-D-E-">encode</a></code> in interface <code><a href="../../../../../org/apache/arrow/algorithm/dictionary/DictionaryEncoder.html" title="interface in org.apache.arrow.algorithm.dictionary">DictionaryEncoder</a><<a href="../../../../../org/apache/arrow/algorithm/dictionary/SearchDictionaryEncoder.html" title="type parameter in SearchDictionaryEncoder">E</a> extends <a href="../../../../../org/apache/arrow/vector/BaseIntVector.html" title="interface in org.apache.arrow.vector">BaseIntVector</a>,<a href="../../../../../org/apache/arrow/algorithm/dictionary/SearchDictionaryEncoder.html" title="type parameter in SearchDictionaryEncoder">D</a> extends <a href="../../../../../org/apache/arrow/vector/ValueVector.html" title="interface in org.apache.arrow.vector">ValueVector</a>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>input</code> - the input vector.</dd> |
| <dd><code>output</code> - the output vector. Note that it must be in a fresh state. At least, |
| all its validity bits should be clear.</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/SearchDictionaryEncoder.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/arrow/algorithm/dictionary/LinearDictionaryEncoder.html" title="class in org.apache.arrow.algorithm.dictionary"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/arrow/algorithm/dictionary/SearchTreeBasedDictionaryBuilder.html" title="class in org.apache.arrow.algorithm.dictionary"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/arrow/algorithm/dictionary/SearchDictionaryEncoder.html" target="_top">Frames</a></li> |
| <li><a href="SearchDictionaryEncoder.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>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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 © 2023 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
