- All Implemented Interfaces:
Closeable,AutoCloseable,org.apache.lucene.util.Accountable,NamedWriteable,Writeable,Block,DoubleBlock,org.elasticsearch.core.RefCounted,org.elasticsearch.core.Releasable,BlockLoader.Block
DoubleVector. Cannot represent multi-values or nulls.
This class is generated. Edit X-VectorBlock.java.st instead.-
Nested Class Summary
Nested classes/interfaces inherited from interface org.elasticsearch.compute.data.Block
Block.Builder, Block.MvOrderingNested classes/interfaces inherited from interface org.elasticsearch.compute.data.DoubleBlock
DoubleBlock.BuilderNested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
Writeable.Reader<V>, Writeable.Writer<V> -
Field Summary
Fields inherited from interface org.apache.lucene.util.Accountable
NULL_ACCOUNTABLEFields inherited from interface org.elasticsearch.compute.data.Block
MAX_LOOKUP, PAGE_MEM_OVERHEAD_PER_BLOCK, SERIALIZE_BLOCK_ARRAY, SERIALIZE_BLOCK_BIG_ARRAY, SERIALIZE_BLOCK_ORDINAL, SERIALIZE_BLOCK_VALUES, SERIALIZE_BLOCK_VECTORFields inherited from interface org.elasticsearch.compute.data.DoubleBlock
ENTRYFields inherited from interface org.elasticsearch.core.RefCounted
ALWAYS_REFERENCED -
Method Summary
Modifier and TypeMethodDescriptionvoidBefore passing a Block to another Driver, it is necessary to switch the owning block factory to its parent, which is associated with the global circuit breaker.final booleanasVector()Returns an efficient dense single-value view of this block.The block factory associated with this block.final voidclose()voidThis is called when the number of references reaches zero.final booleandecRef()booleanDoes this block have multivalued fields? UnlikeBlock.mayHaveMultivaluedFields()this will never return a false positive.Returns the element type of this block.booleanCompares the given object with this block for equality.expand()Expand multivalued fields into one row per value.filter(int... positions) Creates a new block that only exposes the positions provided.doublegetDouble(int valueIndex) Retrieves the double value stored at the given value index.final intgetFirstValueIndex(int position) Gets the index of the first value for the given position.intReturns The number of positions in this block..final intReturns The total number of values in this block not counting nulls..final intgetValueCount(int position) Gets the number of values for the given position, possibly 0.inthashCode()Returns the hash code of this block, as defined byDoubleBlock.hash(DoubleBlock).final booleanfinal voidincRef()final booleanisNull(int position) final booleankeepMask(BooleanVector mask) org.elasticsearch.core.ReleasableIterator<? extends DoubleBlock> lookup(IntBlock positions, ByteSizeValue targetBlockSize) Builds an Iterator of newBlocks with the sameBlock.elementType()as this Block whose values are copied from positions in this Block.final booleanCan this block have multivalued fields? Blocks that returnfalsewill never return more than one fromBlock.getValueCount(int).final booleanfinal Block.MvOrderingHow are multivalued fields ordered?longtoString()final booleanMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface org.apache.lucene.util.Accountable
getChildResourcesMethods inherited from interface org.elasticsearch.compute.data.Block
areAllValuesNull, doesHaveMultivaluedFields, getFirstValueIndex, getTotalValueCount, getValueCount, insertNulls, isNull, isReleased, mayHaveMultivaluedFields, mayHaveNulls, mvDeduplicated, mvOrdering, mvSortedAscendingMethods inherited from interface org.elasticsearch.compute.data.DoubleBlock
getWriteableName, writeToMethods inherited from interface org.elasticsearch.core.RefCounted
decRef, hasReferences, incRef, mustIncRef, tryIncRefMethods inherited from interface org.elasticsearch.core.Releasable
close
-
Method Details
-
asVector
Description copied from interface:BlockReturns an efficient dense single-value view of this block.. Null, if the block is not dense single-valued. That is, if mayHaveNulls returns true, or getTotalValueCount is not equal to getPositionCount.- Specified by:
asVectorin interfaceBlock- Specified by:
asVectorin interfaceDoubleBlock- Returns:
- an efficient dense single-value view of this block
-
getDouble
public double getDouble(int valueIndex) Description copied from interface:DoubleBlockRetrieves the double value stored at the given value index.Values for a given position are between getFirstValueIndex(position) (inclusive) and getFirstValueIndex(position) + getValueCount(position) (exclusive).
- Specified by:
getDoublein interfaceDoubleBlock- Parameters:
valueIndex- the value index- Returns:
- the data value (as a double)
-
getPositionCount
public int getPositionCount()Description copied from interface:BlockReturns The number of positions in this block..- Specified by:
getPositionCountin interfaceBlock- Returns:
- The number of positions in this block.
-
elementType
Description copied from interface:BlockReturns the element type of this block.- Specified by:
elementTypein interfaceBlock- Returns:
- the element type of this block
-
filter
Description copied from interface:BlockCreates a new block that only exposes the positions provided.- Specified by:
filterin interfaceBlock- Specified by:
filterin interfaceDoubleBlock- Parameters:
positions- the positions to retain- Returns:
- a filtered block TODO: pass BlockFactory
-
keepMask
Description copied from interface:BlockBuild aBlockwith the same values as this Block, but replacing all values for whichmask.getBooleanValue(position)returnsfalsewithnull. Themaskvector must be at least as long as this Block.- Specified by:
keepMaskin interfaceBlock- Specified by:
keepMaskin interfaceDoubleBlock
-
lookup
public org.elasticsearch.core.ReleasableIterator<? extends DoubleBlock> lookup(IntBlock positions, ByteSizeValue targetBlockSize) Description copied from interface:BlockBuilds an Iterator of newBlocks with the sameBlock.elementType()as this Block whose values are copied from positions in this Block. It has the same number ofpositionsas thepositionsparameter.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
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 interfaceBlock- Specified by:
lookupin interfaceDoubleBlock
-
expand
Description copied from interface:BlockExpand multivalued fields into one row per value. Returns the same block if there aren't any multivalued fields to expand. The returned block needs to be closed by the caller to release the block's resources.- Specified by:
expandin interfaceBlock- Specified by:
expandin interfaceDoubleBlock
-
ramBytesUsed
public long ramBytesUsed()- Specified by:
ramBytesUsedin interfaceorg.apache.lucene.util.Accountable
-
equals
Description copied from interface:DoubleBlockCompares the given object with this block for equality. Returnstrueif and only if the given object is a DoubleBlock, and both blocks areequal.- Specified by:
equalsin interfaceDoubleBlock- Overrides:
equalsin classObject
-
hashCode
public int hashCode()Description copied from interface:DoubleBlockReturns the hash code of this block, as defined byDoubleBlock.hash(DoubleBlock).- Specified by:
hashCodein interfaceDoubleBlock- Overrides:
hashCodein classObject
-
toString
-
closeInternal
public void closeInternal()This is called when the number of references reaches zero. This is where resources should be released (adjusting circuit breakers if needed). -
allowPassingToDifferentDriver
public void allowPassingToDifferentDriver()Description copied from interface:BlockBefore passing a Block 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 Block, 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 interfaceBlock
-
blockFactory
Description copied from interface:BlockThe block factory associated with this block.- Specified by:
blockFactoryin interfaceBlock
-
getFirstValueIndex
public final int getFirstValueIndex(int position) Description copied from interface:BlockGets the index of the first value for the given position.- Specified by:
getFirstValueIndexin interfaceBlock
-
getTotalValueCount
public final int getTotalValueCount()Description copied from interface:BlockReturns The total number of values in this block not counting nulls..- Specified by:
getTotalValueCountin interfaceBlock- Returns:
- The total number of values in this block not counting nulls.
-
getValueCount
public final int getValueCount(int position) Description copied from interface:BlockGets the number of values for the given position, possibly 0.- Specified by:
getValueCountin interfaceBlock
-
isNull
public final boolean isNull(int position) -
mayHaveNulls
public final boolean mayHaveNulls()- Specified by:
mayHaveNullsin interfaceBlock- Returns:
- true if some values might be null. False, if all values are guaranteed to be not null.
-
areAllValuesNull
public final boolean areAllValuesNull()- Specified by:
areAllValuesNullin interfaceBlock- Returns:
- true if all values in this block are guaranteed to be null.
-
mayHaveMultivaluedFields
public final boolean mayHaveMultivaluedFields()Description copied from interface:BlockCan this block have multivalued fields? Blocks that returnfalsewill never return more than one fromBlock.getValueCount(int). This may returntruefor Blocks that do not have multivalued fields, but it will always answer quickly.- Specified by:
mayHaveMultivaluedFieldsin interfaceBlock
-
doesHaveMultivaluedFields
public boolean doesHaveMultivaluedFields()Description copied from interface:BlockDoes this block have multivalued fields? UnlikeBlock.mayHaveMultivaluedFields()this will never return a false positive. In other words, if this returnstruethen there are positions for whichBlock.getValueCount(int)will return more than 1. This will answer quickly if it can but may have to check all positions.- Specified by:
doesHaveMultivaluedFieldsin interfaceBlock
-
mvOrdering
Description copied from interface:BlockHow are multivalued fields ordered?- Specified by:
mvOrderingin interfaceBlock
-
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()
-