java.lang.Object

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

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

All Implemented Interfaces:: ChunkedUpdateByOperator

Direct Known Subclasses:: ByteStaticEMAOperator, DoubleStaticEMAOperator, FloatStaticEMAOperator, IntegerStaticEMAOperator, LongStaticEMAOperator, ShortStaticEMAOperator

public abstract class BaseStaticEMAOperator
extends AbstractStaticUpdateByOperator

Nested Class Summary

Nested classes/interfaces inherited from interface com.illumon.iris.db.v2.updateby.ChunkedUpdateByOperator
ChunkedUpdateByOperator.BucketedUpdateContext, ChunkedUpdateByOperator.UpdateContext
Field Summary

Fields

Modifier and Type Field Description

protected EmaControl control

protected LongRecordingUpdateByOperator timeRecorder

protected double timeScaleUnits

Fields inherited from interface com.illumon.iris.db.v2.updateby.ChunkedUpdateByOperator
ZERO_LENGTH_OP_ARRAY

Constructor Summary

Constructors
Constructor	Description
`BaseStaticEMAOperator(MatchPair pair, EmaControl control, LongRecordingUpdateByOperator timeRecorder, long timeScaleUnits)`	An operator that computes an EMA from a short column using an exponential decay function.

Method Summary

Modifier and Type	Method	Description
`void`	`addChunk(ChunkedUpdateByOperator.BucketedUpdateContext context, Chunk<Attributes.Values> values, LongChunk<? extends Attributes.KeyIndices> keyChunk, IntChunk<Attributes.KeyIndices> bucketPositions, IntChunk<Attributes.ChunkPositions> startPositions, IntChunk<Attributes.ChunkLengths> length)`	Add a chunk of bucketed items to the operation.
`void`	`addChunk(ChunkedUpdateByOperator.UpdateContext updateContext, LongChunk<Attributes.OrderedKeyIndices> keyChunk, Chunk<Attributes.Values> workingChunk, long groupPosition)`	Add a chunk of non-bucketed items to the operation.
`String`	`getInputColumnName()`	Get the name of the input column this operator depends on.
`String[]`	`getOutputColumnNames()`	Get an array of the output column names.
`Map<String,ColumnSource<?>>`	`getOutputColumns()`	Get a map of outputName to output `ColumnSource` for this operation.
`void`	`initializeFor(ChunkedUpdateByOperator.BucketedUpdateContext updateContext, UpdateBy.UpdateType type, ReadOnlyIndex updateIndex)`	Initialize the context for the specified stage of the update process.
`void`	`initializeFor(ChunkedUpdateByOperator.UpdateContext updateContext, UpdateBy.UpdateType type, ReadOnlyIndex updateIndex)`	Initialize the context for the specified stage of the update process.
`ChunkedUpdateByOperator.BucketedUpdateContext`	`makeBucketedContext(int chunkSize)`	Make an `ChunkedUpdateByOperator.UpdateContext` suitable for use with bucketed updates.
`ChunkedUpdateByOperator.UpdateContext`	`makeUpdateContext(int chunkSize)`	Make an `ChunkedUpdateByOperator.UpdateContext` suitable for use with non-bucketed updates.
`void`	`setBucketCapacity(int capacity)`	Notify the operator of the current maximum bucket.

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

anyModified, anyModified, applyShift, finishFor, finishFor, getAdditionalModifications, modifyChunk, removeChunk, setUpstream, setUpstream, 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
- BaseStaticEMAOperator
  
  public BaseStaticEMAOperator(@NotNull MatchPair pair, @NotNull EmaControl control, @Nullable LongRecordingUpdateByOperator timeRecorder, long timeScaleUnits)
  
  An operator that computes an EMA from a short column using an exponential decay function.
  
  Parameters:
  
  pair - the MatchPair defining the input and output columns
  
  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.
Method Details
- setBucketCapacity
  
  public void setBucketCapacity(int capacity)
  
  Description copied from interface: ChunkedUpdateByOperator
  
  Notify the operator of the current maximum bucket.
  
  Specified by:
  
  setBucketCapacity in interface ChunkedUpdateByOperator
  
  Overrides:
  
  setBucketCapacity in class AbstractStaticUpdateByOperator
  
  Parameters:
  
  capacity - the capacity
