Module org.elasticsearch.compute

Package org.elasticsearch.compute.data

Class ExponentialHistogramArrayBlock

java.lang.Object

org.elasticsearch.compute.data.AbstractNonThreadSafeRefCounted

org.elasticsearch.compute.data.AbstractDelegatingCompoundBlock<ExponentialHistogramBlock>

org.elasticsearch.compute.data.ExponentialHistogramArrayBlock

All Implemented Interfaces:

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

public final class ExponentialHistogramArrayBlock
extends AbstractDelegatingCompoundBlock<ExponentialHistogramBlock>
implements ExponentialHistogramBlock

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	ExponentialHistogramArrayBlock.EncodedHistogramData

Nested classes/interfaces inherited from class org.elasticsearch.compute.data.AbstractDelegatingCompoundBlock

AbstractDelegatingCompoundBlock.AbstractCompositeBlockBuilder<T extends Block>, AbstractDelegatingCompoundBlock.Deserializer<T extends Block>

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

ExponentialHistogramBlock.Builder, ExponentialHistogramBlock.SerializedInput, ExponentialHistogramBlock.SerializedOutput

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

HistogramBlock.Component

Nested 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_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

Method Summary

Modifier and Type	Method	Description
protected boolean	assertInvariants()
Vector	asVector()	Returns an efficient dense single-value view of this block.
protected ExponentialHistogramArrayBlock	buildFromSubBlocks(List<Block> subBlocks, int newPositionCount, int[] newFirstValueIndexes)	Construct a new instance of the block, based on the given list of sub-blocks.
DoubleBlock	buildHistogramComponentBlock(HistogramBlock.Component component)	Returns a block holding the specified component of the histogram at each position.
static ExponentialHistogramBlock	createConstant(ExponentialHistogram histogram, int positionCount, BlockFactory blockFactory)
ElementType	elementType()	Returns the element type of this block.
static ExponentialHistogramArrayBlock.EncodedHistogramData	encode(int scale, BucketIterator negativeBuckets, BucketIterator positiveBuckets, double zeroThreshold, long zeroCount, long count, double sum, double min, double max)
static ExponentialHistogramArrayBlock.EncodedHistogramData	encode(ExponentialHistogram histogram)
boolean	equals(Object o)
Block	expand()	Expand multivalued fields into one row per value.
ExponentialHistogram	getExponentialHistogram(int valueIndex, ExponentialHistogramScratch scratch)	Returns the ExponentialHistogram value at the given index.
protected List<Block>	getSubBlocks()
int	hashCode()
ReleasableIterator<? extends Block>	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 ExponentialHistogramArrayBlock	readFrom(BlockStreamInput input)
void	serializeExponentialHistogram(int valueIndex, ExponentialHistogramBlock.SerializedOutput out, org.apache.lucene.util.BytesRef scratch)	Serializes the exponential histogram at the given index into the provided output, so that it can be read back via ExponentialHistogramBlockBuilder.deserializeAndAppend(SerializedInput).
int	valueMaxByteSize()	Returns the maximum byte size of any single value in this block.
void	writeTo(StreamOutput out)	Writes only the data of the block to a stream output.

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

allowPassingToDifferentDriver, areAllValuesNull, blockFactory, closeInternal, deepCopy, doesHaveMultivaluedFields, filter, getFirstValueIndex, getPositionCount, getTotalValueCount, getValueCount, isNull, keepMask, layoutEquals, mayHaveMultivaluedFields, mayHaveNulls, mvOrdering, ramBytesUsed, readFrom, slice, writeMultiValueMetadata

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

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

Methods inherited from class java.lang.Object

clone, finalize, getClass, 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, deepCopy, doesHaveMultivaluedFields, filter, filter, getFirstValueIndex, getPositionCount, getTotalValueCount, getValueCount, insertNulls, isNull, isReleased, keepMask, mayHaveMultivaluedFields, mayHaveNulls, mvDeduplicated, mvOrdering, mvSortedAscending, slice

Methods inherited from interface org.elasticsearch.core.RefCounted

decRef, hasReferences, incRef, mustIncRef, tryIncRef

Methods inherited from interface org.elasticsearch.core.Releasable

close

Method Details

assertInvariants

protected boolean assertInvariants()

Overrides:

assertInvariants in class AbstractDelegatingCompoundBlock<ExponentialHistogramBlock>

getSubBlocks

protected List<Block> getSubBlocks()

Specified by:

