blob: 54f0cbc2a1fcfd3a3c4f854f585ad35ef8fd5102 [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 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>IPAPassFlagFunctionsRecompileOnce (SystemDS 2.1.0-SNAPSHOT API)</title>
<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="IPAPassFlagFunctionsRecompileOnce (SystemDS 2.1.0-SNAPSHOT API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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/IPAPassFlagFunctionsRecompileOnce.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><a href="../../../../../org/apache/sysds/hops/ipa/IPAPassEliminateDeadCode.html" title="class in org.apache.sysds.hops.ipa"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/sysds/hops/ipa/IPAPassFlagNonDeterminism.html" title="class in org.apache.sysds.hops.ipa"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/sysds/hops/ipa/IPAPassFlagFunctionsRecompileOnce.html" target="_top">Frames</a></li>
<li><a href="IPAPassFlagFunctionsRecompileOnce.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><a href="#constructor.summary">Constr</a>&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><a href="#constructor.detail">Constr</a>&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">org.apache.sysds.hops.ipa</div>
<h2 title="Class IPAPassFlagFunctionsRecompileOnce" class="title">Class IPAPassFlagFunctionsRecompileOnce</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../../org/apache/sysds/hops/ipa/IPAPass.html" title="class in org.apache.sysds.hops.ipa">org.apache.sysds.hops.ipa.IPAPass</a></li>
<li>
<ul class="inheritance">
<li>org.apache.sysds.hops.ipa.IPAPassFlagFunctionsRecompileOnce</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="typeNameLabel">IPAPassFlagFunctionsRecompileOnce</span>
extends <a href="../../../../../org/apache/sysds/hops/ipa/IPAPass.html" title="class in org.apache.sysds.hops.ipa">IPAPass</a></pre>
<div class="block">This rewrite marks functions with loops as recompile once
in order to reduce recompilation overhead. Such functions
are recompiled on function entry with the size information
of the function inputs which is often sufficient to decide
upon execution types; in case there are still unknowns, the
traditional recompilation per atomic block still applies.
TODO call after lops construction</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/sysds/hops/ipa/IPAPassFlagFunctionsRecompileOnce.html#IPAPassFlagFunctionsRecompileOnce--">IPAPassFlagFunctionsRecompileOnce</a></span>()</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== 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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sysds/hops/ipa/IPAPassFlagFunctionsRecompileOnce.html#isApplicable-org.apache.sysds.hops.ipa.FunctionCallGraph-">isApplicable</a></span>(<a href="../../../../../org/apache/sysds/hops/ipa/FunctionCallGraph.html" title="class in org.apache.sysds.hops.ipa">FunctionCallGraph</a>&nbsp;fgraph)</code>
<div class="block">Indicates if an IPA pass is applicable for the current
configuration such as global flags or the chosen execution
mode (e.g., HYBRID).</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sysds/hops/ipa/IPAPassFlagFunctionsRecompileOnce.html#rewriteProgram-org.apache.sysds.parser.DMLProgram-org.apache.sysds.hops.ipa.FunctionCallGraph-org.apache.sysds.hops.ipa.FunctionCallSizeInfo-">rewriteProgram</a></span>(<a href="../../../../../org/apache/sysds/parser/DMLProgram.html" title="class in org.apache.sysds.parser">DMLProgram</a>&nbsp;prog,
<a href="../../../../../org/apache/sysds/hops/ipa/FunctionCallGraph.html" title="class in org.apache.sysds.hops.ipa">FunctionCallGraph</a>&nbsp;fgraph,
<a href="../../../../../org/apache/sysds/hops/ipa/FunctionCallSizeInfo.html" title="class in org.apache.sysds.hops.ipa">FunctionCallSizeInfo</a>&nbsp;fcallSizes)</code>
<div class="block">Rewrites the given program or its functions in place,
with access to the read-only function call graph.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sysds/hops/ipa/IPAPassFlagFunctionsRecompileOnce.html#rFlagFunctionForRecompileOnce-org.apache.sysds.parser.StatementBlock-boolean-">rFlagFunctionForRecompileOnce</a></span>(<a href="../../../../../org/apache/sysds/parser/StatementBlock.html" title="class in org.apache.sysds.parser">StatementBlock</a>&nbsp;sb,
boolean&nbsp;inLoop)</code>
<div class="block">Returns true if this statementblock requires recompilation inside a
loop statement block.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="IPAPassFlagFunctionsRecompileOnce--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>IPAPassFlagFunctionsRecompileOnce</h4>
<pre>public&nbsp;IPAPassFlagFunctionsRecompileOnce()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="isApplicable-org.apache.sysds.hops.ipa.FunctionCallGraph-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isApplicable</h4>
<pre>public&nbsp;boolean&nbsp;isApplicable(<a href="../../../../../org/apache/sysds/hops/ipa/FunctionCallGraph.html" title="class in org.apache.sysds.hops.ipa">FunctionCallGraph</a>&nbsp;fgraph)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/sysds/hops/ipa/IPAPass.html#isApplicable-org.apache.sysds.hops.ipa.FunctionCallGraph-">IPAPass</a></code></span></div>
<div class="block">Indicates if an IPA pass is applicable for the current
configuration such as global flags or the chosen execution
mode (e.g., HYBRID).</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/sysds/hops/ipa/IPAPass.html#isApplicable-org.apache.sysds.hops.ipa.FunctionCallGraph-">isApplicable</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/sysds/hops/ipa/IPAPass.html" title="class in org.apache.sysds.hops.ipa">IPAPass</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>fgraph</code> - function call graph</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if applicable.</dd>
</dl>
</li>
</ul>
<a name="rewriteProgram-org.apache.sysds.parser.DMLProgram-org.apache.sysds.hops.ipa.FunctionCallGraph-org.apache.sysds.hops.ipa.FunctionCallSizeInfo-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>rewriteProgram</h4>
<pre>public&nbsp;boolean&nbsp;rewriteProgram(<a href="../../../../../org/apache/sysds/parser/DMLProgram.html" title="class in org.apache.sysds.parser">DMLProgram</a>&nbsp;prog,
<a href="../../../../../org/apache/sysds/hops/ipa/FunctionCallGraph.html" title="class in org.apache.sysds.hops.ipa">FunctionCallGraph</a>&nbsp;fgraph,
<a href="../../../../../org/apache/sysds/hops/ipa/FunctionCallSizeInfo.html" title="class in org.apache.sysds.hops.ipa">FunctionCallSizeInfo</a>&nbsp;fcallSizes)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/sysds/hops/ipa/IPAPass.html#rewriteProgram-org.apache.sysds.parser.DMLProgram-org.apache.sysds.hops.ipa.FunctionCallGraph-org.apache.sysds.hops.ipa.FunctionCallSizeInfo-">IPAPass</a></code></span></div>
<div class="block">Rewrites the given program or its functions in place,
with access to the read-only function call graph.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/sysds/hops/ipa/IPAPass.html#rewriteProgram-org.apache.sysds.parser.DMLProgram-org.apache.sysds.hops.ipa.FunctionCallGraph-org.apache.sysds.hops.ipa.FunctionCallSizeInfo-">rewriteProgram</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/sysds/hops/ipa/IPAPass.html" title="class in org.apache.sysds.hops.ipa">IPAPass</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>prog</code> - dml program</dd>
<dd><code>fgraph</code> - function call graph</dd>
<dd><code>fcallSizes</code> - function call size infos</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if function call graph should be rebuild</dd>
</dl>
</li>
</ul>
<a name="rFlagFunctionForRecompileOnce-org.apache.sysds.parser.StatementBlock-boolean-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>rFlagFunctionForRecompileOnce</h4>
<pre>public&nbsp;boolean&nbsp;rFlagFunctionForRecompileOnce(<a href="../../../../../org/apache/sysds/parser/StatementBlock.html" title="class in org.apache.sysds.parser">StatementBlock</a>&nbsp;sb,
boolean&nbsp;inLoop)</pre>
<div class="block">Returns true if this statementblock requires recompilation inside a
loop statement block.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>sb</code> - statement block</dd>
<dd><code>inLoop</code> - true if in loop</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if statement block requires recompilation inside a loop statement block</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/IPAPassFlagFunctionsRecompileOnce.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><a href="../../../../../org/apache/sysds/hops/ipa/IPAPassEliminateDeadCode.html" title="class in org.apache.sysds.hops.ipa"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/sysds/hops/ipa/IPAPassFlagNonDeterminism.html" title="class in org.apache.sysds.hops.ipa"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/sysds/hops/ipa/IPAPassFlagFunctionsRecompileOnce.html" target="_top">Frames</a></li>
<li><a href="IPAPassFlagFunctionsRecompileOnce.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><a href="#constructor.summary">Constr</a>&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><a href="#constructor.detail">Constr</a>&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; 2021 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>