Package org.apache.wayang.basic.operators

Class LoopOperator<InputType,ConvergenceType>

java.lang.Object

org.apache.wayang.core.plan.wayangplan.OperatorBase

org.apache.wayang.basic.operators.LoopOperator<InputType,ConvergenceType>

All Implemented Interfaces:

java.io.Serializable, ActualOperator, ElementaryOperator, LoopHeadOperator, Operator

Direct Known Subclasses:

FlinkLoopOperator, JavaLoopOperator, SparkLoopOperator

public class LoopOperator<InputType,ConvergenceType>
extends OperatorBase
implements ElementaryOperator, LoopHeadOperator

This operator has three inputs and three outputs.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.wayang.core.plan.wayangplan.OperatorBase

OperatorBase.GsonSerializer

Nested classes/interfaces inherited from interface org.apache.wayang.core.plan.wayangplan.LoopHeadOperator

LoopHeadOperator.State

Field Summary

Fields

Modifier and Type	Field	Description
protected PredicateDescriptor<java.util.Collection<ConvergenceType>>	criterionDescriptor	Function that this operator applies to the input elements.
static int	FINAL_OUTPUT_INDEX
static int	INITIAL_CONVERGENCE_INPUT_INDEX
static int	INITIAL_INPUT_INDEX
static int	ITERATION_CONVERGENCE_INPUT_INDEX
static int	ITERATION_CONVERGENCE_OUTPUT_INDEX
static int	ITERATION_INPUT_INDEX
static int	ITERATION_OUTPUT_INDEX

Fields inherited from class org.apache.wayang.core.plan.wayangplan.OperatorBase

inputSlots, outputSlots, STANDARD_OPERATOR_ARGS

Fields inherited from interface org.apache.wayang.core.plan.wayangplan.Operator

FIRST_EPOCH

Constructor Summary

Constructors

Constructor	Description
LoopOperator(java.lang.Class<InputType> inputTypeClass, java.lang.Class<ConvergenceType> convergenceTypeClass, FunctionDescriptor.SerializablePredicate<java.util.Collection<ConvergenceType>> criterionPredicate, java.lang.Integer numExpectedIterations)
LoopOperator(LoopOperator<InputType,ConvergenceType> that)	Creates a copy of the given LoopOperator.
LoopOperator(DataSetType<InputType> inputType, DataSetType<ConvergenceType> convergenceType, FunctionDescriptor.SerializablePredicate<java.util.Collection<ConvergenceType>> criterionPredicate, java.lang.Integer numExpectedIterations)
LoopOperator(DataSetType<InputType> inputType, DataSetType<ConvergenceType> convergenceType, PredicateDescriptor<java.util.Collection<ConvergenceType>> criterionDescriptor, java.lang.Integer numExpectedIterations)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
void	beginIteration(Operator beginOperator, int beginInputIndex, Operator convergeOperator, int convergeInputIndex)
void	beginIteration(Operator beginOperator, Operator convergeOperator)
java.util.Optional<CardinalityEstimator>	createCardinalityEstimator(int outputIndex, Configuration configuration)	Provide a CardinalityEstimator for the OutputSlot at outputIndex.
void	endIteration(Operator endOperator, int endOpOutputIndex, Operator convergeOperator, int convergeOutputIndex)
void	endIteration(Operator endOperator, Operator convergeOperator)
java.util.Collection<InputSlot<?>>	getConditionInputSlots()	Retrieve those InputSlots that are required to evaluate the loop condition.
java.util.Collection<OutputSlot<?>>	getConditionOutputSlots()	Retrieve those OutputSlots that forward the LoopHeadOperator.getConditionInputSlots().
DataSetType<ConvergenceType>	getConvergenceType()
PredicateDescriptor<java.util.Collection<ConvergenceType>>	getCriterionDescriptor()
java.util.Collection<OutputSlot<?>>	getFinalLoopOutputs()	If this instance is the head of a loop, then return these OutputSlots that form the final result of the iteration.
java.util.Collection<OutputSlot<?>>	getForwards(InputSlot<?> input)	Declare forward rules.
DataSetType<InputType>	getInputType()
java.util.Collection<InputSlot<?>>	getLoopBodyInputs()	If this instance is the head of a loop, then return these InputSlots that are fed from the loop body (as opposed to the InputSlots that initialize the loop).
java.util.Collection<OutputSlot<?>>	getLoopBodyOutputs()	If this instance is the head of a loop, then return these OutputSlots that go into the loop body (as opposed to the OutputSlots that form the final result of the iteration).
java.util.Collection<InputSlot<?>>	getLoopInitializationInputs()	If this instance is the head of a loop, then return these InputSlots that initialize the loop.
int	getNumExpectedIterations()
LoopHeadOperator.State	getState()	Optional operation.
void	initialize(Operator initOperator, int initOpOutputIndex, Operator convOperator, int convOpOutputIndex)
void	initialize(Operator initOperator, Operator convOperator)
boolean	isReading(InputSlot<?> input)	Tells whether the given input is read by this operator.
void	outputConnectTo(Operator outputOperator)
void	outputConnectTo(Operator outputOperator, int thatInputIndex)
void	setNumExpectedIterations(int numExpectedIterations)
void	setState(LoopHeadOperator.State state)	Optional operation.

