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

Class IntRollupUniqueOperator

java.lang.Object

io.deephaven.engine.table.impl.by.ssmcountdistinct.unique.IntRollupUniqueOperator

All Implemented Interfaces:

IterativeChunkedAggregationOperator

public class IntRollupUniqueOperator
extends Object
implements IterativeChunkedAggregationOperator

This operator computes the single unique value of a particular aggregated state. If there are no values at all the 'no value key' is used. If there are more than one values for the state, the 'non unique key' is used. it is intended to be used at the second, and higher levels of rollup.

Nested Class Summary

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.impl.by.IterativeChunkedAggregationOperator

ZERO_LENGTH_ITERATIVE_CHUNKED_AGGREGATION_OPERATOR_ARRAY

Constructor Summary

Constructors

Constructor	Description
IntRollupUniqueOperator(String name, boolean countNulls, int onlyNullsSentinel, int nonUniqueSentinel)

Method Summary

Modifier and Type	Method	Description
void	addChunk(IterativeChunkedAggregationOperator.BucketedContext bucketedContext, 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 singletonContext, 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.
Map<String,? extends ColumnSource<?>>	getResultColumns()	Return a map of result columns produced by this operator.
IterativeChunkedAggregationOperator.BucketedContext	makeBucketedContext(int size)	Make a IterativeChunkedAggregationOperator.BucketedContext suitable for this operator if necessary.
IterativeChunkedAggregationOperator.SingletonContext	makeSingletonContext(int size)	Make a IterativeChunkedAggregationOperator.SingletonContext suitable for this operator if necessary.
void	modifyChunk(IterativeChunkedAggregationOperator.BucketedContext bucketedContext, Chunk<? extends Values> preValues, Chunk<? extends Values> postValues, 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 singletonContext, int chunkSize, Chunk<? extends Values> preValues, Chunk<? extends Values> postValues, 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	propagateUpdates(@NotNull TableUpdate downstream, @NotNull RowSet newDestinations)	Perform any internal state keeping needed for destinations that were added (went from 0 keys to > 0), removed (went from > 0 keys to 0), or modified (keys added or removed, or keys modified) by this iteration.
void	removeChunk(IterativeChunkedAggregationOperator.BucketedContext bucketedContext, 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 singletonContext, 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.impl.by.IterativeChunkedAggregationOperator

addRowSet, initializeRefreshing, modifyRowKeys, modifyRowKeys, propagateFailure, propagateInitialState, requiresRowKeys, requiresRunFinds, resetForStep, shiftChunk, shiftChunk, unchunkedRowSet

Constructor Details

IntRollupUniqueOperator

public IntRollupUniqueOperator(String name,
 boolean countNulls,
 int onlyNullsSentinel,
 int nonUniqueSentinel)

Method Details

addChunk

public void addChunk(IterativeChunkedAggregationOperator.BucketedContext bucketedContext,
 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:

bucketedContext - 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 bucketedContext,
 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:

bucketedContext - 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

modifyChunk

public void modifyChunk(IterativeChunkedAggregationOperator.BucketedContext bucketedContext,
 Chunk<? extends Values> preValues,
 Chunk<? extends Values> postValues,
 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:

bucketedContext - the operator-specific context

preValues - a chunk of values that have been previously aggregated

postValues - 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

addChunk

public boolean addChunk(IterativeChunkedAggregationOperator.SingletonContext singletonContext,
 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:

singletonContext - 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 singletonContext,
 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:

singletonContext - 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 boolean modifyChunk(IterativeChunkedAggregationOperator.SingletonContext singletonContext,
 int chunkSize,
 Chunk<? extends Values> preValues,
 Chunk<? extends Values> postValues,
 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:

singletonContext - the operator-specific context

chunkSize - the size of the modification

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

postValues - a chunk of values to aggregate

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

Returns:

true if the state was modified, false otherwise

propagateUpdates

public void propagateUpdates(@NotNull
 @NotNull TableUpdate downstream,
 @NotNull
 @NotNull RowSet newDestinations)

Description copied from interface: IterativeChunkedAggregationOperator

Perform any internal state keeping needed for destinations that were added (went from 0 keys to > 0), removed (went from > 0 keys to 0), or modified (keys added or removed, or keys modified) by this iteration. Note that the arguments to this method should not be mutated in any way.

Specified by:

propagateUpdates in interface IterativeChunkedAggregationOperator

Parameters:

downstream - The downstream TableUpdate (which does not have its ModifiedColumnSet finalized yet)

newDestinations - New destinations added on this update

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

makeBucketedContext

public IterativeChunkedAggregationOperator.BucketedContext makeBucketedContext(int size)

Description copied from interface: IterativeChunkedAggregationOperator

Make a IterativeChunkedAggregationOperator.BucketedContext suitable for this operator if necessary.

Specified by:

makeBucketedContext in interface IterativeChunkedAggregationOperator

Parameters:

size - The maximum size of input chunks that will be used with the result context

Returns:

A new IterativeChunkedAggregationOperator.BucketedContext, or null if none is necessary

makeSingletonContext

public IterativeChunkedAggregationOperator.SingletonContext makeSingletonContext(int size)

Description copied from interface: IterativeChunkedAggregationOperator

Make a IterativeChunkedAggregationOperator.SingletonContext suitable for this operator if necessary.

Specified by:

makeSingletonContext in interface IterativeChunkedAggregationOperator

Parameters:

size - The maximum size of input chunks that will be used with the result context

Returns:

A new IterativeChunkedAggregationOperator.SingletonContext, or null if none is necessary