Module org.elasticsearch.compute

Package org.elasticsearch.compute.data.arrow

Class BooleanArrowBufBlock

java.lang.Object

org.elasticsearch.compute.data.AbstractNonThreadSafeRefCounted

org.elasticsearch.compute.data.arrow.AbstractArrowBufBlock<BooleanVector,BooleanBlock>

org.elasticsearch.compute.data.arrow.BooleanArrowBufBlock

All Implemented Interfaces:

Closeable, AutoCloseable, org.apache.lucene.util.Accountable, Writeable, Block, BooleanBlock, RefCounted, Releasable, BlockLoader.Block

public final class BooleanArrowBufBlock
extends AbstractArrowBufBlock<BooleanVector,BooleanBlock>
implements BooleanBlock

Arrow buffer backed BooleanBlock. Booleans are bit-packed in Arrow (1 bit per value), so this class overrides filter(boolean, int[], int, int) and lookup(org.elasticsearch.compute.data.IntBlock, org.elasticsearch.common.unit.ByteSizeValue) with bit-level implementations. The inherited AbstractArrowBufBlock.keepMask(org.elasticsearch.compute.data.BooleanVector) and AbstractArrowBufBlock.expand() work unchanged since they only manipulate validity and offset buffers.

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.compute.data.Block

Block.Builder, Block.MvOrdering

Nested classes/interfaces inherited from interface org.elasticsearch.compute.data.BooleanBlock

BooleanBlock.Builder

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields inherited from class org.elasticsearch.compute.data.arrow.AbstractArrowBufBlock

blockFactory, closed, offsetBuffer, offsetCount, validityBuffer, valueBuffer, valueCount

Fields inherited from interface org.apache.lucene.util.Accountable

NULL_ACCOUNTABLE

Fields inherited from interface org.elasticsearch.compute.data.Block

ESQL_AGGREGATE_METRIC_DOUBLE_BLOCK, MAX_LOOKUP, PAGE_MEM_OVERHEAD_PER_BLOCK, SERIALIZE_BLOCK_ARRAY, SERIALIZE_BLOCK_BIG_ARRAY, SERIALIZE_BLOCK_ORDINAL, SERIALIZE_BLOCK_VALUES, SERIALIZE_BLOCK_VECTOR

Fields inherited from interface org.elasticsearch.core.RefCounted

ALWAYS_REFERENCED

Constructor Summary

Constructors

Constructor	Description
BooleanArrowBufBlock(org.apache.arrow.memory.ArrowBuf valueBuffer, org.apache.arrow.memory.ArrowBuf validityBuffer, org.apache.arrow.memory.ArrowBuf offsetBuffer, int valueCount, int offsetCount, BlockFactory blockFactory)

Method Summary

Modifier and Type	Method	Description
protected ArrowBufBlockConstructor<BooleanBlock>	blockConstructor()
protected int	byteSize()
ElementType	elementType()	Returns the element type of this block.
BooleanBlock	filter(boolean mayContainDuplicates, int[] positions, int offset, int length)	Creates a new block that only exposes the positions provided.
boolean	getBoolean(int valueIndex)	Retrieves the boolean value stored at the given value index.
ReleasableIterator<? extends BooleanBlock>	lookup(IntBlock positions, ByteSizeValue targetBlockSize)	Builds an Iterator of new Blocks with the same Block.elementType() as this Block whose values are copied from positions in this Block.
static BooleanBlock	of(org.apache.arrow.vector.BitVector bitVector, BlockFactory blockFactory)
ToMask	toMask()	Convert this to a "mask" that's appropriate for passing to BooleanBlock.keepMask(org.elasticsearch.compute.data.BooleanVector).
int	valueMaxByteSize()	The maximum size in bytes of any single value stored in this block, or 0 if there are no values.
protected ArrowBufVectorConstructor<BooleanVector>	vectorConstructor()

Methods inherited from class org.elasticsearch.compute.data.arrow.AbstractArrowBufBlock

allowPassingToDifferentDriver, areAllValuesNull, asVector, blockFactory, closeInternal, doesHaveMultivaluedFields, expand, getFirstValueIndex, getPositionCount, getTotalValueCount, getValueCount, isNull, keepMask, mayHaveMultivaluedFields, mayHaveNulls, mvOrdering, ramBytesUsed, releaseBuffers, retainBuffers, setValidityBit, validityBufferLength

Methods inherited from class org.elasticsearch.compute.data.AbstractNonThreadSafeRefCounted

attachReleasable, close, decRef, hasReferences, incRef, isReleased, tryIncRef

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.lucene.util.Accountable

getChildResources, ramBytesUsed

Methods inherited from interface org.elasticsearch.compute.data.Block

