Package io.deephaven.engine.table.impl.by

Class LongChunkedSumOperator

java.lang.Object

io.deephaven.engine.table.impl.by.LongChunkedSumOperator

All Implemented Interfaces:

ChunkSource<Values>, FillContextMaker, GetContextMaker, IterativeChunkedAggregationOperator

public class LongChunkedSumOperator
extends Object
implements IterativeChunkedAggregationOperator, ChunkSource<Values>

Iterative sum operator, extended for absolute values and regular sums.

Nested Class Summary

Nested classes/interfaces inherited from interface io.deephaven.engine.table.ChunkSource

ChunkSource.FillContext, ChunkSource.GetContext, ChunkSource.WithPrev<ATTR extends Any>

Nested classes/interfaces inherited from interface io.deephaven.engine.table.impl.by.IterativeChunkedAggregationOperator

IterativeChunkedAggregationOperator.BucketedContext, IterativeChunkedAggregationOperator.SingletonContext

Field Summary

Fields inherited from interface io.deephaven.engine.table.ChunkSource

DEFAULT_FILL_INSTANCE, ZERO_LENGTH_CHUNK_SOURCE_ARRAY

Fields inherited from interface io.deephaven.engine.table.impl.by.IterativeChunkedAggregationOperator

ZERO_LENGTH_ITERATIVE_CHUNKED_AGGREGATION_OPERATOR_ARRAY

Method Summary

Modifier and Type	Method	Description
void	addChunk(IterativeChunkedAggregationOperator.BucketedContext context, Chunk<? extends Values> values, LongChunk<? extends RowKeys> inputRowKeys, IntChunk<RowKeys> destinations, IntChunk<ChunkPositions> startPositions, IntChunk<ChunkLengths> length, WritableBooleanChunk<Values> stateModified)	Aggregate a chunk of data into the result columns.
boolean	addChunk(IterativeChunkedAggregationOperator.SingletonContext context, int chunkSize, Chunk<? extends Values> values, LongChunk<? extends RowKeys> inputRowKeys, long destination)	Aggregate a chunk of data into the result columns.
void	ensureCapacity(long tableSize)	Ensure that this operator can handle destinations up to tableSize - 1.
void	fillChunk(@NotNull ChunkSource.FillContext context, @NotNull WritableChunk<? super Values> destination, @NotNull RowSequence rowSequence)	Populates the given destination chunk with data corresponding to the keys from the given RowSequence.
Chunk<? extends Values>	getChunk(@NotNull ChunkSource.GetContext context, long firstKey, long lastKey)	Same as ChunkSource.getChunk(GetContext, RowSequence), except that you pass in the begin and last keys representing the begin and last (inclusive) keys of a single range rather than an RowSequence.
Chunk<? extends Values>	getChunk(@NotNull ChunkSource.GetContext context, @NotNull RowSequence rowSequence)	Returns a chunk of data corresponding to the keys from the given RowSequence.
ChunkType	getChunkType()	Get the most suitable ChunkType for use with this ChunkSource.
Map<String,? extends ColumnSource<?>>	getResultColumns()	Return a map of result columns produced by this operator.
ChunkSource.FillContext	makeFillContext(int chunkCapacity, SharedContext sharedContext)	Allocate a new ChunkSource.FillContext for filling chunks from this FillContextMaker, typically a ChunkSource.
ChunkSource.GetContext	makeGetContext(int chunkCapacity, SharedContext sharedContext)	Allocate a new ChunkSource.GetContext for retrieving chunks from this GetContextMaker, typically a ChunkSource.
void	modifyChunk(IterativeChunkedAggregationOperator.BucketedContext context, Chunk<? extends Values> previousValues, Chunk<? extends Values> newValues, LongChunk<? extends RowKeys> postShiftRowKeys, IntChunk<RowKeys> destinations, IntChunk<ChunkPositions> startPositions, IntChunk<ChunkLengths> length, WritableBooleanChunk<Values> stateModified)	Modify a chunk of data previously aggregated into the result columns using a parallel chunk of new values.
boolean	modifyChunk(IterativeChunkedAggregationOperator.SingletonContext context, int chunkSize, Chunk<? extends Values> previousValues, Chunk<? extends Values> newValues, LongChunk<? extends RowKeys> postShiftRowKeys, long destination)	Modify a chunk of data previously aggregated into the result columns using a parallel chunk of new values.
void	removeChunk(IterativeChunkedAggregationOperator.BucketedContext context, Chunk<? extends Values> values, LongChunk<? extends RowKeys> inputRowKeys, IntChunk<RowKeys> destinations, IntChunk<ChunkPositions> startPositions, IntChunk<ChunkLengths> length, WritableBooleanChunk<Values> stateModified)	Remove a chunk of data previously aggregated into the result columns.
boolean	removeChunk(IterativeChunkedAggregationOperator.SingletonContext context, int chunkSize, Chunk<? extends Values> values, LongChunk<? extends RowKeys> inputRowKeys, long destination)	Remove a chunk of data previously aggregated into the result columns.
void	startTrackingPrevValues()	Called after initialization; when the operator's result columns must have previous tracking enabled.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.deephaven.engine.table.FillContextMaker

