java.lang.Object
org.elasticsearch.compute.data.OrdinalBytesRefVector
- All Implemented Interfaces:
Closeable,AutoCloseable,org.apache.lucene.util.Accountable,BytesRefVector,Vector,org.elasticsearch.core.RefCounted,org.elasticsearch.core.Releasable
A
BytesRefVector consists of a pair: an IntVector for ordinals and a BytesRefVector for the dictionary.
Compared to the regular BytesRefVector, this block is slower due to indirect access and consume more memory because of
the additional ordinals vector. However, they offer significant speed improvements and reduced memory usage when byte values are
frequently repeated-
Nested Class Summary
Nested classes/interfaces inherited from interface org.elasticsearch.compute.data.BytesRefVector
BytesRefVector.Builder -
Field Summary
Fields inherited from interface org.apache.lucene.util.Accountable
NULL_ACCOUNTABLEFields inherited from interface org.elasticsearch.core.RefCounted
ALWAYS_REFERENCEDFields 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 -
Method Summary
Modifier and TypeMethodDescriptionvoidBefore passing a Vector to another Driver, it is necessary to switch the owning block factory to its parent, which is associated with the global circuit breaker.asBlock()Returns Returns a new Block containing this vector..Returns an ordinal BytesRef vector if this vector is backed by a dictionary and ordinals; otherwise, returns null.The block factory associated with this vector.final voidclose()protected voidThis is called when the number of references reaches zero.final booleandecRef()Returns the element type of this vector.filter(int... positions) Creates a new vector that only exposes the positions provided.org.apache.lucene.util.BytesRefgetBytesRef(int position, org.apache.lucene.util.BytesRef dest) intThe number of positions in this vector.final booleanfinal voidincRef()booleanReturns true iff this vector is a constant vector - returns the same constant value for every position.booleanisDense()Returns true if this ordinal vector is dense enough to enable optimizations using its ordinalsfinal booleankeepMask(BooleanVector mask) org.elasticsearch.core.ReleasableIterator<? extends BytesRefBlock> lookup(IntBlock positions, ByteSizeValue targetBlockSize) Builds an Iterator of newBlocks with the sameVector.elementType()as thisVectorwhose values are copied from positions in this Vector.longfinal booleanMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.apache.lucene.util.Accountable
getChildResourcesMethods inherited from interface org.elasticsearch.compute.data.BytesRefVector
equals, hashCode, writeToMethods inherited from interface org.elasticsearch.core.RefCounted
decRef, hasReferences, incRef, mustIncRef, tryIncRefMethods inherited from interface org.elasticsearch.core.Releasable
closeMethods inherited from interface org.elasticsearch.compute.data.Vector
isReleased
-
Constructor Details
-
OrdinalBytesRefVector
-
-
Method Details
-
isDense
public boolean isDense()Returns true if this ordinal vector is dense enough to enable optimizations using its ordinals -
getPositionCount
public int getPositionCount()Description copied from interface:VectorThe number of positions in this vector.- Specified by:
getPositionCountin interfaceVector- Returns:
- the number of positions
-
blockFactory
Description copied from interface:VectorThe block factory associated with this vector.- Specified by:
blockFactoryin interfaceVector
-
allowPassingToDifferentDriver
public void allowPassingToDifferentDriver()Description copied from interface:VectorBefore passing a Vector to another Driver, it is necessary to switch the owning block factory to its parent, which is associated with the global circuit breaker. This ensures that when the new driver releases this Vector, it returns memory directly to the parent block factory instead of the local block factory of this Block. This is important because the local block factory is not thread safe and doesn't support simultaneous access by more than one thread.- Specified by:
allowPassingToDifferentDriverin interfaceVector
-
getBytesRef
public org.apache.lucene.util.BytesRef getBytesRef(int position, org.apache.lucene.util.BytesRef dest) - Specified by:
getBytesRefin interfaceBytesRefVector
-
asBlock
Description copied from interface:VectorReturns Returns a new Block containing this vector..- Specified by:
asBlockin interfaceBytesRefVector- Specified by:
asBlockin interfaceVector- Returns:
- Returns a new Block containing this vector.
-
asOrdinals
Description copied from interface:BytesRefVectorReturns an ordinal BytesRef vector if this vector is backed by a dictionary and ordinals; otherwise, returns null. Callers must not release the returned vector as no extra reference is retained by this method.- Specified by:
asOrdinalsin interfaceBytesRefVector
-
getOrdinalsVector
-
getDictionaryVector
-
filter
Description copied from interface:VectorCreates a new vector that only exposes the positions provided. Materialization of the selected positions is avoided.- Specified by:
filterin interfaceBytesRefVector- Specified by:
filterin interfaceVector- Parameters:
positions- the positions to retain- Returns:
- a filtered vector
-
keepMask
Description copied from interface:VectorBuild aBlockthe same values as thisVector, but replacing all values for whichmask.getBooleanValue(position)returnsfalsewithnull. Themaskvector must be at least as long as this Vector.- Specified by:
keepMaskin interfaceBytesRefVector- Specified by:
keepMaskin interfaceVector
-
lookup
public org.elasticsearch.core.ReleasableIterator<? extends BytesRefBlock> lookup(IntBlock positions, ByteSizeValue targetBlockSize) Description copied from interface:VectorBuilds an Iterator of newBlocks with the sameVector.elementType()as thisVectorwhose values are copied from positions in this Vector. It has the same number ofpositionsas thepositionsparameter.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
ReleasableIteratormay retain a reference to thepositionsparameter. Close it to release those references.This block is built using the same
BlockFactoryas was used to build thepositionsparameter.- Specified by:
lookupin interfaceBytesRefVector- Specified by:
lookupin interfaceVector
-
elementType
Description copied from interface:VectorReturns the element type of this vector.- Specified by:
elementTypein interfaceVector- Returns:
- the element type of this vector
-
isConstant
public boolean isConstant()Description copied from interface:VectorReturns true iff this vector is a constant vector - returns the same constant value for every position.- Specified by:
isConstantin interfaceVector- Returns:
- true iff this vector is a constant vector - returns the same constant value for every position
-
ramBytesUsed
public long ramBytesUsed()- Specified by:
ramBytesUsedin interfaceorg.apache.lucene.util.Accountable
-
closeInternal
protected void closeInternal()This is called when the number of references reaches zero. This is where resources should be released (adjusting circuit breakers if needed). -
incRef
public final void incRef()- Specified by:
incRefin interfaceorg.elasticsearch.core.RefCounted
-
tryIncRef
public final boolean tryIncRef()- Specified by:
tryIncRefin interfaceorg.elasticsearch.core.RefCounted
-
decRef
public final boolean decRef()- Specified by:
decRefin interfaceorg.elasticsearch.core.RefCounted
-
hasReferences
public final boolean hasReferences()- Specified by:
hasReferencesin interfaceorg.elasticsearch.core.RefCounted
-
close
public final void close()- Specified by:
closein interfaceAutoCloseable- Specified by:
closein interfaceCloseable- Specified by:
closein interfaceorg.elasticsearch.core.Releasable
-
isReleased
public final boolean isReleased()
-