blob: 11dde648e30d200f719976f410a15168740fd2ae [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>Optimizer (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="Optimizer (SystemDS 2.1.0-SNAPSHOT API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":10,"i2":10,"i3":6,"i4":6,"i5":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/Optimizer.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/runtime/controlprogram/parfor/opt/OptimizationWrapper.html" title="class in org.apache.sysds.runtime.controlprogram.parfor.opt"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../../org/apache/sysds/runtime/controlprogram/parfor/opt/Optimizer.CostModelType.html" title="enum in org.apache.sysds.runtime.controlprogram.parfor.opt"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/sysds/runtime/controlprogram/parfor/opt/Optimizer.html" target="_top">Frames</a></li>
<li><a href="Optimizer.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><a href="#nested.class.summary">Nested</a>&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">org.apache.sysds.runtime.controlprogram.parfor.opt</div>
<h2 title="Class Optimizer" class="title">Class Optimizer</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>org.apache.sysds.runtime.controlprogram.parfor.opt.Optimizer</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../../../../../org/apache/sysds/runtime/controlprogram/parfor/opt/OptimizerRuleBased.html" title="class in org.apache.sysds.runtime.controlprogram.parfor.opt">OptimizerRuleBased</a></dd>
</dl>
<hr>
<br>
<pre>public abstract class <span class="typeNameLabel">Optimizer</span>
extends <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></pre>
<div class="block">Generic optimizer super class that defines the interface of all implemented optimizers.
Furthermore it implements basic primitives, used by all optimizers such as the enumeration
of plan alternatives and specific rewrites.
Optimization objective: \phi: \min T(prog) | k \leq ck \wedge m(prog) \leq cm
with T(p)=max_(1\leq i\leq k)(T(prog_i).</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Class and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/sysds/runtime/controlprogram/parfor/opt/Optimizer.CostModelType.html" title="enum in org.apache.sysds.runtime.controlprogram.parfor.opt">Optimizer.CostModelType</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/sysds/runtime/controlprogram/parfor/opt/Optimizer.PlanInputType.html" title="enum in org.apache.sysds.runtime.controlprogram.parfor.opt">Optimizer.PlanInputType</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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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>abstract <a href="../../../../../../../org/apache/sysds/runtime/controlprogram/parfor/opt/Optimizer.CostModelType.html" title="enum in org.apache.sysds.runtime.controlprogram.parfor.opt">Optimizer.CostModelType</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/sysds/runtime/controlprogram/parfor/opt/Optimizer.html#getCostModelType--">getCostModelType</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/sysds/runtime/controlprogram/parfor/opt/Optimizer.html#getNumEvaluatedPlans--">getNumEvaluatedPlans</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/sysds/runtime/controlprogram/parfor/opt/Optimizer.html#getNumTotalPlans--">getNumTotalPlans</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>abstract <a href="../../../../../../../org/apache/sysds/runtime/controlprogram/ParForProgramBlock.POptMode.html" title="enum in org.apache.sysds.runtime.controlprogram">ParForProgramBlock.POptMode</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/sysds/runtime/controlprogram/parfor/opt/Optimizer.html#getOptMode--">getOptMode</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>abstract <a href="../../../../../../../org/apache/sysds/runtime/controlprogram/parfor/opt/Optimizer.PlanInputType.html" title="enum in org.apache.sysds.runtime.controlprogram.parfor.opt">Optimizer.PlanInputType</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/sysds/runtime/controlprogram/parfor/opt/Optimizer.html#getPlanInputType--">getPlanInputType</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>abstract boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/sysds/runtime/controlprogram/parfor/opt/Optimizer.html#optimize-org.apache.sysds.parser.ParForStatementBlock-org.apache.sysds.runtime.controlprogram.ParForProgramBlock-org.apache.sysds.runtime.controlprogram.parfor.opt.OptTree-org.apache.sysds.runtime.controlprogram.parfor.opt.CostEstimator-org.apache.sysds.runtime.controlprogram.context.ExecutionContext-">optimize</a></span>(<a href="../../../../../../../org/apache/sysds/parser/ParForStatementBlock.html" title="class in org.apache.sysds.parser">ParForStatementBlock</a>&nbsp;sb,
<a href="../../../../../../../org/apache/sysds/runtime/controlprogram/ParForProgramBlock.html" title="class in org.apache.sysds.runtime.controlprogram">ParForProgramBlock</a>&nbsp;pb,
<a href="../../../../../../../org/apache/sysds/runtime/controlprogram/parfor/opt/OptTree.html" title="class in org.apache.sysds.runtime.controlprogram.parfor.opt">OptTree</a>&nbsp;plan,
<a href="../../../../../../../org/apache/sysds/runtime/controlprogram/parfor/opt/CostEstimator.html" title="class in org.apache.sysds.runtime.controlprogram.parfor.opt">CostEstimator</a>&nbsp;est,
<a href="../../../../../../../org/apache/sysds/runtime/controlprogram/context/ExecutionContext.html" title="class in org.apache.sysds.runtime.controlprogram.context">ExecutionContext</a>&nbsp;ec)</code>
<div class="block">Optimize</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">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="optimize-org.apache.sysds.parser.ParForStatementBlock-org.apache.sysds.runtime.controlprogram.ParForProgramBlock-org.apache.sysds.runtime.controlprogram.parfor.opt.OptTree-org.apache.sysds.runtime.controlprogram.parfor.opt.CostEstimator-org.apache.sysds.runtime.controlprogram.context.ExecutionContext-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>optimize</h4>
<pre>public abstract&nbsp;boolean&nbsp;optimize(<a href="../../../../../../../org/apache/sysds/parser/ParForStatementBlock.html" title="class in org.apache.sysds.parser">ParForStatementBlock</a>&nbsp;sb,
<a href="../../../../../../../org/apache/sysds/runtime/controlprogram/ParForProgramBlock.html" title="class in org.apache.sysds.runtime.controlprogram">ParForProgramBlock</a>&nbsp;pb,
<a href="../../../../../../../org/apache/sysds/runtime/controlprogram/parfor/opt/OptTree.html" title="class in org.apache.sysds.runtime.controlprogram.parfor.opt">OptTree</a>&nbsp;plan,
<a href="../../../../../../../org/apache/sysds/runtime/controlprogram/parfor/opt/CostEstimator.html" title="class in org.apache.sysds.runtime.controlprogram.parfor.opt">CostEstimator</a>&nbsp;est,
<a href="../../../../../../../org/apache/sysds/runtime/controlprogram/context/ExecutionContext.html" title="class in org.apache.sysds.runtime.controlprogram.context">ExecutionContext</a>&nbsp;ec)</pre>
<div class="block">Optimize</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>sb</code> - parfor statement block</dd>
<dd><code>pb</code> - parfor program block</dd>
<dd><code>plan</code> - complete plan of a top-level parfor</dd>
<dd><code>est</code> - cost estimator</dd>
<dd><code>ec</code> - execution context</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if plan changed, false otherwise</dd>
</dl>
</li>
</ul>
<a name="getPlanInputType--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPlanInputType</h4>
<pre>public abstract&nbsp;<a href="../../../../../../../org/apache/sysds/runtime/controlprogram/parfor/opt/Optimizer.PlanInputType.html" title="enum in org.apache.sysds.runtime.controlprogram.parfor.opt">Optimizer.PlanInputType</a>&nbsp;getPlanInputType()</pre>
</li>
</ul>
<a name="getCostModelType--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCostModelType</h4>
<pre>public abstract&nbsp;<a href="../../../../../../../org/apache/sysds/runtime/controlprogram/parfor/opt/Optimizer.CostModelType.html" title="enum in org.apache.sysds.runtime.controlprogram.parfor.opt">Optimizer.CostModelType</a>&nbsp;getCostModelType()</pre>
</li>
</ul>
<a name="getOptMode--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOptMode</h4>
<pre>public abstract&nbsp;<a href="../../../../../../../org/apache/sysds/runtime/controlprogram/ParForProgramBlock.POptMode.html" title="enum in org.apache.sysds.runtime.controlprogram">ParForProgramBlock.POptMode</a>&nbsp;getOptMode()</pre>
</li>
</ul>
<a name="getNumTotalPlans--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNumTotalPlans</h4>
<pre>public&nbsp;long&nbsp;getNumTotalPlans()</pre>
</li>
</ul>
<a name="getNumEvaluatedPlans--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getNumEvaluatedPlans</h4>
<pre>public&nbsp;long&nbsp;getNumEvaluatedPlans()</pre>
</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/Optimizer.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/runtime/controlprogram/parfor/opt/OptimizationWrapper.html" title="class in org.apache.sysds.runtime.controlprogram.parfor.opt"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../../org/apache/sysds/runtime/controlprogram/parfor/opt/Optimizer.CostModelType.html" title="enum in org.apache.sysds.runtime.controlprogram.parfor.opt"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/sysds/runtime/controlprogram/parfor/opt/Optimizer.html" target="_top">Frames</a></li>
<li><a href="Optimizer.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><a href="#nested.class.summary">Nested</a>&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; 2021 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>