makeFillContext

Methods inherited from interface io.deephaven.engine.table.GetContextMaker

makeGetContext

Methods inherited from interface io.deephaven.engine.table.impl.by.IterativeChunkedAggregationOperator

addRowSet, initializeRefreshing, makeBucketedContext, makeSingletonContext, modifyRowKeys, modifyRowKeys, propagateFailure, propagateInitialState, propagateUpdates, requiresRowKeys, requiresRunFinds, resetForStep, shiftChunk, shiftChunk, unchunkedRowSet

Method Details

addChunk

public void addChunk(IterativeChunkedAggregationOperator.BucketedContext context,
 Chunk<? extends Values> values,
 LongChunk<? extends RowKeys> inputRowKeys,
 IntChunk<RowKeys> destinations,
 IntChunk<ChunkPositions> startPositions,
 IntChunk<ChunkLengths> length,
 WritableBooleanChunk<Values> stateModified)

Description copied from interface: IterativeChunkedAggregationOperator

Aggregate a chunk of data into the result columns.

Specified by:

addChunk in interface IterativeChunkedAggregationOperator

Parameters:

context - the operator-specific context

values - a chunk of values to aggregate

inputRowKeys - the input row keys, in post-shift space

destinations - the destinations in resultColumn to aggregate into, parallel with startPositions and length

startPositions - the starting positions in the chunk for each destination

length - the number of values in the chunk for each destination

stateModified - a boolean output array, parallel to destinations, which is set to true if the corresponding destination has been modified

removeChunk

public void removeChunk(IterativeChunkedAggregationOperator.BucketedContext context,
 Chunk<? extends Values> values,
 LongChunk<? extends RowKeys> inputRowKeys,
 IntChunk<RowKeys> destinations,
 IntChunk<ChunkPositions> startPositions,
 IntChunk<ChunkLengths> length,
 WritableBooleanChunk<Values> stateModified)

Description copied from interface: IterativeChunkedAggregationOperator

Remove a chunk of data previously aggregated into the result columns.

Specified by:

removeChunk in interface IterativeChunkedAggregationOperator

Parameters:

context - the operator-specific context

values - a chunk of values that have been previously aggregated.

inputRowKeys - the input row keys, in pre-shift space

destinations - the destinations in resultColumn to remove the values from, parallel with startPositions and length

startPositions - the starting positions in the chunk for each destination

length - the number of values in the chunk for each destination

stateModified - a boolean output array, parallel to destinations, which is set to true if the corresponding destination has been modified

addChunk

public boolean addChunk(IterativeChunkedAggregationOperator.SingletonContext context,
 int chunkSize,
 Chunk<? extends Values> values,
 LongChunk<? extends RowKeys> inputRowKeys,
 long destination)

Description copied from interface: IterativeChunkedAggregationOperator

