Module org.elasticsearch.compute

Package org.elasticsearch.compute.data.arrow

Class BooleanArrowBufVector

java.lang.Object

org.elasticsearch.compute.data.AbstractNonThreadSafeRefCounted

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

org.elasticsearch.compute.data.arrow.BooleanArrowBufVector

All Implemented Interfaces:

Closeable, AutoCloseable, org.apache.lucene.util.Accountable, BooleanVector, Vector, RefCounted, Releasable

public final class BooleanArrowBufVector
extends AbstractArrowBufVector<BooleanVector,BooleanBlock>
implements BooleanVector

Arrow buffer backed BooleanVector. Booleans are bit-packed in Arrow (1 bit per value), so this class overrides filter(boolean, int[], int, int) with a bit-level implementation.

Nested Class Summary

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

BooleanVector.Builder, BooleanVector.FixedBuilder

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

Vector.Builder

Field Summary

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

blockFactory, closed, positionCount, valueBuffer

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

NULL_ACCOUNTABLE

Fields inherited from interface org.elasticsearch.core.RefCounted

ALWAYS_REFERENCED

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

SERIALIZE_VECTOR_ARRAY, SERIALIZE_VECTOR_BIG_ARRAY, SERIALIZE_VECTOR_CONSTANT, SERIALIZE_VECTOR_ORDINAL, SERIALIZE_VECTOR_VALUES

Constructor Summary

Constructors

Constructor	Description
BooleanArrowBufVector(org.apache.arrow.memory.ArrowBuf valueBuffer, int positionCount, BlockFactory blockFactory)

Method Summary

Modifier and Type	Method	Description
boolean	allFalse()	Are all values false? This will scan all values to check and always answer accurately.
boolean	allTrue()	Are all values true? This will scan all values to check and always answer accurately.
protected ArrowBufBlockConstructor<BooleanBlock>	blockConstructor()
protected int	byteSize()
ElementType	elementType()	Returns the element type of this vector.
BooleanVector	filter(boolean mayContainDuplicates, int[] positions, int offset, int length)	Creates a new vector that only exposes the positions provided.
boolean	getBoolean(int position)
ReleasableIterator<BooleanBlock>	lookup(IntBlock positions, ByteSizeValue targetBlockSize)	Builds an Iterator of new Blocks with the same Vector.elementType() as this Vector whose values are copied from positions in this Vector.
static BooleanArrowBufVector	of(org.apache.arrow.vector.BitVector bitVector, BlockFactory blockFactory)
BooleanVector	slice(int beginInclusive, int endExclusive)	Return a subset of this vector from beginInclusive to endExclusive.
int	valueMaxByteSize()	The maximum size in bytes of any single value stored in this vector, or 0 if there are no values.
protected ArrowBufVectorConstructor<BooleanVector>	vectorConstructor()
void	writeTo(StreamOutput out)	Serializes this Vector to the given stream output.

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

allowPassingToDifferentDriver, asBlock, blockFactory, closeInternal, getPositionCount, isConstant, keepMask, ramBytesUsed, releaseBuffers, retainBuffers, valuesSegment

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.BooleanVector

asBlock, copyTo, deepCopy, equals, filter, hashCode, keepMask

Methods inherited from interface org.elasticsearch.core.RefCounted

decRef, hasReferences, incRef, mustIncRef, tryIncRef

Methods inherited from interface org.elasticsearch.core.Releasable

close

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

allowPassingToDifferentDriver, attachReleasable, blockFactory, getPositionCount, isConstant, isReleased

Constructor Details

BooleanArrowBufVector

public BooleanArrowBufVector(org.apache.arrow.memory.ArrowBuf valueBuffer,
 int positionCount,
 BlockFactory blockFactory)

Method Details

of

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

vectorConstructor

protected ArrowBufVectorConstructor<BooleanVector> vectorConstructor()

Specified by:

vectorConstructor in class AbstractArrowBufVector<BooleanVector,BooleanBlock>

blockConstructor

protected ArrowBufBlockConstructor<BooleanBlock> blockConstructor()

Specified by:

blockConstructor in class AbstractArrowBufVector<BooleanVector,BooleanBlock>

getBoolean

public boolean getBoolean(int position)

Specified by:

getBoolean in interface BooleanVector

byteSize

protected int byteSize()

Specified by:

byteSize in class AbstractArrowBufVector<BooleanVector,BooleanBlock>

elementType

public ElementType elementType()

Description copied from interface: Vector

Returns the element type of this vector.

Specified by:

elementType in interface Vector

Returns:

the element type of this vector

valueMaxByteSize

public int valueMaxByteSize()

Description copied from interface: BooleanVector

The maximum size in bytes of any single value stored in this vector, 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 BooleanVector

Specified by:

valueMaxByteSize in interface Vector

Returns:

the maximum byte size of any single value in this vector

allTrue

public boolean allTrue()

Description copied from interface: BooleanVector

Are all values true? This will scan all values to check and always answer accurately.

Specified by:

allTrue in interface BooleanVector

allFalse

public boolean allFalse()

Description copied from interface: BooleanVector

Are all values false? This will scan all values to check and always answer accurately.

Specified by:

allFalse in interface BooleanVector

slice

public BooleanVector slice(int beginInclusive,
 int endExclusive)

Description copied from interface: BooleanVector

Return a subset of this vector from beginInclusive to endExclusive. This may return the same instance if the range covers all positions, but if it does it will RefCounted.incRef() it.

Specified by:

slice in interface BooleanVector

Specified by:

slice in interface Vector

lookup

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

Description copied from interface: Vector

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

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

This process produces 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 BooleanVector

Specified by:

lookup in interface Vector

filter

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

Description copied from interface: Vector

Creates a new vector that only exposes the positions provided. Materialization of the selected positions is avoided.

Specified by:

filter in interface BooleanVector

Specified by:

filter in interface Vector

Overrides:

filter in class AbstractArrowBufVector<BooleanVector,BooleanBlock>

Parameters:

mayContainDuplicates - may the positions array contain duplicate positions?

positions - the positions array

offset - the start index in the positions array

length - the number of positions to use from the array

Returns:

a filtered vector

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: BooleanVector

Serializes this Vector to the given stream output.

Specified by:

writeTo in interface BooleanVector

Throws:

IOException