| <!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>BitVectorHelper (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="BitVectorHelper (Apache Arrow Java Root POM 17.0.0-SNAPSHOT API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9,"i5":9,"i6":9,"i7":9,"i8":9,"i9":9,"i10":9,"i11":9,"i12":9,"i13":9,"i14":9,"i15":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/BitVectorHelper.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/vector/BitVector.html" title="class in org.apache.arrow.vector"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/arrow/vector/BitVectorHelperBenchmarks.html" title="class in org.apache.arrow.vector"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/arrow/vector/BitVectorHelper.html" target="_top">Frames</a></li> |
| <li><a href="BitVectorHelper.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>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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.vector</div> |
| <h2 title="Class BitVectorHelper" class="title">Class BitVectorHelper</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.vector.BitVectorHelper</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">BitVectorHelper</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">Helper class for performing generic operations on a bit vector buffer. |
| External use of this class is not recommended.</div> |
| </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"> </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/arrow/vector/BitVectorHelper.html#bitIndex-int-">bitIndex</a></span>(int absoluteBitIndex)</code> |
| <div class="block">Get the relative index of bit within the byte in validity buffer.</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/arrow/vector/BitVectorHelper.html#bitIndex-long-">bitIndex</a></span>(long absoluteBitIndex)</code> |
| <div class="block">Get the relative index of bit within the byte in validity buffer.</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/arrow/vector/BitVectorHelper.html#byteIndex-int-">byteIndex</a></span>(int absoluteBitIndex)</code> |
| <div class="block">Get the index of byte corresponding to bit index in validity buffer.</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="../../../../org/apache/arrow/vector/BitVectorHelper.html#byteIndex-long-">byteIndex</a></span>(long absoluteBitIndex)</code> |
| <div class="block">Get the index of byte corresponding to bit index in validity buffer.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>static boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/vector/BitVectorHelper.html#checkAllBitsEqualTo-org.apache.arrow.memory.ArrowBuf-int-boolean-">checkAllBitsEqualTo</a></span>(<a href="../../../../org/apache/arrow/memory/ArrowBuf.html" title="class in org.apache.arrow.memory">ArrowBuf</a> validityBuffer, |
| int valueCount, |
| boolean checkOneBits)</code> |
| <div class="block">Tests if all bits in a validity buffer are equal 0 or 1, according to the specified parameter.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>static void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/vector/BitVectorHelper.html#concatBits-org.apache.arrow.memory.ArrowBuf-int-org.apache.arrow.memory.ArrowBuf-int-org.apache.arrow.memory.ArrowBuf-">concatBits</a></span>(<a href="../../../../org/apache/arrow/memory/ArrowBuf.html" title="class in org.apache.arrow.memory">ArrowBuf</a> input1, |
| int numBits1, |
| <a href="../../../../org/apache/arrow/memory/ArrowBuf.html" title="class in org.apache.arrow.memory">ArrowBuf</a> input2, |
| int numBits2, |
| <a href="../../../../org/apache/arrow/memory/ArrowBuf.html" title="class in org.apache.arrow.memory">ArrowBuf</a> output)</code> |
| <div class="block">Concat two validity buffers.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/vector/BitVectorHelper.html#get-org.apache.arrow.memory.ArrowBuf-int-">get</a></span>(<a href="../../../../org/apache/arrow/memory/ArrowBuf.html" title="class in org.apache.arrow.memory">ArrowBuf</a> buffer, |
| int index)</code> |
| <div class="block">Check if a bit at a given index is set or not.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>static byte</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/vector/BitVectorHelper.html#getBitsFromCurrentByte-org.apache.arrow.memory.ArrowBuf-int-int-">getBitsFromCurrentByte</a></span>(<a href="../../../../org/apache/arrow/memory/ArrowBuf.html" title="class in org.apache.arrow.memory">ArrowBuf</a> data, |
| int index, |
| int offset)</code> |
| <div class="block">Returns the byte at index from data right-shifted by offset.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>static byte</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/vector/BitVectorHelper.html#getBitsFromNextByte-org.apache.arrow.memory.ArrowBuf-int-int-">getBitsFromNextByte</a></span>(<a href="../../../../org/apache/arrow/memory/ArrowBuf.html" title="class in org.apache.arrow.memory">ArrowBuf</a> data, |
| int index, |
| int offset)</code> |
| <div class="block">Returns the byte at <code>index</code> from left-shifted by (8 - <code>offset</code>).</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/vector/BitVectorHelper.html#getNullCount-org.apache.arrow.memory.ArrowBuf-int-">getNullCount</a></span>(<a href="../../../../org/apache/arrow/memory/ArrowBuf.html" title="class in org.apache.arrow.memory">ArrowBuf</a> validityBuffer, |
| int valueCount)</code> |
| <div class="block">Given a validity buffer, find the number of bits that are not set.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/vector/BitVectorHelper.html#getValidityBufferSize-int-">getValidityBufferSize</a></span>(int valueCount)</code> |
| <div class="block">Compute the size of validity buffer required to manage a given number |
| of elements in a vector.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../../org/apache/arrow/memory/ArrowBuf.html" title="class in org.apache.arrow.memory">ArrowBuf</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/vector/BitVectorHelper.html#loadValidityBuffer-org.apache.arrow.vector.ipc.message.ArrowFieldNode-org.apache.arrow.memory.ArrowBuf-org.apache.arrow.memory.BufferAllocator-">loadValidityBuffer</a></span>(<a href="../../../../org/apache/arrow/vector/ipc/message/ArrowFieldNode.html" title="class in org.apache.arrow.vector.ipc.message">ArrowFieldNode</a> fieldNode, |
| <a href="../../../../org/apache/arrow/memory/ArrowBuf.html" title="class in org.apache.arrow.memory">ArrowBuf</a> sourceValidityBuffer, |
| <a href="../../../../org/apache/arrow/memory/BufferAllocator.html" title="interface in org.apache.arrow.memory">BufferAllocator</a> allocator)</code> |
| <div class="block">Returns a new buffer if the source validity buffer is either all null or all |
| not-null, otherwise returns a buffer pointing to the same memory as source.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>static void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/vector/BitVectorHelper.html#setBit-org.apache.arrow.memory.ArrowBuf-long-">setBit</a></span>(<a href="../../../../org/apache/arrow/memory/ArrowBuf.html" title="class in org.apache.arrow.memory">ArrowBuf</a> validityBuffer, |
| long index)</code> |
| <div class="block">Set the bit at provided index to 1.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../../org/apache/arrow/memory/ArrowBuf.html" title="class in org.apache.arrow.memory">ArrowBuf</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/vector/BitVectorHelper.html#setValidityBit-org.apache.arrow.memory.ArrowBuf-org.apache.arrow.memory.BufferAllocator-int-int-int-">setValidityBit</a></span>(<a href="../../../../org/apache/arrow/memory/ArrowBuf.html" title="class in org.apache.arrow.memory">ArrowBuf</a> validityBuffer, |
| <a href="../../../../org/apache/arrow/memory/BufferAllocator.html" title="interface in org.apache.arrow.memory">BufferAllocator</a> allocator, |
| int valueCount, |
| int index, |
| int value)</code> |
| <div class="block">Set the bit at a given index to provided value (1 or 0).</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>static void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/vector/BitVectorHelper.html#setValidityBit-org.apache.arrow.memory.ArrowBuf-int-int-">setValidityBit</a></span>(<a href="../../../../org/apache/arrow/memory/ArrowBuf.html" title="class in org.apache.arrow.memory">ArrowBuf</a> validityBuffer, |
| int index, |
| int value)</code> |
| <div class="block">Set the bit at a given index to provided value (1 or 0).</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>static void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/vector/BitVectorHelper.html#unsetBit-org.apache.arrow.memory.ArrowBuf-int-">unsetBit</a></span>(<a href="../../../../org/apache/arrow/memory/ArrowBuf.html" title="class in org.apache.arrow.memory">ArrowBuf</a> validityBuffer, |
| int index)</code> |
| <div class="block">Set the bit at provided index to 0.</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"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="byteIndex-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>byteIndex</h4> |
| <pre>public static long byteIndex(long absoluteBitIndex)</pre> |
| <div class="block">Get the index of byte corresponding to bit index in validity buffer.</div> |
| </li> |
| </ul> |
| <a name="bitIndex-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>bitIndex</h4> |
| <pre>public static int bitIndex(long absoluteBitIndex)</pre> |
| <div class="block">Get the relative index of bit within the byte in validity buffer.</div> |
| </li> |
| </ul> |
| <a name="byteIndex-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>byteIndex</h4> |
| <pre>public static int byteIndex(int absoluteBitIndex)</pre> |
| <div class="block">Get the index of byte corresponding to bit index in validity buffer.</div> |
| </li> |
| </ul> |
| <a name="bitIndex-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>bitIndex</h4> |
| <pre>public static int bitIndex(int absoluteBitIndex)</pre> |
| <div class="block">Get the relative index of bit within the byte in validity buffer.</div> |
| </li> |
| </ul> |
| <a name="setBit-org.apache.arrow.memory.ArrowBuf-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setBit</h4> |
| <pre>public static void setBit(<a href="../../../../org/apache/arrow/memory/ArrowBuf.html" title="class in org.apache.arrow.memory">ArrowBuf</a> validityBuffer, |
| long index)</pre> |
| <div class="block">Set the bit at provided index to 1.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>validityBuffer</code> - validity buffer of the vector</dd> |
| <dd><code>index</code> - index to be set</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="unsetBit-org.apache.arrow.memory.ArrowBuf-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>unsetBit</h4> |
| <pre>public static void unsetBit(<a href="../../../../org/apache/arrow/memory/ArrowBuf.html" title="class in org.apache.arrow.memory">ArrowBuf</a> validityBuffer, |
| int index)</pre> |
| <div class="block">Set the bit at provided index to 0.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>validityBuffer</code> - validity buffer of the vector</dd> |
| <dd><code>index</code> - index to be set</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setValidityBit-org.apache.arrow.memory.ArrowBuf-int-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setValidityBit</h4> |
| <pre>public static void setValidityBit(<a href="../../../../org/apache/arrow/memory/ArrowBuf.html" title="class in org.apache.arrow.memory">ArrowBuf</a> validityBuffer, |
| int index, |
| int value)</pre> |
| <div class="block">Set the bit at a given index to provided value (1 or 0).</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>validityBuffer</code> - validity buffer of the vector</dd> |
| <dd><code>index</code> - index to be set</dd> |
| <dd><code>value</code> - value to set</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setValidityBit-org.apache.arrow.memory.ArrowBuf-org.apache.arrow.memory.BufferAllocator-int-int-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setValidityBit</h4> |
| <pre>public static <a href="../../../../org/apache/arrow/memory/ArrowBuf.html" title="class in org.apache.arrow.memory">ArrowBuf</a> setValidityBit(<a href="../../../../org/apache/arrow/memory/ArrowBuf.html" title="class in org.apache.arrow.memory">ArrowBuf</a> validityBuffer, |
| <a href="../../../../org/apache/arrow/memory/BufferAllocator.html" title="interface in org.apache.arrow.memory">BufferAllocator</a> allocator, |
| int valueCount, |
| int index, |
| int value)</pre> |
| <div class="block">Set the bit at a given index to provided value (1 or 0). Internally |
| takes care of allocating the buffer if the caller didn't do so.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>validityBuffer</code> - validity buffer of the vector</dd> |
| <dd><code>allocator</code> - allocator for the buffer</dd> |
| <dd><code>valueCount</code> - number of values to allocate/set</dd> |
| <dd><code>index</code> - index to be set</dd> |
| <dd><code>value</code> - value to set</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>ArrowBuf</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="get-org.apache.arrow.memory.ArrowBuf-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>get</h4> |
| <pre>public static int get(<a href="../../../../org/apache/arrow/memory/ArrowBuf.html" title="class in org.apache.arrow.memory">ArrowBuf</a> buffer, |
| int index)</pre> |
| <div class="block">Check if a bit at a given index is set or not.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>buffer</code> - buffer to check</dd> |
| <dd><code>index</code> - index of the buffer</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>1 if bit is set, 0 otherwise.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getValidityBufferSize-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getValidityBufferSize</h4> |
| <pre>public static int getValidityBufferSize(int valueCount)</pre> |
| <div class="block">Compute the size of validity buffer required to manage a given number |
| of elements in a vector.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>valueCount</code> - number of elements in the vector</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>buffer size</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getNullCount-org.apache.arrow.memory.ArrowBuf-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getNullCount</h4> |
| <pre>public static int getNullCount(<a href="../../../../org/apache/arrow/memory/ArrowBuf.html" title="class in org.apache.arrow.memory">ArrowBuf</a> validityBuffer, |
| int valueCount)</pre> |
| <div class="block">Given a validity buffer, find the number of bits that are not set. |
| This is used to compute the number of null elements in a nullable vector.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>validityBuffer</code> - validity buffer of the vector</dd> |
| <dd><code>valueCount</code> - number of values in the vector</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>number of bits not set.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="checkAllBitsEqualTo-org.apache.arrow.memory.ArrowBuf-int-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>checkAllBitsEqualTo</h4> |
| <pre>public static boolean checkAllBitsEqualTo(<a href="../../../../org/apache/arrow/memory/ArrowBuf.html" title="class in org.apache.arrow.memory">ArrowBuf</a> validityBuffer, |
| int valueCount, |
| boolean checkOneBits)</pre> |
| <div class="block">Tests if all bits in a validity buffer are equal 0 or 1, according to the specified parameter.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>validityBuffer</code> - the validity buffer.</dd> |
| <dd><code>valueCount</code> - the bit count.</dd> |
| <dd><code>checkOneBits</code> - if set to true, the method checks if all bits are equal to 1; |
| otherwise, it checks if all bits are equal to 0.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if all bits are 0 or 1 according to the parameter, and false otherwise.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getBitsFromCurrentByte-org.apache.arrow.memory.ArrowBuf-int-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getBitsFromCurrentByte</h4> |
| <pre>public static byte getBitsFromCurrentByte(<a href="../../../../org/apache/arrow/memory/ArrowBuf.html" title="class in org.apache.arrow.memory">ArrowBuf</a> data, |
| int index, |
| int offset)</pre> |
| <div class="block">Returns the byte at index from data right-shifted by offset.</div> |
| </li> |
| </ul> |
| <a name="getBitsFromNextByte-org.apache.arrow.memory.ArrowBuf-int-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getBitsFromNextByte</h4> |
| <pre>public static byte getBitsFromNextByte(<a href="../../../../org/apache/arrow/memory/ArrowBuf.html" title="class in org.apache.arrow.memory">ArrowBuf</a> data, |
| int index, |
| int offset)</pre> |
| <div class="block">Returns the byte at <code>index</code> from left-shifted by (8 - <code>offset</code>).</div> |
| </li> |
| </ul> |
| <a name="loadValidityBuffer-org.apache.arrow.vector.ipc.message.ArrowFieldNode-org.apache.arrow.memory.ArrowBuf-org.apache.arrow.memory.BufferAllocator-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>loadValidityBuffer</h4> |
| <pre>public static <a href="../../../../org/apache/arrow/memory/ArrowBuf.html" title="class in org.apache.arrow.memory">ArrowBuf</a> loadValidityBuffer(<a href="../../../../org/apache/arrow/vector/ipc/message/ArrowFieldNode.html" title="class in org.apache.arrow.vector.ipc.message">ArrowFieldNode</a> fieldNode, |
| <a href="../../../../org/apache/arrow/memory/ArrowBuf.html" title="class in org.apache.arrow.memory">ArrowBuf</a> sourceValidityBuffer, |
| <a href="../../../../org/apache/arrow/memory/BufferAllocator.html" title="interface in org.apache.arrow.memory">BufferAllocator</a> allocator)</pre> |
| <div class="block">Returns a new buffer if the source validity buffer is either all null or all |
| not-null, otherwise returns a buffer pointing to the same memory as source.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>fieldNode</code> - The fieldNode containing the null count</dd> |
| <dd><code>sourceValidityBuffer</code> - The source validity buffer that will have its |
| position copied if there is a mix of null and non-null values</dd> |
| <dd><code>allocator</code> - The allocator to use for creating a new buffer if necessary.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A new buffer that is either allocated or points to the same memory as sourceValidityBuffer.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="concatBits-org.apache.arrow.memory.ArrowBuf-int-org.apache.arrow.memory.ArrowBuf-int-org.apache.arrow.memory.ArrowBuf-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>concatBits</h4> |
| <pre>public static void concatBits(<a href="../../../../org/apache/arrow/memory/ArrowBuf.html" title="class in org.apache.arrow.memory">ArrowBuf</a> input1, |
| int numBits1, |
| <a href="../../../../org/apache/arrow/memory/ArrowBuf.html" title="class in org.apache.arrow.memory">ArrowBuf</a> input2, |
| int numBits2, |
| <a href="../../../../org/apache/arrow/memory/ArrowBuf.html" title="class in org.apache.arrow.memory">ArrowBuf</a> output)</pre> |
| <div class="block">Concat two validity buffers.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>input1</code> - the first validity buffer.</dd> |
| <dd><code>numBits1</code> - the number of bits in the first validity buffer.</dd> |
| <dd><code>input2</code> - the second validity buffer.</dd> |
| <dd><code>numBits2</code> - the number of bits in the second validity buffer.</dd> |
| <dd><code>output</code> - the output validity buffer. It can be the same one as the first input. |
| The caller must make sure the output buffer has enough capacity.</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/BitVectorHelper.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/vector/BitVector.html" title="class in org.apache.arrow.vector"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/arrow/vector/BitVectorHelperBenchmarks.html" title="class in org.apache.arrow.vector"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/arrow/vector/BitVectorHelper.html" target="_top">Frames</a></li> |
| <li><a href="BitVectorHelper.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>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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> |