Methods inherited from class org.apache.wayang.core.plan.wayangplan.OperatorBase

accept, addBroadcastInput, addTargetPlatform, at, collectMappedInputSlots, collectMappedOutputSlots, copy, createCopy, getAllInputs, getAllOutputs, getCardinalityEstimator, getContainer, getEpoch, getName, getOriginal, getSimpleClassName, getTargetPlatforms, isAuxiliary, isSupportingBroadcastInputs, propagateInputCardinality, propagateOutputCardinality, setAuxiliary, setCardinalityEstimator, setContainer, setEpoch, setName, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.wayang.core.plan.wayangplan.ActualOperator

accept

Methods inherited from interface org.apache.wayang.core.plan.wayangplan.ElementaryOperator

getCardinalityEstimator, isAuxiliary, setAuxiliary, setCardinalityEstimator

Methods inherited from interface org.apache.wayang.core.plan.wayangplan.LoopHeadOperator

getCardinalityPusher, getFinalizationPusher, getInitializationPusher

Methods inherited from interface org.apache.wayang.core.plan.wayangplan.Operator

addBroadcastInput, addTargetPlatform, broadcastTo, broadcastTo, collectMappedInputSlots, collectMappedOutputSlots, connectTo, connectTo, getAllInputs, getAllOutputs, getContainer, getEffectiveOccupant, getEffectiveOccupant, getEpoch, getEstimationContextProperties, getInnermostLoop, getInput, getInput, getLoopStack, getName, getNumBroadcastInputs, getNumInputs, getNumOutputs, getNumRegularInputs, getOuterInputSlot, getOutermostInputSlot, getOutermostOutputSlots, getOutput, getOutput, getParent, getTargetPlatforms, isAlternative, isElementary, isExecutionOperator, isFeedbackInput, isFeedforwardOutput, isLoopHead, isLoopSubplan, isOwnerOf, isSink, isSource, isSubplan, isSupportingBroadcastInputs, isUnconnected, propagateInputCardinality, propagateOutputCardinality, propagateOutputCardinality, setContainer, setEpoch, setInput, setName, setOutput

Field Detail

INITIAL_INPUT_INDEX

public static final int INITIAL_INPUT_INDEX

See Also:

Constant Field Values

INITIAL_CONVERGENCE_INPUT_INDEX

public static final int INITIAL_CONVERGENCE_INPUT_INDEX

See Also:

Constant Field Values

ITERATION_INPUT_INDEX

public static final int ITERATION_INPUT_INDEX

See Also:

Constant Field Values

ITERATION_CONVERGENCE_INPUT_INDEX

public static final int ITERATION_CONVERGENCE_INPUT_INDEX

See Also:

Constant Field Values

ITERATION_OUTPUT_INDEX

public static final int ITERATION_OUTPUT_INDEX

See Also:

Constant Field Values

ITERATION_CONVERGENCE_OUTPUT_INDEX

public static final int ITERATION_CONVERGENCE_OUTPUT_INDEX

See Also:

Constant Field Values

FINAL_OUTPUT_INDEX

public static final int FINAL_OUTPUT_INDEX

See Also:

Constant Field Values

criterionDescriptor

protected final PredicateDescriptor<java.util.Collection<ConvergenceType>> criterionDescriptor

Function that this operator applies to the input elements.

Constructor Detail

LoopOperator

public LoopOperator(java.lang.Class<InputType> inputTypeClass,
                    java.lang.Class<ConvergenceType> convergenceTypeClass,
                    FunctionDescriptor.SerializablePredicate<java.util.Collection<ConvergenceType>> criterionPredicate,
                    java.lang.Integer numExpectedIterations)

LoopOperator

public LoopOperator(DataSetType<InputType> inputType,
                    DataSetType<ConvergenceType> convergenceType,
                    FunctionDescriptor.SerializablePredicate<java.util.Collection<ConvergenceType>> criterionPredicate,
                    java.lang.Integer numExpectedIterations)

LoopOperator

public LoopOperator(DataSetType<InputType> inputType,
                    DataSetType<ConvergenceType> convergenceType,
                    PredicateDescriptor<java.util.Collection<ConvergenceType>> criterionDescriptor,
                    java.lang.Integer numExpectedIterations)

Creates a new instance.

LoopOperator

public LoopOperator(LoopOperator<InputType,ConvergenceType> that)

Creates a copy of the given LoopOperator.

Parameters:

that - should be copied

Method Detail

getState

public LoopHeadOperator.State getState()

Description copied from interface: LoopHeadOperator

Optional operation. Only ExecutionOperators need to implement this method.

Specified by:

getState in interface LoopHeadOperator

Returns:

the current LoopHeadOperator.State of this instance

setState

public void setState(LoopHeadOperator.State state)

Description copied from interface: LoopHeadOperator

Optional operation. Only ExecutionOperators need to implement this method. Sets the LoopHeadOperator.State of this instance.