Aggregate a chunk of data into the result columns.

Specified by:

addChunk in interface IterativeChunkedAggregationOperator

Parameters:

context - the operator-specific context

chunkSize - the size of the addition

values - the values to aggregate

inputRowKeys - the input row keys, in post-shift space

destination - the destination in the result columns

Returns:

true if the state was modified, false otherwise

removeChunk

public boolean removeChunk(IterativeChunkedAggregationOperator.SingletonContext context,
 int chunkSize,
 Chunk<? extends Values> values,
 LongChunk<? extends RowKeys> inputRowKeys,
 long destination)

Description copied from interface: IterativeChunkedAggregationOperator

Remove a chunk of data previously aggregated into the result columns.

Specified by:

removeChunk in interface IterativeChunkedAggregationOperator

Parameters:

context - the operator-specific context

chunkSize - the size of the removal

values - the values to remove from the aggregation

inputRowKeys - the input row keys, in pre-shift space

destination - the destination in the result columns

Returns:

true if the state was modified, false otherwise

modifyChunk

public void modifyChunk(IterativeChunkedAggregationOperator.BucketedContext context,
 Chunk<? extends Values> previousValues,
 Chunk<? extends Values> newValues,
 LongChunk<? extends RowKeys> postShiftRowKeys,
 IntChunk<RowKeys> destinations,
 IntChunk<ChunkPositions> startPositions,
 IntChunk<ChunkLengths> length,
 WritableBooleanChunk<Values> stateModified)

Description copied from interface: IterativeChunkedAggregationOperator

Modify a chunk of data previously aggregated into the result columns using a parallel chunk of new values. Never includes modifies that have been shifted if IterativeChunkedAggregationOperator.requiresRowKeys() returns true - those are handled in IterativeChunkedAggregationOperator.shiftChunk(BucketedContext, Chunk, Chunk, LongChunk, LongChunk, IntChunk, IntChunk, IntChunk, WritableBooleanChunk).

Specified by:

modifyChunk in interface IterativeChunkedAggregationOperator

Parameters:

context - the operator-specific context

previousValues - a chunk of values that have been previously aggregated

newValues - a chunk of values to aggregate

postShiftRowKeys - the input row keys, in post-shift space

destinations - the destinations in resultColumn to remove the values from, parallel with startPositions and length

startPositions - the starting positions in the chunk for each destination

length - the number of values in the chunk for each destination

stateModified - a boolean output array, parallel to destinations, which is set to true if the corresponding destination has been modified

modifyChunk

public boolean modifyChunk(IterativeChunkedAggregationOperator.SingletonContext context,
 int chunkSize,
 Chunk<? extends Values> previousValues,
 Chunk<? extends Values> newValues,
 LongChunk<? extends RowKeys> postShiftRowKeys,
 long destination)

Description copied from interface: IterativeChunkedAggregationOperator

Modify a chunk of data previously aggregated into the result columns using a parallel chunk of new values. Never includes modifies that have been shifted if IterativeChunkedAggregationOperator.requiresRowKeys() returns true - those are handled in IterativeChunkedAggregationOperator.shiftChunk(SingletonContext, Chunk, Chunk, LongChunk, LongChunk, long).

Specified by:

modifyChunk in interface IterativeChunkedAggregationOperator

Parameters:

context - the operator-specific context

chunkSize - the size of the modification

previousValues - a chunk of values that have been previously aggregated.

newValues - a chunk of values to aggregate

postShiftRowKeys - the input row keys, in post-shift space

Returns:

true if the state was modified, false otherwise

ensureCapacity

public void ensureCapacity(long tableSize)

Description copied from interface: IterativeChunkedAggregationOperator

Ensure that this operator can handle destinations up to tableSize - 1.

Specified by:

ensureCapacity in interface IterativeChunkedAggregationOperator

Parameters:

tableSize - the new size of the table

getResultColumns

public Map<String,? extends ColumnSource<?>> getResultColumns()

