Package com.illumon.iris.db.v2.updateby.ema

Class BasePrimitiveEMAOperator

java.lang.Object

com.illumon.iris.db.v2.updateby.internal.BaseDoubleUpdateByOperator

com.illumon.iris.db.v2.updateby.ema.BasePrimitiveEMAOperator

All Implemented Interfaces:

UpdateByOperator

Direct Known Subclasses:

ByteEMAOperator, DoubleEMAOperator, FloatEMAOperator, IntEMAOperator, LongEMAOperator, ShortEMAOperator

public abstract class BasePrimitiveEMAOperator
extends BaseDoubleUpdateByOperator

Nested Class Summary

Nested classes/interfaces inherited from class com.illumon.iris.db.v2.updateby.internal.BaseDoubleUpdateByOperator

BaseDoubleUpdateByOperator.Context

Nested classes/interfaces inherited from interface com.illumon.iris.db.v2.updateby.UpdateByOperator

UpdateByOperator.UpdateContext

Field Summary

Fields

Modifier and Type	Field	Description
protected final EmaControl	control
protected final LongRecordingUpdateByOperator	timeRecorder
protected final double	timeScaleUnits

Fields inherited from class com.illumon.iris.db.v2.updateby.internal.BaseDoubleUpdateByOperator

bucketLastVal, initialized, isRedirected, maybeInnerSource, outputSource, singletonGroup, singletonVal

Fields inherited from interface com.illumon.iris.db.v2.updateby.UpdateByOperator

ZERO_LENGTH_OP_ARRAY

Constructor Summary

Constructors

Constructor	Description
BasePrimitiveEMAOperator(MatchPair pair, String[] affectingColumns, EmaControl control, LongRecordingUpdateByOperator timeRecorder, long timeScaleUnits, RedirectionIndex redirectionIndex)	An operator that computes an EMA from a short column using an exponential decay function.

Method Summary

Modifier and Type	Method	Description
void	addChunk(UpdateByOperator.UpdateContext context, Chunk<Attributes.Values> values, LongChunk<? extends Attributes.KeyIndices> keyChunk, IntChunk<Attributes.KeyIndices> bucketPositions, IntChunk<Attributes.ChunkPositions> startPositions, IntChunk<Attributes.ChunkLengths> runLengths)	Add a chunk of bucketed items to the operation.
protected void	doAddChunk(BaseDoubleUpdateByOperator.Context context, OrderedKeys inputKeys, Chunk<Attributes.Values> workingChunk, long groupPosition)
void	initializeFor(UpdateByOperator.UpdateContext updateContext, ReadOnlyIndex updateIndex, UpdateBy.UpdateType type)	Initialize the context for the specified stage of the update process.
void	initializeForUpdate(UpdateByOperator.UpdateContext context, ShiftAwareListener.Update upstream, ReadOnlyIndex resultSourceIndex, boolean usingBuckets, boolean isAppendOnly)	Initialize the operator for an update cycle.
UpdateByOperator.UpdateContext	makeUpdateContext(int chunkSize)	Make an UpdateByOperator.UpdateContext suitable for use with non-bucketed updates.
void	onBucketsRemoved(ReadOnlyIndex removedBuckets)	Called when some buckets have been completely emptied.
void	resetForReprocess(UpdateByOperator.UpdateContext context, ReadOnlyIndex sourceIndex, ColumnSource<?> inputSource, long firstUnmodifiedKey)	Reset the operator to the state at the `firstModifiedKey` for non-bucketed operation.
void	resetForReprocess(UpdateByOperator.UpdateContext ctx, ReadOnlyIndex bucketIndex, ColumnSource<?> inputSource, long bucketPosition, long firstUnmodifiedKey)	Reset the operator to the state at the `firstModifiedKey` for the specified bucket.
void	setBucketCapacity(int capacity)	Notify the operator of the current maximum bucket.

Methods inherited from class com.illumon.iris.db.v2.updateby.internal.BaseDoubleUpdateByOperator

addChunk, anyModified, applyOutputShift, applyShift, canProcessNormalUpdate, finishFor, getAdditionalModifications, getAffectingColumnNames, getInputColumnName, getOutputColumnNames, getOutputColumns, modifyChunk, removeChunk, reprocessChunk, reprocessChunk, requiresKeys, requiresValues, setChunkSize, startTrackingPrev

Methods inherited from class java.lang.Object

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

Field Details

control

protected final EmaControl control

timeRecorder

protected final LongRecordingUpdateByOperator timeRecorder

timeScaleUnits

protected final double timeScaleUnits

Constructor Details

BasePrimitiveEMAOperator

public BasePrimitiveEMAOperator(@NotNull
 MatchPair pair,
 @NotNull
 String[] affectingColumns,
 @NotNull
 EmaControl control,
 @Nullable
 LongRecordingUpdateByOperator timeRecorder,
 long timeScaleUnits,
 @Nullable
 RedirectionIndex redirectionIndex)

An operator that computes an EMA from a short column using an exponential decay function.

Parameters:

pair - the MatchPair that defines the input/output for this operation

affectingColumns - the names of the columns that affect this ema

control - the control parameters for EMA

timeRecorder - an optional recorder for a timestamp column. If this is null, it will be assumed time is measured in integer ticks.

timeScaleUnits - the smoothing window for the EMA. If no timeRecorder is provided, this is measured in ticks, otherwise it is measured in nanoseconds.

redirectionIndex -

Method Details

setBucketCapacity

public void setBucketCapacity(int capacity)

Description copied from interface: UpdateByOperator

Notify the operator of the current maximum bucket.

Specified by:

setBucketCapacity in interface UpdateByOperator