Specified by:

setState in interface LoopHeadOperator

getInputType

public DataSetType<InputType> getInputType()

getConvergenceType

public DataSetType<ConvergenceType> getConvergenceType()

initialize

public void initialize(Operator initOperator,
                       int initOpOutputIndex,
                       Operator convOperator,
                       int convOpOutputIndex)

initialize

public void initialize(Operator initOperator,
                       Operator convOperator)

beginIteration

public void beginIteration(Operator beginOperator,
                           int beginInputIndex,
                           Operator convergeOperator,
                           int convergeInputIndex)

beginIteration

public void beginIteration(Operator beginOperator,
                           Operator convergeOperator)

endIteration

public void endIteration(Operator endOperator,
                         int endOpOutputIndex,
                         Operator convergeOperator,
                         int convergeOutputIndex)

endIteration

public void endIteration(Operator endOperator,
                         Operator convergeOperator)

outputConnectTo

public void outputConnectTo(Operator outputOperator,
                            int thatInputIndex)

outputConnectTo

public void outputConnectTo(Operator outputOperator)

getCriterionDescriptor

public PredicateDescriptor<java.util.Collection<ConvergenceType>> getCriterionDescriptor()

getForwards

public java.util.Collection<OutputSlot<?>> getForwards(InputSlot<?> input)

Description copied from interface: Operator

Declare forward rules. Execution engines may take the chance to optimize the executed plans by having forwarded data by-pass this instance. However, note the specific semantics of a forward rule: If an Operator serves an OutputSlot that is involved in a foward rule, it will do so by forwarding. If the OutputSlot is not served, then the forwarding does not apply.

Specified by:

getForwards in interface Operator

Returns:

OutputSlots to which this instance forwards the given input.

See Also:

Operator.isReading(InputSlot)

isReading

public boolean isReading(InputSlot<?> input)

Description copied from interface: Operator

Tells whether the given input is read by this operator. If not, the optimizer can make use of this insight.

Specified by:

isReading in interface Operator

See Also:

Operator.getForwards(InputSlot)

createCardinalityEstimator

public java.util.Optional<CardinalityEstimator> createCardinalityEstimator(int outputIndex,
                                                                           Configuration configuration)

Description copied from interface: ElementaryOperator

Provide a CardinalityEstimator for the OutputSlot at outputIndex.

Specified by:

createCardinalityEstimator in interface ElementaryOperator

Parameters:

outputIndex - index of the OutputSlot for that the CardinalityEstimator is requested

configuration - if the CardinalityEstimator depends on further ones, use this to obtain the latter

Returns:

an Optional that might provide the requested instance

getLoopBodyOutputs

public java.util.Collection<OutputSlot<?>> getLoopBodyOutputs()

Description copied from interface: LoopHeadOperator

If this instance is the head of a loop, then return these OutputSlots that go into the loop body (as opposed to the OutputSlots that form the final result of the iteration).

Specified by:

getLoopBodyOutputs in interface LoopHeadOperator

Returns:

the loop body-bound OutputSlots

getFinalLoopOutputs

public java.util.Collection<OutputSlot<?>> getFinalLoopOutputs()

Description copied from interface: LoopHeadOperator

If this instance is the head of a loop, then return these OutputSlots that form the final result of the iteration.

Specified by:

getFinalLoopOutputs in interface LoopHeadOperator

Returns:

the loop-terminal OutputSlots

getLoopBodyInputs

public java.util.Collection<InputSlot<?>> getLoopBodyInputs()

Description copied from interface: LoopHeadOperator

If this instance is the head of a loop, then return these InputSlots that are fed from the loop body (as opposed to the InputSlots that initialize the loop).

Specified by:

getLoopBodyInputs in interface LoopHeadOperator

Returns:

the loop body-bound InputSlots

getLoopInitializationInputs

public java.util.Collection<InputSlot<?>> getLoopInitializationInputs()

Description copied from interface: LoopHeadOperator

If this instance is the head of a loop, then return these InputSlots that initialize the loop.

Specified by:

getLoopInitializationInputs in interface LoopHeadOperator

Returns:

the initialization InputSlots

getConditionInputSlots

public java.util.Collection<InputSlot<?>> getConditionInputSlots()

Description copied from interface: LoopHeadOperator

Retrieve those InputSlots that are required to evaluate the loop condition.

Specified by:

getConditionInputSlots in interface LoopHeadOperator

Returns:

the condition InputSlots

getConditionOutputSlots

public java.util.Collection<OutputSlot<?>> getConditionOutputSlots()

Description copied from interface: LoopHeadOperator

Retrieve those OutputSlots that forward the LoopHeadOperator.getConditionInputSlots().

Specified by:

getConditionOutputSlots in interface LoopHeadOperator

Returns:

the condition OutputSlots

setNumExpectedIterations

public void setNumExpectedIterations(int numExpectedIterations)

getNumExpectedIterations

public int getNumExpectedIterations()

Specified by:

getNumExpectedIterations in interface LoopHeadOperator

Returns:

a number of expected iterations; not necessarily the actual value