Description copied from interface: IterativeChunkedAggregationOperator

Return a map of result columns produced by this operator.

Specified by:

getResultColumns in interface IterativeChunkedAggregationOperator

Returns:

a map of name to columns for the result table

startTrackingPrevValues

public void startTrackingPrevValues()

Description copied from interface: IterativeChunkedAggregationOperator

Called after initialization; when the operator's result columns must have previous tracking enabled.

Specified by:

startTrackingPrevValues in interface IterativeChunkedAggregationOperator

getChunkType

public ChunkType getChunkType()

Description copied from interface: ChunkSource

Get the most suitable ChunkType for use with this ChunkSource.

Specified by:

getChunkType in interface ChunkSource<Values>

Returns:

The ChunkType

getChunk

public Chunk<? extends Values> getChunk(@NotNull
 @NotNull ChunkSource.GetContext context,
 @NotNull
 @NotNull RowSequence rowSequence)

Description copied from interface: ChunkSource

Returns a chunk of data corresponding to the keys from the given RowSequence.

Specified by:

getChunk in interface ChunkSource<Values>

Parameters:

context - A context containing all mutable/state related data used in retrieving the Chunk. In particular, the Context may be used to provide a Chunk data pool

rowSequence - An RowSequence representing the keys to be fetched

Returns:

A chunk of data corresponding to the keys from the given RowSequence

getChunk

public Chunk<? extends Values> getChunk(@NotNull
 @NotNull ChunkSource.GetContext context,
 long firstKey,
 long lastKey)

Description copied from interface: ChunkSource

Same as ChunkSource.getChunk(GetContext, RowSequence), except that you pass in the begin and last keys representing the begin and last (inclusive) keys of a single range rather than an RowSequence. Typically you want to call this only if you don't have an RowSequence, such as during an RowSequence.forAllRowKeyRanges(LongRangeConsumer) call. In this case, it allows you to avoid creating an intermediary RowSequence object.

Specified by:

getChunk in interface ChunkSource<Values>

Parameters:

context - A context containing all mutable/state related data used in retrieving the Chunk. In particular, the Context may be used to provide a Chunk data pool

firstKey - The beginning key (inclusive) of the range to fetch in the chunk

lastKey - The last key (inclusive) of the range to fetch in the chunk

fillChunk

public void fillChunk(@NotNull
 @NotNull ChunkSource.FillContext context,
 @NotNull
 @NotNull WritableChunk<? super Values> destination,
 @NotNull
 @NotNull RowSequence rowSequence)

Description copied from interface: ChunkSource

Populates the given destination chunk with data corresponding to the keys from the given RowSequence.

Specified by:

fillChunk in interface ChunkSource<Values>

Parameters:

context - A context containing all mutable/state related data used in retrieving the Chunk.

destination - The chunk to be populated according to rowSequence. No assumptions shall be made about the size of the chunk shall be made. The chunk will be populated from position [0,rowSequence.size()).

rowSequence - An RowSequence representing the keys to be fetched

makeFillContext

public ChunkSource.FillContext makeFillContext(int chunkCapacity,
 SharedContext sharedContext)

Description copied from interface: FillContextMaker

Allocate a new ChunkSource.FillContext for filling chunks from this FillContextMaker, typically a ChunkSource.

Specified by:

makeFillContext in interface FillContextMaker

Parameters:

chunkCapacity - The maximum size of any WritableChunk that will be filled with this context

sharedContext - Shared store of intermediate results.

Returns:

A context for use with fill operations

makeGetContext

public ChunkSource.GetContext makeGetContext(int chunkCapacity,
 SharedContext sharedContext)

Description copied from interface: GetContextMaker

Allocate a new ChunkSource.GetContext for retrieving chunks from this GetContextMaker, typically a ChunkSource.

Specified by:

makeGetContext in interface GetContextMaker

Parameters:

chunkCapacity - The maximum size required for any WritableChunk allocated as part of the result.

sharedContext - Shared store of intermediate results.

Returns:

A context for use with get operations