Package io.deephaven.engine.table.impl.updateby.emstd

Class BasePrimitiveEmStdOperator

java.lang.Object

io.deephaven.engine.table.impl.updateby.UpdateByOperator

io.deephaven.engine.table.impl.updateby.internal.BaseDoubleUpdateByOperator

io.deephaven.engine.table.impl.updateby.emstd.BasePrimitiveEmStdOperator

Direct Known Subclasses:

ByteEmStdOperator, CharEmStdOperator, DoubleEmStdOperator, FloatEmStdOperator, IntEmStdOperator, LongEmStdOperator, ShortEmStdOperator

public abstract class BasePrimitiveEmStdOperator
extends BaseDoubleUpdateByOperator

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	BasePrimitiveEmStdOperator.Context

Field Summary

Fields

Modifier and Type	Field	Description
protected final OperationControl	control
protected WritableColumnSource<Double>	emaSource
protected WritableColumnSource<Double>	maybeEmaInnerSource
protected final double	opAlpha
protected double	opOneMinusAlpha
protected final double	reverseWindowScaleUnits	For EM operators, we can allow floating-point tick/time units.
protected ColumnSource<?>	valueSource

Fields inherited from class io.deephaven.engine.table.impl.updateby.internal.BaseDoubleUpdateByOperator

maybeInnerSource, outputSource

Fields inherited from class io.deephaven.engine.table.impl.updateby.UpdateByOperator

affectingColumns, forwardWindowScaleUnits, inputModifiedColumnSet, isWindowed, outputModifiedColumnSet, pair, rowRedirection, timestampColumnName

Constructor Summary

Constructors

Constructor	Description
BasePrimitiveEmStdOperator(@NotNull MatchPair pair, @NotNull String[] affectingColumns, @NotNull OperationControl control, @Nullable String timestampColumnName, double windowScaleUnits)	An operator that computes an EM Std output from an input column using an exponential decay function.

Method Summary

Modifier and Type	Method	Description
void	applyOutputShift(@NotNull RowSet subRowSetToShift, long delta)	Apply a shift to the operation.
protected void	handleBadData(@NotNull BasePrimitiveEmStdOperator.Context ctx, boolean isNull, boolean isNan)
void	initializeCumulative(UpdateByOperator.Context updateContext, long firstUnmodifiedKey, long firstUnmodifiedTimestamp, @NotNull RowSet bucketRowSet)	Initialize the bucket context for a cumulative operator
void	initializeSources(@NotNull Table source, @Nullable RowRedirection rowRedirection)	Initialize this operator with a specific source table (and row redirection if needed).
void	prepareForParallelPopulation(RowSet changedRows)	Prepare this operator output column for parallel updated.
void	startTrackingPrev()	Indicate that the operation should start tracking previous values for ticking updates.

Methods inherited from class io.deephaven.engine.table.impl.updateby.internal.BaseDoubleUpdateByOperator

clearOutputRows, getOutputColumns

Methods inherited from class io.deephaven.engine.table.impl.updateby.UpdateByOperator

copy, createInputModifiedColumnSet, createOutputModifiedColumnSet, extractDownstreamModifiedColumnSet, finishUpdate, getAffectingColumnNames, getFwdWindowUnits, getInputColumnNames, getInputModifiedColumnSet, getOutputColumnNames, getOutputModifiedColumnSet, getPrevWindowUnits, getTimestampColumnName, initializeRolling, makeUpdateContext, requiresRowPositions

Methods inherited from class java.lang.Object

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

Field Details

control

protected final OperationControl control

reverseWindowScaleUnits

protected final double reverseWindowScaleUnits

For EM operators, we can allow floating-point tick/time units.

opAlpha

protected final double opAlpha

valueSource

protected ColumnSource<?> valueSource

opOneMinusAlpha

protected double opOneMinusAlpha

emaSource

protected WritableColumnSource<Double> emaSource

maybeEmaInnerSource

protected WritableColumnSource<Double> maybeEmaInnerSource

Constructor Details

BasePrimitiveEmStdOperator

public BasePrimitiveEmStdOperator(@NotNull
 @NotNull MatchPair pair,
 @NotNull
 @NotNull String[] affectingColumns,
 @NotNull
 @NotNull OperationControl control,
 @Nullable
 @Nullable String timestampColumnName,
 double windowScaleUnits)

An operator that computes an EM Std output from an input 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 EM operator

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

windowScaleUnits - the smoothing window for the EM operator. If no timestampColumnName is provided, this is measured in ticks, otherwise it is measured in nanoseconds.

Method Details

initializeSources

public void initializeSources(@NotNull
 @NotNull Table source,
 @Nullable
 @Nullable RowRedirection rowRedirection)

Description copied from class: UpdateByOperator

Initialize this operator with a specific source table (and row redirection if needed). This will be called exactly once per operator.

Overrides:

initializeSources in class BaseDoubleUpdateByOperator

initializeCumulative

public void initializeCumulative(@NotNull
 UpdateByOperator.Context updateContext,
 long firstUnmodifiedKey,
 long firstUnmodifiedTimestamp,
 @NotNull
 @NotNull RowSet bucketRowSet)

Description copied from class: UpdateByOperator

Initialize the bucket context for a cumulative operator

Overrides:

initializeCumulative in class BaseDoubleUpdateByOperator

startTrackingPrev

public void startTrackingPrev()

Description copied from class: UpdateByOperator

Indicate that the operation should start tracking previous values for ticking updates.

Overrides:

startTrackingPrev in class BaseDoubleUpdateByOperator

applyOutputShift

public void applyOutputShift(@NotNull
 @NotNull RowSet subRowSetToShift,
 long delta)

Description copied from class: UpdateByOperator

Apply a shift to the operation.

Overrides:

applyOutputShift in class BaseDoubleUpdateByOperator

prepareForParallelPopulation

public void prepareForParallelPopulation(RowSet changedRows)

Description copied from class: UpdateByOperator

Prepare this operator output column for parallel updated.

Overrides:

prepareForParallelPopulation in class BaseDoubleUpdateByOperator

handleBadData

protected void handleBadData(@NotNull
 @NotNull BasePrimitiveEmStdOperator.Context ctx,
 boolean isNull,
 boolean isNan)