edu.snu.coral.common.ir.vertex

Class LoopVertex

java.lang.Object

edu.snu.coral.common.dag.Vertex

edu.snu.coral.common.ir.vertex.IRVertex

edu.snu.coral.common.ir.vertex.LoopVertex

All Implemented Interfaces:

Serializable

public final class LoopVertex
extends IRVertex

IRVertex that contains a partial DAG that is iterative.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
LoopVertex(String compositeTransformFullName) The LoopVertex constructor.

Method Summary

Modifier and Type	Method and Description
void	addDagIncomingEdge(IREdge edge) Adds the incoming edge of the contained DAG.
void	addDagOutgoingEdge(IREdge edge) Adds and outgoing edge of the contained DAG.
void	addIterativeIncomingEdge(IREdge edge) Adds an iterative incoming edge, from the previous iteration, but connection internally.
void	addNonIterativeIncomingEdge(IREdge edge) Adds a non-iterative incoming edge, from outside the previous iteration.
DAGBuilder<IRVertex,IREdge>	getBuilder()
LoopVertex	getClone()
DAG<IRVertex,IREdge>	getDAG()
Map<IRVertex,Set<IREdge>>	getDagIncomingEdges()
Map<IRVertex,Set<IREdge>>	getDagOutgoingEdges()
IREdge	getEdgeWithLoop(IREdge edgeWithInternalVertex)
Map<IRVertex,Set<IREdge>>	getIterativeIncomingEdges()
Integer	getMaxNumberOfIterations()
String	getName()
Map<IRVertex,Set<IREdge>>	getNonIterativeIncomingEdges()
IntPredicate	getTerminationCondition()
void	increaseMaxNumberOfIterations() increase the value of maximum number of iterations by 1.
Boolean	loopTerminationConditionMet()
Boolean	loopTerminationConditionMet(Integer intPredicateInput)
void	mapEdgeWithLoop(IREdge edgeWithLoop, IREdge edgeWithInternalVertex) Maps an edge from/to loop with the corresponding edge from/to internal vertex.
String	propertiesToJSON()
void	setMaxNumberOfIterations(Integer maxNum) Set the maximum number of iterations.
void	setTerminationCondition(IntPredicate terminationCondition) Set the intPredicate termination condition for the LoopVertex.
LoopVertex	unRollIteration(DAGBuilder<IRVertex,IREdge> dagBuilder) Method for unrolling an iteration of the LoopVertex.

Methods inherited from class edu.snu.coral.common.ir.vertex.IRVertex

copyExecutionPropertiesTo, getExecutionProperties, getProperty, irVertexPropertiesToString, setProperty

Methods inherited from class edu.snu.coral.common.dag.Vertex

getId, getNumericId

Methods inherited from class java.lang.Object

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

Constructor Detail

LoopVertex

public LoopVertex(String compositeTransformFullName)

The LoopVertex constructor.

Parameters:

compositeTransformFullName - full name of the composite transform.

Method Detail

getClone

public LoopVertex getClone()

Specified by:

getClone in class IRVertex

Returns:

a clone elemnt of the IRVertex.

getBuilder

public DAGBuilder<IRVertex,IREdge> getBuilder()

Returns:

DAGBuilder of the LoopVertex.

getDAG

public DAG<IRVertex,IREdge> getDAG()

Returns:

the DAG of rthe LoopVertex

getName

public String getName()

Returns:

the full name of the composite transform.

mapEdgeWithLoop

public void mapEdgeWithLoop(IREdge edgeWithLoop,
                            IREdge edgeWithInternalVertex)

Maps an edge from/to loop with the corresponding edge from/to internal vertex.

Parameters:

edgeWithLoop - an edge from/to loop

edgeWithInternalVertex - the corresponding edge from/to internal vertex

getEdgeWithLoop

public IREdge getEdgeWithLoop(IREdge edgeWithInternalVertex)

Parameters:

edgeWithInternalVertex - an edge with internal vertex

Returns:

the corresponding edge with loop for the specified edge with internal vertex

addDagIncomingEdge

public void addDagIncomingEdge(IREdge edge)

Adds the incoming edge of the contained DAG.

Parameters:

edge - edge to add.

getDagIncomingEdges

public Map<IRVertex,Set<IREdge>> getDagIncomingEdges()

Returns:

incoming edges of the contained DAG.

addIterativeIncomingEdge

public void addIterativeIncomingEdge(IREdge edge)

Adds an iterative incoming edge, from the previous iteration, but connection internally.

Parameters:

edge - edge to add.

getIterativeIncomingEdges

public Map<IRVertex,Set<IREdge>> getIterativeIncomingEdges()

Returns:

the iterative incoming edges inside the DAG.

addNonIterativeIncomingEdge

public void addNonIterativeIncomingEdge(IREdge edge)

Adds a non-iterative incoming edge, from outside the previous iteration.

Parameters:

edge - edge to add.

getNonIterativeIncomingEdges

public Map<IRVertex,Set<IREdge>> getNonIterativeIncomingEdges()

Returns:

the non-iterative incoming edges of the LoopVertex.

addDagOutgoingEdge

public void addDagOutgoingEdge(IREdge edge)

Adds and outgoing edge of the contained DAG.

Parameters:

edge - edge to add.

getDagOutgoingEdges

public Map<IRVertex,Set<IREdge>> getDagOutgoingEdges()

Returns:

outgoing edges of the contained DAG.

unRollIteration

public LoopVertex unRollIteration(DAGBuilder<IRVertex,IREdge> dagBuilder)

Method for unrolling an iteration of the LoopVertex.

Parameters:

dagBuilder - DAGBuilder to add the unrolled iteration to.

Returns:

a LoopVertex with one less maximum iteration.

loopTerminationConditionMet

public Boolean loopTerminationConditionMet()

Returns:

whether or not the loop termination condition has been met.

loopTerminationConditionMet

public Boolean loopTerminationConditionMet(Integer intPredicateInput)

Parameters:

intPredicateInput - input for the intPredicate of the loop termination condition.

Returns:

whether or not the loop termination condition has been met.

setMaxNumberOfIterations

public void setMaxNumberOfIterations(Integer maxNum)

Set the maximum number of iterations.

Parameters:

maxNum - maximum number of iterations.

getTerminationCondition

public IntPredicate getTerminationCondition()

Returns:

termination condition int predicate.

getMaxNumberOfIterations

public Integer getMaxNumberOfIterations()

Returns:

maximum number of iterations.

increaseMaxNumberOfIterations

public void increaseMaxNumberOfIterations()

increase the value of maximum number of iterations by 1.

setTerminationCondition

public void setTerminationCondition(IntPredicate terminationCondition)

Set the intPredicate termination condition for the LoopVertex.

Parameters:

terminationCondition - the termination condition to set.

propertiesToJSON

public String propertiesToJSON()

Overrides:

propertiesToJSON in class Vertex

Returns:

JSON representation of additional properties