getSubBlocks in class AbstractDelegatingCompoundBlock<ExponentialHistogramBlock>

Returns:

a list of the sub-blocks composing this compound block. The first block must be non-null for non-null composite values (used for null detection). The order should match the order expected by AbstractDelegatingCompoundBlock.buildFromSubBlocks(List, int, int[]).

buildFromSubBlocks

protected ExponentialHistogramArrayBlock buildFromSubBlocks(List<Block> subBlocks,
 int newPositionCount,
 @Nullable
 int[] newFirstValueIndexes)

Description copied from class: AbstractDelegatingCompoundBlock

Construct a new instance of the block, based on the given list of sub-blocks.

Specified by:

buildFromSubBlocks in class AbstractDelegatingCompoundBlock<ExponentialHistogramBlock>

Parameters:

subBlocks - List of sub-blocks, in the same order as AbstractDelegatingCompoundBlock.getSubBlocks()

newPositionCount - the number of positions in the new block

newFirstValueIndexes - the firstValueIndexes array for the new block (may be null for single-valued)

Returns:

a new instance based on the given blocks.

encode

public static ExponentialHistogramArrayBlock.EncodedHistogramData encode(ExponentialHistogram histogram)

encode

public static ExponentialHistogramArrayBlock.EncodedHistogramData encode(int scale,
 BucketIterator negativeBuckets,
 BucketIterator positiveBuckets,
 double zeroThreshold,
 long zeroCount,
 long count,
 double sum,
 double min,
 double max)

getExponentialHistogram

public ExponentialHistogram getExponentialHistogram(int valueIndex,
 ExponentialHistogramScratch scratch)

Description copied from interface: ExponentialHistogramBlock

Returns the ExponentialHistogram value at the given index. In order to be allocation free, this method requires a scratch object to be passed in, whose memory will be used to hold the state of the returned histogram. Therefore, the return value of this method is only valid until either the block is closed or the same scratch instance is passed to another call to this method on any block.

Specified by:

getExponentialHistogram in interface ExponentialHistogramBlock

Parameters:

valueIndex - the index of the histogram to get

scratch - the scratch to use as storage for the returned histogram

Returns:

the exponential histogram at the given index

createConstant

public static ExponentialHistogramBlock createConstant(ExponentialHistogram histogram,
 int positionCount,
 BlockFactory blockFactory)

buildHistogramComponentBlock

public DoubleBlock buildHistogramComponentBlock(HistogramBlock.Component component)

Description copied from interface: HistogramBlock

Returns a block holding the specified component of the histogram at each position. The number of positions in the returned block will be exactly equal to the number of positions in this block. If a position is null in this block, it will also be null in the returned block.
The caller is responsible for closing the returned block.

Specified by:

buildHistogramComponentBlock in interface HistogramBlock

Parameters:

component - the component to extract

Returns:

the block containing the specified component

serializeExponentialHistogram

public void serializeExponentialHistogram(int valueIndex,
 ExponentialHistogramBlock.SerializedOutput out,
 org.apache.lucene.util.BytesRef scratch)

Description copied from interface: ExponentialHistogramBlock

Serializes the exponential histogram at the given index into the provided output, so that it can be read back via ExponentialHistogramBlockBuilder.deserializeAndAppend(SerializedInput).

Specified by:

serializeExponentialHistogram in interface ExponentialHistogramBlock

Parameters:

valueIndex -

out -

scratch -

valueMaxByteSize

public int valueMaxByteSize()

Description copied from interface: Block

Returns the maximum byte size of any single value in this block. For fixed-width types this is a constant. For BytesRef, this scans all values quickly.

Specified by:

valueMaxByteSize in interface Block

Overrides:

valueMaxByteSize in class AbstractDelegatingCompoundBlock<ExponentialHistogramBlock>

Returns:

the maximum byte size of any single value in this block

asVector

public Vector asVector()

Description copied from interface: Block

Returns 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:

asVector in interface Block

Returns:

an efficient dense single-value view of this block

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

lookup

public ReleasableIterator<? extends Block> 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

expand

public Block expand()

Description copied from interface: Block

Expand 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:

expand in interface Block

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Block

Writes only the data of the block to a stream output. This method should be used when the type of the block is known during reading.

Specified by:

writeTo in interface Block

Specified by:

writeTo in interface Writeable

Throws:

IOException

readFrom

public static ExponentialHistogramArrayBlock readFrom(BlockStreamInput input)
                                               throws IOException

Throws:

IOException

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object