edu.snu.coral.compiler.optimizer.pass.compiletime.annotating

Class AnnotatingPass

java.lang.Object

edu.snu.coral.compiler.optimizer.pass.compiletime.annotating.AnnotatingPass

All Implemented Interfaces:

CompileTimePass, Serializable, Function<DAG<IRVertex,IREdge>,DAG<IRVertex,IREdge>>

Direct Known Subclasses:

CompressionPass, DataSkewEdgeDataStorePass, DataSkewEdgeMetricCollectionPass, DataSkewEdgePartitionerPass, DataSkewVertexPass, DefaultEdgeUsedDataHandlingPass, DefaultParallelismPass, DefaultStagePartitioningPass, DisaggregationEdgeDataStorePass, PadoEdgeDataFlowModelPass, PadoEdgeDataStorePass, PadoVertexExecutorPlacementPass, ReviseInterStageEdgeDataStorePass, SailfishEdgeDataFlowModelPass, SailfishEdgeDataStorePass, SailfishEdgeUsedDataHandlingPass, ScheduleGroupPass, ShuffleEdgePushPass

public abstract class AnnotatingPass
extends Object
implements CompileTimePass

A compile-time pass that annotates the IR DAG with execution properties. It is ensured by the compiler that the shape of the IR DAG itself is not modified by an AnnotatingPass.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AnnotatingPass(ExecutionProperty.Key keyOfExecutionPropertyToModify) Constructor.
AnnotatingPass(ExecutionProperty.Key keyOfExecutionPropertyToModify, Set<ExecutionProperty.Key> prerequisiteExecutionProperties) Constructor.

Method Summary

Modifier and Type	Method and Description
ExecutionProperty.Key	getExecutionPropertyToModify() Getter for key of execution property to modify.
Set<ExecutionProperty.Key>	getPrerequisiteExecutionProperties() Getter for prerequisite execution properties.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.function.Function

andThen, apply, compose, identity

Constructor Detail

AnnotatingPass

public AnnotatingPass(ExecutionProperty.Key keyOfExecutionPropertyToModify,
                      Set<ExecutionProperty.Key> prerequisiteExecutionProperties)

Constructor.

Parameters:

keyOfExecutionPropertyToModify - key of execution property to modify.

prerequisiteExecutionProperties - prerequisite execution properties.

AnnotatingPass

public AnnotatingPass(ExecutionProperty.Key keyOfExecutionPropertyToModify)

Constructor.

Parameters:

keyOfExecutionPropertyToModify - key of execution property to modify.

Method Detail

getExecutionPropertyToModify

public final ExecutionProperty.Key getExecutionPropertyToModify()

Getter for key of execution property to modify.

Returns:

key of execution property to modify.

getPrerequisiteExecutionProperties

public final Set<ExecutionProperty.Key> getPrerequisiteExecutionProperties()

Description copied from interface: CompileTimePass

Getter for prerequisite execution properties.

Specified by:

getPrerequisiteExecutionProperties in interface CompileTimePass

Returns:

set of prerequisite execution properties.