blob: aa7b5305fa93c694af7a0f7d0ebc387afee17339 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_162) on Thu Feb 01 21:39:08 KST 2018 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>CompileTimePass (Coral Project 0.1-SNAPSHOT API)</title>
<meta name="date" content="2018-02-01">
<link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="CompileTimePass (Coral Project 0.1-SNAPSHOT API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/CompileTimePass.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev&nbsp;Class</li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?edu/snu/coral/compiler/optimizer/pass/compiletime/CompileTimePass.html" target="_top">Frames</a></li>
<li><a href="CompileTimePass.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">edu.snu.coral.compiler.optimizer.pass.compiletime</div>
<h2 title="Interface CompileTimePass" class="title">Interface CompileTimePass</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/Function.html?is-external=true" title="class or interface in java.util.function">Function</a>&lt;<a href="../../../../../../../edu/snu/coral/common/dag/DAG.html" title="class in edu.snu.coral.common.dag">DAG</a>&lt;<a href="../../../../../../../edu/snu/coral/common/ir/vertex/IRVertex.html" title="class in edu.snu.coral.common.ir.vertex">IRVertex</a>,<a href="../../../../../../../edu/snu/coral/common/ir/edge/IREdge.html" title="class in edu.snu.coral.common.ir.edge">IREdge</a>&gt;,<a href="../../../../../../../edu/snu/coral/common/dag/DAG.html" title="class in edu.snu.coral.common.dag">DAG</a>&lt;<a href="../../../../../../../edu/snu/coral/common/ir/vertex/IRVertex.html" title="class in edu.snu.coral.common.ir.vertex">IRVertex</a>,<a href="../../../../../../../edu/snu/coral/common/ir/edge/IREdge.html" title="class in edu.snu.coral.common.ir.edge">IREdge</a>&gt;&gt;, <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../../../edu/snu/coral/compiler/optimizer/pass/compiletime/annotating/AnnotatingPass.html" title="class in edu.snu.coral.compiler.optimizer.pass.compiletime.annotating">AnnotatingPass</a>, <a href="../../../../../../../edu/snu/coral/compiler/optimizer/pass/compiletime/reshaping/CommonSubexpressionEliminationPass.html" title="class in edu.snu.coral.compiler.optimizer.pass.compiletime.reshaping">CommonSubexpressionEliminationPass</a>, <a href="../../../../../../../edu/snu/coral/compiler/optimizer/pass/compiletime/composite/CompositePass.html" title="class in edu.snu.coral.compiler.optimizer.pass.compiletime.composite">CompositePass</a>, <a href="../../../../../../../edu/snu/coral/compiler/optimizer/pass/compiletime/annotating/CompressionPass.html" title="class in edu.snu.coral.compiler.optimizer.pass.compiletime.annotating">CompressionPass</a>, <a href="../../../../../../../edu/snu/coral/compiler/optimizer/pass/compiletime/composite/DataSkewCompositePass.html" title="class in edu.snu.coral.compiler.optimizer.pass.compiletime.composite">DataSkewCompositePass</a>, <a href="../../../../../../../edu/snu/coral/compiler/optimizer/pass/compiletime/annotating/DataSkewEdgeDataStorePass.html" title="class in edu.snu.coral.compiler.optimizer.pass.compiletime.annotating">DataSkewEdgeDataStorePass</a>, <a href="../../../../../../../edu/snu/coral/compiler/optimizer/pass/compiletime/annotating/DataSkewEdgeMetricCollectionPass.html" title="class in edu.snu.coral.compiler.optimizer.pass.compiletime.annotating">DataSkewEdgeMetricCollectionPass</a>, <a href="../../../../../../../edu/snu/coral/compiler/optimizer/pass/compiletime/annotating/DataSkewEdgePartitionerPass.html" title="class in edu.snu.coral.compiler.optimizer.pass.compiletime.annotating">DataSkewEdgePartitionerPass</a>, <a href="../../../../../../../edu/snu/coral/compiler/optimizer/pass/compiletime/reshaping/DataSkewReshapingPass.html" title="class in edu.snu.coral.compiler.optimizer.pass.compiletime.reshaping">DataSkewReshapingPass</a>, <a href="../../../../../../../edu/snu/coral/compiler/optimizer/pass/compiletime/annotating/DataSkewVertexPass.html" title="class in edu.snu.coral.compiler.optimizer.pass.compiletime.annotating">DataSkewVertexPass</a>, <a href="../../../../../../../edu/snu/coral/compiler/optimizer/pass/compiletime/annotating/DefaultEdgeUsedDataHandlingPass.html" title="class in edu.snu.coral.compiler.optimizer.pass.compiletime.annotating">DefaultEdgeUsedDataHandlingPass</a>, <a href="../../../../../../../edu/snu/coral/compiler/optimizer/pass/compiletime/annotating/DefaultParallelismPass.html" title="class in edu.snu.coral.compiler.optimizer.pass.compiletime.annotating">DefaultParallelismPass</a>, <a href="../../../../../../../edu/snu/coral/compiler/optimizer/policy/DefaultPolicyWithSeparatePass.RefactoredPass.html" title="class in edu.snu.coral.compiler.optimizer.policy">DefaultPolicyWithSeparatePass.RefactoredPass</a>, <a href="../../../../../../../edu/snu/coral/compiler/optimizer/pass/compiletime/annotating/DefaultStagePartitioningPass.html" title="class in edu.snu.coral.compiler.optimizer.pass.compiletime.annotating">DefaultStagePartitioningPass</a>, <a href="../../../../../../../edu/snu/coral/compiler/optimizer/pass/compiletime/annotating/DisaggregationEdgeDataStorePass.html" title="class in edu.snu.coral.compiler.optimizer.pass.compiletime.annotating">DisaggregationEdgeDataStorePass</a>, <a href="../../../../../../../edu/snu/coral/compiler/optimizer/pass/compiletime/reshaping/LoopExtractionPass.html" title="class in edu.snu.coral.compiler.optimizer.pass.compiletime.reshaping">LoopExtractionPass</a>, <a href="../../../../../../../edu/snu/coral/compiler/optimizer/pass/compiletime/composite/LoopOptimizationCompositePass.html" title="class in edu.snu.coral.compiler.optimizer.pass.compiletime.composite">LoopOptimizationCompositePass</a>, <a href="../../../../../../../edu/snu/coral/compiler/optimizer/pass/compiletime/reshaping/LoopOptimizations.LoopFusionPass.html" title="class in edu.snu.coral.compiler.optimizer.pass.compiletime.reshaping">LoopOptimizations.LoopFusionPass</a>, <a href="../../../../../../../edu/snu/coral/compiler/optimizer/pass/compiletime/reshaping/LoopOptimizations.LoopInvariantCodeMotionPass.html" title="class in edu.snu.coral.compiler.optimizer.pass.compiletime.reshaping">LoopOptimizations.LoopInvariantCodeMotionPass</a>, <a href="../../../../../../../edu/snu/coral/compiler/optimizer/pass/compiletime/reshaping/LoopUnrollingPass.html" title="class in edu.snu.coral.compiler.optimizer.pass.compiletime.reshaping">LoopUnrollingPass</a>, <a href="../../../../../../../edu/snu/coral/compiler/optimizer/pass/compiletime/composite/PadoCompositePass.html" title="class in edu.snu.coral.compiler.optimizer.pass.compiletime.composite">PadoCompositePass</a>, <a href="../../../../../../../edu/snu/coral/compiler/optimizer/pass/compiletime/annotating/PadoEdgeDataFlowModelPass.html" title="class in edu.snu.coral.compiler.optimizer.pass.compiletime.annotating">PadoEdgeDataFlowModelPass</a>, <a href="../../../../../../../edu/snu/coral/compiler/optimizer/pass/compiletime/annotating/PadoEdgeDataStorePass.html" title="class in edu.snu.coral.compiler.optimizer.pass.compiletime.annotating">PadoEdgeDataStorePass</a>, <a href="../../../../../../../edu/snu/coral/compiler/optimizer/pass/compiletime/annotating/PadoVertexExecutorPlacementPass.html" title="class in edu.snu.coral.compiler.optimizer.pass.compiletime.annotating">PadoVertexExecutorPlacementPass</a>, <a href="../../../../../../../edu/snu/coral/compiler/optimizer/pass/compiletime/composite/PrimitiveCompositePass.html" title="class in edu.snu.coral.compiler.optimizer.pass.compiletime.composite">PrimitiveCompositePass</a>, <a href="../../../../../../../edu/snu/coral/compiler/optimizer/pass/compiletime/reshaping/ReshapingPass.html" title="class in edu.snu.coral.compiler.optimizer.pass.compiletime.reshaping">ReshapingPass</a>, <a href="../../../../../../../edu/snu/coral/compiler/optimizer/pass/compiletime/annotating/ReviseInterStageEdgeDataStorePass.html" title="class in edu.snu.coral.compiler.optimizer.pass.compiletime.annotating">ReviseInterStageEdgeDataStorePass</a>, <a href="../../../../../../../edu/snu/coral/compiler/optimizer/pass/compiletime/annotating/SailfishEdgeDataFlowModelPass.html" title="class in edu.snu.coral.compiler.optimizer.pass.compiletime.annotating">SailfishEdgeDataFlowModelPass</a>, <a href="../../../../../../../edu/snu/coral/compiler/optimizer/pass/compiletime/annotating/SailfishEdgeDataStorePass.html" title="class in edu.snu.coral.compiler.optimizer.pass.compiletime.annotating">SailfishEdgeDataStorePass</a>, <a href="../../../../../../../edu/snu/coral/compiler/optimizer/pass/compiletime/annotating/SailfishEdgeUsedDataHandlingPass.html" title="class in edu.snu.coral.compiler.optimizer.pass.compiletime.annotating">SailfishEdgeUsedDataHandlingPass</a>, <a href="../../../../../../../edu/snu/coral/compiler/optimizer/pass/compiletime/composite/SailfishPass.html" title="class in edu.snu.coral.compiler.optimizer.pass.compiletime.composite">SailfishPass</a>, <a href="../../../../../../../edu/snu/coral/compiler/optimizer/pass/compiletime/reshaping/SailfishRelayReshapingPass.html" title="class in edu.snu.coral.compiler.optimizer.pass.compiletime.reshaping">SailfishRelayReshapingPass</a>, <a href="../../../../../../../edu/snu/coral/compiler/optimizer/pass/compiletime/annotating/ScheduleGroupPass.html" title="class in edu.snu.coral.compiler.optimizer.pass.compiletime.annotating">ScheduleGroupPass</a>, <a href="../../../../../../../edu/snu/coral/compiler/optimizer/pass/compiletime/annotating/ShuffleEdgePushPass.html" title="class in edu.snu.coral.compiler.optimizer.pass.compiletime.annotating">ShuffleEdgePushPass</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">CompileTimePass</span>
extends <a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/Function.html?is-external=true" title="class or interface in java.util.function">Function</a>&lt;<a href="../../../../../../../edu/snu/coral/common/dag/DAG.html" title="class in edu.snu.coral.common.dag">DAG</a>&lt;<a href="../../../../../../../edu/snu/coral/common/ir/vertex/IRVertex.html" title="class in edu.snu.coral.common.ir.vertex">IRVertex</a>,<a href="../../../../../../../edu/snu/coral/common/ir/edge/IREdge.html" title="class in edu.snu.coral.common.ir.edge">IREdge</a>&gt;,<a href="../../../../../../../edu/snu/coral/common/dag/DAG.html" title="class in edu.snu.coral.common.dag">DAG</a>&lt;<a href="../../../../../../../edu/snu/coral/common/ir/vertex/IRVertex.html" title="class in edu.snu.coral.common.ir.vertex">IRVertex</a>,<a href="../../../../../../../edu/snu/coral/common/ir/edge/IREdge.html" title="class in edu.snu.coral.common.ir.edge">IREdge</a>&gt;&gt;, <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></pre>
<div class="block">Interface for compile-time optimization passes that processes the DAG.
It is a function that takes an original DAG to produce a processed DAG, after an optimization.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<a href="../../../../../../../edu/snu/coral/common/ir/executionproperty/ExecutionProperty.Key.html" title="enum in edu.snu.coral.common.ir.executionproperty">ExecutionProperty.Key</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../edu/snu/coral/compiler/optimizer/pass/compiletime/CompileTimePass.html#getPrerequisiteExecutionProperties--">getPrerequisiteExecutionProperties</a></span>()</code>
<div class="block">Getter for prerequisite execution properties.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.util.function.Function">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;java.util.function.<a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/Function.html?is-external=true" title="class or interface in java.util.function">Function</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/Function.html?is-external=true#andThen-java.util.function.Function-" title="class or interface in java.util.function">andThen</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/Function.html?is-external=true#apply-T-" title="class or interface in java.util.function">apply</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/Function.html?is-external=true#compose-java.util.function.Function-" title="class or interface in java.util.function">compose</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/Function.html?is-external=true#identity--" title="class or interface in java.util.function">identity</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getPrerequisiteExecutionProperties--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getPrerequisiteExecutionProperties</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<a href="../../../../../../../edu/snu/coral/common/ir/executionproperty/ExecutionProperty.Key.html" title="enum in edu.snu.coral.common.ir.executionproperty">ExecutionProperty.Key</a>&gt;&nbsp;getPrerequisiteExecutionProperties()</pre>
<div class="block">Getter for prerequisite execution properties.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>set of prerequisite execution properties.</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/CompileTimePass.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev&nbsp;Class</li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?edu/snu/coral/compiler/optimizer/pass/compiletime/CompileTimePass.html" target="_top">Frames</a></li>
<li><a href="CompileTimePass.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2018. All rights reserved.</small></p>
</body>
</html>