allowPassingToDifferentDriver, areAllValuesNull, attachReleasable, blockFactory, doesHaveMultivaluedFields, getFirstValueIndex, getPositionCount, getTotalValueCount, getValueCount, insertNulls, isNull, isReleased, mayHaveMultivaluedFields, mayHaveNulls, mvDeduplicated, mvOrdering, mvSortedAscending

Methods inherited from interface org.elasticsearch.compute.data.BooleanBlock

asVector, deepCopy, equals, expand, filter, hashCode, hasValue, keepMask, slice, writeTo

Methods inherited from interface org.elasticsearch.core.RefCounted

decRef, hasReferences, incRef, mustIncRef, tryIncRef

Methods inherited from interface org.elasticsearch.core.Releasable

close

Constructor Details

BooleanArrowBufBlock

public BooleanArrowBufBlock(org.apache.arrow.memory.ArrowBuf valueBuffer,
 @Nullable
 org.apache.arrow.memory.ArrowBuf validityBuffer,
 @Nullable
 org.apache.arrow.memory.ArrowBuf offsetBuffer,
 int valueCount,
 int offsetCount,
 BlockFactory blockFactory)

Method Details

of

public static BooleanBlock of(org.apache.arrow.vector.BitVector bitVector,
 BlockFactory blockFactory)

byteSize

protected int byteSize()

Specified by:

byteSize in class AbstractArrowBufBlock<BooleanVector,BooleanBlock>

vectorConstructor

protected ArrowBufVectorConstructor<BooleanVector> vectorConstructor()

Specified by:

vectorConstructor in class AbstractArrowBufBlock<BooleanVector,BooleanBlock>

blockConstructor

protected ArrowBufBlockConstructor<BooleanBlock> blockConstructor()

Specified by:

blockConstructor in class AbstractArrowBufBlock<BooleanVector,BooleanBlock>

getBoolean

public boolean getBoolean(int valueIndex)

Description copied from interface: BooleanBlock

Retrieves the boolean value stored at the given value index.

The valueIndex for a position is between.

   int start = getFirstValueIndex(position);
   int end = start + getValueCount(position);

Specified by:

getBoolean in interface BooleanBlock

Parameters:

valueIndex - the value index

Returns:

the data value (as a boolean)

elementType

public ElementType elementType()

Description copied from interface: Block

Returns the element type of this block.

Specified by:

elementType in interface Block

Returns:

the element type of this block

valueMaxByteSize

public int valueMaxByteSize()

Description copied from interface: BooleanBlock

The maximum size in bytes of any single value stored in this block, or 0 if there are no values. Always Byte.BYTES since all boolean values encode to the same number of bytes.

Specified by:

valueMaxByteSize in interface Block

Specified by:

valueMaxByteSize in interface BooleanBlock

Returns:

the maximum byte size of any single value in this block

toMask

public ToMask toMask()

Description copied from interface: BooleanBlock

Convert this to a "mask" that's appropriate for passing to BooleanBlock.keepMask(org.elasticsearch.compute.data.BooleanVector). Null and multivalued positions will be converted to false.

Specified by:

toMask in interface BooleanBlock

filter

public BooleanBlock filter(boolean mayContainDuplicates,
 int[] positions,
 int offset,
 int length)

Description copied from interface: Block

Creates a new block that only exposes the positions provided.

Specified by:

filter in interface Block

Specified by:

filter in interface BooleanBlock

Overrides:

filter in class AbstractArrowBufBlock<BooleanVector,BooleanBlock>

Parameters:

mayContainDuplicates - may the positions array contain duplicate positions?

positions - the positions to retain

offset - the start index in the positions array

length - the number of positions to use from the array

Returns:

a filtered block

lookup

public ReleasableIterator<? extends BooleanBlock> lookup(IntBlock positions,
 ByteSizeValue targetBlockSize)

Description copied from interface: Block

Builds an Iterator of new Blocks with the same Block.elementType() as this Block whose values are copied from positions in this Block. It has the same number of positions as the positions parameter.

For example, if this block contained [a, b, [b, c]] and were called with the block [0, 1, 1, [1, 2]] then the result would be [a, b, b, [b, b, c]].

This process produces count(this) * count(positions) values per positions which could be quite large. Instead of returning a single Block, this returns an Iterator of Blocks containing all of the promised values.

The returned ReleasableIterator may retain a reference to the positions parameter. Close it to release those references.

This block is built using the same BlockFactory as was used to build the positions parameter.

Specified by:

lookup in interface Block

Specified by:

lookup in interface BooleanBlock

Overrides:

lookup in class AbstractArrowBufBlock<BooleanVector,BooleanBlock>