- getInputColumnName
  
  @NotNull public String getInputColumnName()
  
  Description copied from interface: ChunkedUpdateByOperator
  
  Get the name of the input column this operator depends on.
  
  Returns:
  
  the name of the input column
- getOutputColumnNames
  
  @NotNull public String[] getOutputColumnNames()
  
  Description copied from interface: ChunkedUpdateByOperator
  
  Get an array of the output column names.
  
  Returns:
  
  the output column names.
- getOutputColumns
  
  @NotNull public Map<String,ColumnSource<?>> getOutputColumns()
  
  Description copied from interface: ChunkedUpdateByOperator
  
  Get a map of outputName to output ColumnSource for this operation.
  
  Returns:
  
  a map of output column name to output column source
- makeUpdateContext
  
  @NotNull public ChunkedUpdateByOperator.UpdateContext makeUpdateContext(int chunkSize)
  
  Description copied from interface: ChunkedUpdateByOperator
  
  Make an ChunkedUpdateByOperator.UpdateContext suitable for use with non-bucketed updates.
  
  Parameters:
  
  chunkSize - The expected size of chunks that will be provided during the update,
  
  Returns:
  
  a new updateContext
- makeBucketedContext
  
  @NotNull public ChunkedUpdateByOperator.BucketedUpdateContext makeBucketedContext(int chunkSize)
  
  Description copied from interface: ChunkedUpdateByOperator
  
  Make an ChunkedUpdateByOperator.UpdateContext suitable for use with bucketed updates.
  
  Parameters:
  
  chunkSize - The expected size of chunks that will be provided during the update,
  
  Returns:
  
  a new updateContext
- initializeFor
  
  public void initializeFor(@NotNull ChunkedUpdateByOperator.UpdateContext updateContext, @NotNull UpdateBy.UpdateType type, @NotNull ReadOnlyIndex updateIndex)
  
  Description copied from interface: ChunkedUpdateByOperator
  
  Initialize the context for the specified stage of the update process. This will always be followed by a call to ChunkedUpdateByOperator.finishFor(UpdateContext, UpdateBy.UpdateType) at the end of each successful update.
  
  Specified by:
  
  initializeFor in interface ChunkedUpdateByOperator
  
  Overrides:
  
  initializeFor in class AbstractStaticUpdateByOperator
  
  Parameters:
  
  updateContext - the context object
  
  type - the type of update being applied
  
  updateIndex - the index of rows associated with the update.
- initializeFor
  
  public void initializeFor(@NotNull ChunkedUpdateByOperator.BucketedUpdateContext updateContext, @NotNull UpdateBy.UpdateType type, @NotNull ReadOnlyIndex updateIndex)
  
  Description copied from interface: ChunkedUpdateByOperator
  
  Initialize the context for the specified stage of the update process. This will always be followed by a call to ChunkedUpdateByOperator.finishFor(UpdateContext, UpdateBy.UpdateType) at the end of each successful update.
  
  Specified by:
  
  initializeFor in interface ChunkedUpdateByOperator
  
  Overrides:
  
  initializeFor in class AbstractStaticUpdateByOperator
  
  Parameters:
  
  updateContext - the context object
  
  type - the type of update being applied
  
  updateIndex - the index of rows associated with the update.
- addChunk
  
  public void addChunk(@NotNull ChunkedUpdateByOperator.UpdateContext updateContext, @NotNull LongChunk<Attributes.OrderedKeyIndices> keyChunk, @NotNull Chunk<Attributes.Values> workingChunk, long groupPosition)
  
  Description copied from interface: ChunkedUpdateByOperator
  
  Add a chunk of non-bucketed items to the operation.
  
  Parameters:
  
  updateContext - the context object
  
  keyChunk - a chunk of keys for the rows being added
  
  workingChunk - the chunk of values for the rows being added
  
  groupPosition - the group position
- addChunk
  
  public void addChunk(@NotNull ChunkedUpdateByOperator.BucketedUpdateContext 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> length)
  
  Description copied from interface: ChunkedUpdateByOperator
  
  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
  
  length - the length of each run of bucket values

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

Class BaseStaticEMAOperator

Nested Class Summary

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

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Details

Constructor Details

Method Details