Module org.elasticsearch.compute

Package org.elasticsearch.compute.data

Interface ExponentialHistogramBlock

All Superinterfaces:

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

All Known Implementing Classes:

ConstantNullBlock

public sealed interface ExponentialHistogramBlock
extends Block
permits ConstantNullBlock (not exhaustive)

A block that holds ExponentialHistogram values.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	ExponentialHistogramBlock.Component	Exponential histograms are composite data types.
static interface	ExponentialHistogramBlock.SerializedInput	Abstraction to use for reading individual serialized via ExponentialHistogramBlockBuilder.deserializeAndAppend(SerializedInput).
static interface	ExponentialHistogramBlock.SerializedOutput	Abstraction to use for writing individual values via serializeExponentialHistogram(int, SerializedOutput, BytesRef).

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

Block.Builder, Block.MvOrdering

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
Block	buildExponentialHistogramComponentBlock(ExponentialHistogramBlock.Component component)	Returns a block holding the specified component of the exponential histogram at each position.
static boolean	equals(ExponentialHistogramBlock blockA, ExponentialHistogramBlock blockB)
ExponentialHistogram	getExponentialHistogram(int valueIndex, ExponentialHistogramScratch scratch)	Returns the ExponentialHistogram value at the given index.
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).

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

getChildResources, ramBytesUsed

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

allowPassingToDifferentDriver, areAllValuesNull, asVector, blockFactory, deepCopy, doesHaveMultivaluedFields, elementType, expand, filter, getFirstValueIndex, getPositionCount, getTotalValueCount, getValueCount, insertNulls, isNull, isReleased, keepMask, lookup, mayHaveMultivaluedFields, mayHaveNulls, mvDeduplicated, mvOrdering, mvSortedAscending, writeTo

Methods inherited from interface org.elasticsearch.core.RefCounted

decRef, hasReferences, incRef, mustIncRef, tryIncRef

Methods inherited from interface org.elasticsearch.core.Releasable

close

Method Details

getExponentialHistogram

ExponentialHistogram getExponentialHistogram(int valueIndex,
 ExponentialHistogramScratch scratch)

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.

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

buildExponentialHistogramComponentBlock

Block buildExponentialHistogramComponentBlock(ExponentialHistogramBlock.Component component)

Returns a block holding the specified component of the exponential 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.

Parameters:

component - the component to extract

Returns:

the block containing the specified component

serializeExponentialHistogram

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

Parameters:

valueIndex -

out -

scratch -

equals

static boolean equals(ExponentialHistogramBlock blockA,
 ExponentialHistogramBlock blockB)