Overrides:

setBucketCapacity in class BaseDoubleUpdateByOperator

Parameters:

capacity - the capacity

makeUpdateContext

@NotNull
public UpdateByOperator.UpdateContext makeUpdateContext(int chunkSize)

Description copied from interface: UpdateByOperator

Make an UpdateByOperator.UpdateContext suitable for use with non-bucketed updates.

Specified by:

makeUpdateContext in interface UpdateByOperator

Overrides:

makeUpdateContext in class BaseDoubleUpdateByOperator

Parameters:

chunkSize - The expected size of chunks that will be provided during the update,

Returns:

a new context

initializeForUpdate

public void initializeForUpdate(@NotNull
 UpdateByOperator.UpdateContext context,
 @NotNull
 ShiftAwareListener.Update upstream,
 @NotNull
 ReadOnlyIndex resultSourceIndex,
 boolean usingBuckets,
 boolean isAppendOnly)

Description copied from interface: UpdateByOperator

Initialize the operator for an update cycle. This is invoked before any other update processing occurs.

Specified by:

initializeForUpdate in interface UpdateByOperator

Overrides:

initializeForUpdate in class BaseDoubleUpdateByOperator

Parameters:

context - the context object

upstream - the upstream update to process

resultSourceIndex - the result index of the source table

usingBuckets - if the update is bucketed or not

isAppendOnly - if the upstream update was detected to be append-only.

initializeFor

public void initializeFor(@NotNull
 UpdateByOperator.UpdateContext updateContext,
 @NotNull
 ReadOnlyIndex updateIndex,
 @NotNull
 UpdateBy.UpdateType type)

Description copied from interface: UpdateByOperator

Initialize the context for the specified stage of the update process. This will always be followed by a call to UpdateByOperator.finishFor(UpdateContext, UpdateType) at the end of each successful update.

Specified by:

initializeFor in interface UpdateByOperator

Overrides:

initializeFor in class BaseDoubleUpdateByOperator

Parameters:

updateContext - the context object

updateIndex - the index of rows associated with the update.

type - the type of update being applied

onBucketsRemoved

public void onBucketsRemoved(@NotNull
 ReadOnlyIndex removedBuckets)

Description copied from interface: UpdateByOperator

Called when some buckets have been completely emptied. Operators can use this to reset internal states.

Specified by:

onBucketsRemoved in interface UpdateByOperator

Overrides:

onBucketsRemoved in class BaseDoubleUpdateByOperator

Parameters:

removedBuckets - an index of removed bucket positions.

doAddChunk

protected void doAddChunk(@NotNull
 BaseDoubleUpdateByOperator.Context context,
 @NotNull
 OrderedKeys inputKeys,
 @NotNull
 Chunk<Attributes.Values> workingChunk,
 long groupPosition)

Specified by:

doAddChunk in class BaseDoubleUpdateByOperator

addChunk

public void addChunk(@NotNull
 UpdateByOperator.UpdateContext context,
 @NotNull
 Chunk<Attributes.Values> values,
 @NotNull
 LongChunk<? extends Attributes.KeyIndices> keyChunk,
 @NotNull
 IntChunk<Attributes.KeyIndices> bucketPositions,
 @NotNull
 IntChunk<Attributes.ChunkPositions> startPositions,
 @NotNull
 IntChunk<Attributes.ChunkLengths> runLengths)

Description copied from interface: UpdateByOperator

Add a chunk of bucketed items to the operation.

Parameters:

context - the context object

values - the value chunk

keyChunk - a chunk of keys for the rows being added

bucketPositions - a chunk of hash bucket positions for each key

startPositions - the start position of a run within the chunk

runLengths - the runLengths of each run of bucket values

resetForReprocess

public void resetForReprocess(@NotNull
 UpdateByOperator.UpdateContext context,
 @NotNull
 ReadOnlyIndex sourceIndex,
 @NotNull
 ColumnSource<?> inputSource,
 long firstUnmodifiedKey)

Description copied from interface: UpdateByOperator

Reset the operator to the state at the `firstModifiedKey` for non-bucketed operation. This is invoked immediately prior to calls to UpdateByOperator.reprocessChunk(UpdateContext, OrderedKeys, LongChunk, Chunk, ReadOnlyIndex).

A `firstUnmodifiedKey` of ReadOnlyIndex.NULL_KEY indicates that the entire table needs to be recomputed.

Specified by:

resetForReprocess in interface UpdateByOperator

Overrides:

resetForReprocess in class BaseDoubleUpdateByOperator

Parameters:

context - the context object

sourceIndex - the current index of the source table

inputSource - the most primitive form of the input column source

firstUnmodifiedKey - the first unmodified key after which we will reprocess rows.

resetForReprocess

public void resetForReprocess(@NotNull
 UpdateByOperator.UpdateContext ctx,
 @NotNull
 ReadOnlyIndex bucketIndex,
 @NotNull
 ColumnSource<?> inputSource,
 long bucketPosition,
 long firstUnmodifiedKey)

Description copied from interface: UpdateByOperator

Reset the operator to the state at the `firstModifiedKey` for the specified bucket. This is invoked immediately prior to calls to UpdateByOperator.reprocessChunk(UpdateContext, OrderedKeys, Chunk, LongChunk, IntChunk, IntChunk, IntChunk).

Specified by:

resetForReprocess in interface UpdateByOperator

Overrides:

resetForReprocess in class BaseDoubleUpdateByOperator

Parameters:

ctx - the context object

bucketIndex - the current index of the specified bucket

inputSource - the most primitive form of the input column source

firstUnmodifiedKey - the first unmodified key in the bucket after which we will reprocess rows.