Google Git
Sign in
apache/systemds/3027192d24a8b68276d17935ae366b4fb61fa5f9/./docs/api/java/org/apache/sysds/hops/cost/HopRel.html
blob: bbe49656b4820f57c91e2345392b1466c4787a5f [file]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>HopRel (Apache SystemDS 3.2.0-SNAPSHOT API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../jquery/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../../jquery/jquery-3.6.0.min.js"></script>
<script type="text/javascript" src="../../../../../jquery/jquery-ui.min.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="HopRel (Apache SystemDS 3.2.0-SNAPSHOT API)";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":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";
var pathtoroot = "../../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/HopRel.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" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</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 id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.apache.sysds.hops.cost</a></div>
<h2 title="Class HopRel" class="title">Class HopRel</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>org.apache.sysds.hops.cost.HopRel</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<pre>public class <span class="typeNameLabel">HopRel</span>
extends <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></pre>
<div class="block">HopRel provides a representation of the relation between a hop, the cost of setting a given FederatedOutput value,
and the input dependency with the given FederatedOutput value.
The HopRel class is used when building and selecting an optimal federated execution plan in IPAPassRewriteFederatedPlan.
The input dependency is needed to hold the valid and optimal FederatedOutput values for the inputs.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.apache.sysds.hops.Hop,org.apache.sysds.runtime.instructions.fed.FEDInstruction.FederatedOutput,org.apache.sysds.hops.fedplanner.FTypes.FType,org.apache.sysds.hops.fedplanner.MemoTable,java.util.ArrayList)">HopRel</a></span>&#8203;(<a href="../Hop.html" title="class in org.apache.sysds.hops">Hop</a>&nbsp;associatedHop,
<a href="../../runtime/instructions/fed/FEDInstruction.FederatedOutput.html" title="enum in org.apache.sysds.runtime.instructions.fed">FEDInstruction.FederatedOutput</a>&nbsp;fedOut,
<a href="../fedplanner/FTypes.FType.html" title="enum in org.apache.sysds.hops.fedplanner">FTypes.FType</a>&nbsp;fType,
<a href="../fedplanner/MemoTable.html" title="class in org.apache.sysds.hops.fedplanner">MemoTable</a>&nbsp;hopRelMemo,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/ArrayList.html?is-external=true" title="class or interface in java.util" class="externalLink">ArrayList</a>&lt;<a href="../Hop.html" title="class in org.apache.sysds.hops">Hop</a>&gt;&nbsp;inputs)</code></th>
<td class="colLast">
<div class="block">Constructs a HopRel with input dependency and cost estimate based on entries in hopRelMemo.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.apache.sysds.hops.Hop,org.apache.sysds.runtime.instructions.fed.FEDInstruction.FederatedOutput,org.apache.sysds.hops.fedplanner.FTypes.FType,org.apache.sysds.hops.fedplanner.MemoTable,java.util.List,java.util.List)">HopRel</a></span>&#8203;(<a href="../Hop.html" title="class in org.apache.sysds.hops">Hop</a>&nbsp;associatedHop,
<a href="../../runtime/instructions/fed/FEDInstruction.FederatedOutput.html" title="enum in org.apache.sysds.runtime.instructions.fed">FEDInstruction.FederatedOutput</a>&nbsp;fedOut,
<a href="../fedplanner/FTypes.FType.html" title="enum in org.apache.sysds.hops.fedplanner">FTypes.FType</a>&nbsp;fType,
<a href="../fedplanner/MemoTable.html" title="class in org.apache.sysds.hops.fedplanner">MemoTable</a>&nbsp;hopRelMemo,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a>&lt;<a href="../Hop.html" title="class in org.apache.sysds.hops">Hop</a>&gt;&nbsp;inputs,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a>&lt;<a href="../fedplanner/FTypes.FType.html" title="enum in org.apache.sysds.hops.fedplanner">FTypes.FType</a>&gt;&nbsp;inputDependency)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.apache.sysds.hops.Hop,org.apache.sysds.runtime.instructions.fed.FEDInstruction.FederatedOutput,org.apache.sysds.hops.fedplanner.MemoTable)">HopRel</a></span>&#8203;(<a href="../Hop.html" title="class in org.apache.sysds.hops">Hop</a>&nbsp;associatedHop,
<a href="../../runtime/instructions/fed/FEDInstruction.FederatedOutput.html" title="enum in org.apache.sysds.runtime.instructions.fed">FEDInstruction.FederatedOutput</a>&nbsp;fedOut,
<a href="../fedplanner/MemoTable.html" title="class in org.apache.sysds.hops.fedplanner">MemoTable</a>&nbsp;hopRelMemo)</code></th>
<td class="colLast">
<div class="block">Constructs a HopRel with input dependency and cost estimate based on entries in hopRelMemo.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.apache.sysds.hops.Hop,org.apache.sysds.runtime.instructions.fed.FEDInstruction.FederatedOutput,org.apache.sysds.hops.fedplanner.MemoTable,java.util.ArrayList)">HopRel</a></span>&#8203;(<a href="../Hop.html" title="class in org.apache.sysds.hops">Hop</a>&nbsp;associatedHop,
<a href="../../runtime/instructions/fed/FEDInstruction.FederatedOutput.html" title="enum in org.apache.sysds.runtime.instructions.fed">FEDInstruction.FederatedOutput</a>&nbsp;fedOut,
<a href="../fedplanner/MemoTable.html" title="class in org.apache.sysds.hops.fedplanner">MemoTable</a>&nbsp;hopRelMemo,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/ArrayList.html?is-external=true" title="class or interface in java.util" class="externalLink">ArrayList</a>&lt;<a href="../Hop.html" title="class in org.apache.sysds.hops">Hop</a>&gt;&nbsp;inputs)</code></th>
<td class="colLast">
<div class="block">Constructs a HopRel with input dependency and cost estimate based on entries in hopRelMemo.</div>
</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ========== METHOD SUMMARY =========== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<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="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addCostPointer(long)">addCostPointer</a></span>&#8203;(long&nbsp;hopID)</code></th>
<td class="colLast">
<div class="block">Adds hopID to set of hops pointing to this HopRel.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#existingCostPointer(long)">existingCostPointer</a></span>&#8203;(long&nbsp;currentHopID)</code></th>
<td class="colLast">
<div class="block">Checks if another Hop is refering to this HopRel in memo table.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>double</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCost()">getCost</a></span>()</code></th>
<td class="colLast">
<div class="block">Get total cost as double</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="FederatedCost.html" title="class in org.apache.sysds.hops.cost">FederatedCost</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCostObject()">getCostObject</a></span>()</code></th>
<td class="colLast">
<div class="block">Get cost object</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../../common/Types.ExecType.html" title="enum in org.apache.sysds.common">Types.ExecType</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getExecType()">getExecType</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="../../runtime/instructions/fed/FEDInstruction.FederatedOutput.html" title="enum in org.apache.sysds.runtime.instructions.fed">FEDInstruction.FederatedOutput</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getFederatedOutput()">getFederatedOutput</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="../fedplanner/FTypes.FType.html" title="enum in org.apache.sysds.hops.fedplanner">FTypes.FType</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getFType()">getFType</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="../Hop.html" title="class in org.apache.sysds.hops">Hop</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getHopRef()">getHopRef</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a>&lt;<a href="HopRel.html" title="class in org.apache.sysds.hops.cost">HopRel</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getInputDependency()">getInputDependency</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hasFederatedOutput()">hasFederatedOutput</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hasLocalOutput()">hasLocalOutput</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setFType(org.apache.sysds.hops.fedplanner.FTypes.FType)">setFType</a></span>&#8203;(<a href="../fedplanner/FTypes.FType.html" title="enum in org.apache.sysds.hops.fedplanner">FTypes.FType</a>&nbsp;fType)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toString()">toString</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></h3>
<code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang" class="externalLink">equals</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang" class="externalLink">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang" class="externalLink">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang" class="externalLink">notify</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang" class="externalLink">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#wait(long,int)" title="class or interface in java.lang" class="externalLink">wait</a></code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a id="&lt;init&gt;(org.apache.sysds.hops.Hop,org.apache.sysds.runtime.instructions.fed.FEDInstruction.FederatedOutput,org.apache.sysds.hops.fedplanner.MemoTable)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>HopRel</h4>
<pre>public&nbsp;HopRel&#8203;(<a href="../Hop.html" title="class in org.apache.sysds.hops">Hop</a>&nbsp;associatedHop,
<a href="../../runtime/instructions/fed/FEDInstruction.FederatedOutput.html" title="enum in org.apache.sysds.runtime.instructions.fed">FEDInstruction.FederatedOutput</a>&nbsp;fedOut,
<a href="../fedplanner/MemoTable.html" title="class in org.apache.sysds.hops.fedplanner">MemoTable</a>&nbsp;hopRelMemo)</pre>
<div class="block">Constructs a HopRel with input dependency and cost estimate based on entries in hopRelMemo.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>associatedHop</code> - hop associated with this HopRel</dd>
<dd><code>fedOut</code> - FederatedOutput value assigned to this HopRel</dd>
<dd><code>hopRelMemo</code> - memo table storing other HopRels including the inputs of associatedHop</dd>
</dl>
</li>
</ul>
<a id="&lt;init&gt;(org.apache.sysds.hops.Hop,org.apache.sysds.runtime.instructions.fed.FEDInstruction.FederatedOutput,org.apache.sysds.hops.fedplanner.MemoTable,java.util.ArrayList)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>HopRel</h4>
<pre>public&nbsp;HopRel&#8203;(<a href="../Hop.html" title="class in org.apache.sysds.hops">Hop</a>&nbsp;associatedHop,
<a href="../../runtime/instructions/fed/FEDInstruction.FederatedOutput.html" title="enum in org.apache.sysds.runtime.instructions.fed">FEDInstruction.FederatedOutput</a>&nbsp;fedOut,
<a href="../fedplanner/MemoTable.html" title="class in org.apache.sysds.hops.fedplanner">MemoTable</a>&nbsp;hopRelMemo,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/ArrayList.html?is-external=true" title="class or interface in java.util" class="externalLink">ArrayList</a>&lt;<a href="../Hop.html" title="class in org.apache.sysds.hops">Hop</a>&gt;&nbsp;inputs)</pre>
<div class="block">Constructs a HopRel with input dependency and cost estimate based on entries in hopRelMemo.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>associatedHop</code> - hop associated with this HopRel</dd>
<dd><code>fedOut</code> - FederatedOutput value assigned to this HopRel</dd>
<dd><code>hopRelMemo</code> - memo table storing other HopRels including the inputs of associatedHop</dd>
<dd><code>inputs</code> - hop inputs which input dependencies and cost is based on</dd>
</dl>
</li>
</ul>
<a id="&lt;init&gt;(org.apache.sysds.hops.Hop,org.apache.sysds.runtime.instructions.fed.FEDInstruction.FederatedOutput,org.apache.sysds.hops.fedplanner.FTypes.FType,org.apache.sysds.hops.fedplanner.MemoTable,java.util.ArrayList)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>HopRel</h4>
<pre>public&nbsp;HopRel&#8203;(<a href="../Hop.html" title="class in org.apache.sysds.hops">Hop</a>&nbsp;associatedHop,
<a href="../../runtime/instructions/fed/FEDInstruction.FederatedOutput.html" title="enum in org.apache.sysds.runtime.instructions.fed">FEDInstruction.FederatedOutput</a>&nbsp;fedOut,
<a href="../fedplanner/FTypes.FType.html" title="enum in org.apache.sysds.hops.fedplanner">FTypes.FType</a>&nbsp;fType,
<a href="../fedplanner/MemoTable.html" title="class in org.apache.sysds.hops.fedplanner">MemoTable</a>&nbsp;hopRelMemo,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/ArrayList.html?is-external=true" title="class or interface in java.util" class="externalLink">ArrayList</a>&lt;<a href="../Hop.html" title="class in org.apache.sysds.hops">Hop</a>&gt;&nbsp;inputs)</pre>
<div class="block">Constructs a HopRel with input dependency and cost estimate based on entries in hopRelMemo.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>associatedHop</code> - hop associated with this HopRel</dd>
<dd><code>fedOut</code> - FederatedOutput value assigned to this HopRel</dd>
<dd><code>fType</code> - Federated Type of the output of this hopRel</dd>
<dd><code>hopRelMemo</code> - memo table storing other HopRels including the inputs of associatedHop</dd>
<dd><code>inputs</code> - hop inputs which input dependencies and cost is based on</dd>
</dl>
</li>
</ul>
<a id="&lt;init&gt;(org.apache.sysds.hops.Hop,org.apache.sysds.runtime.instructions.fed.FEDInstruction.FederatedOutput,org.apache.sysds.hops.fedplanner.FTypes.FType,org.apache.sysds.hops.fedplanner.MemoTable,java.util.List,java.util.List)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>HopRel</h4>
<pre>public&nbsp;HopRel&#8203;(<a href="../Hop.html" title="class in org.apache.sysds.hops">Hop</a>&nbsp;associatedHop,
<a href="../../runtime/instructions/fed/FEDInstruction.FederatedOutput.html" title="enum in org.apache.sysds.runtime.instructions.fed">FEDInstruction.FederatedOutput</a>&nbsp;fedOut,
<a href="../fedplanner/FTypes.FType.html" title="enum in org.apache.sysds.hops.fedplanner">FTypes.FType</a>&nbsp;fType,
<a href="../fedplanner/MemoTable.html" title="class in org.apache.sysds.hops.fedplanner">MemoTable</a>&nbsp;hopRelMemo,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a>&lt;<a href="../Hop.html" title="class in org.apache.sysds.hops">Hop</a>&gt;&nbsp;inputs,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a>&lt;<a href="../fedplanner/FTypes.FType.html" title="enum in org.apache.sysds.hops.fedplanner">FTypes.FType</a>&gt;&nbsp;inputDependency)</pre>
</li>
</ul>
</li>
</ul>
</section>
<!-- ============ METHOD DETAIL ========== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="addCostPointer(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addCostPointer</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;addCostPointer&#8203;(long&nbsp;hopID)</pre>
<div class="block">Adds hopID to set of hops pointing to this HopRel.
By storing the hopID it can later be determined if the cost
stored in this HopRel is already used as input cost in another HopRel.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>hopID</code> - added to set of stored cost pointers</dd>
</dl>
</li>
</ul>
<a id="existingCostPointer(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>existingCostPointer</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;existingCostPointer&#8203;(long&nbsp;currentHopID)</pre>
<div class="block">Checks if another Hop is refering to this HopRel in memo table.
A reference from a HopRel with same Hop ID is allowed, so this
ID is ignored when checking references.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>currentHopID</code> - to ignore when checking references</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if another Hop refers to this HopRel in memo table</dd>
</dl>
</li>
</ul>
<a id="hasLocalOutput()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasLocalOutput</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;hasLocalOutput()</pre>
</li>
</ul>
<a id="hasFederatedOutput()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasFederatedOutput</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;hasFederatedOutput()</pre>
</li>
</ul>
<a id="getFederatedOutput()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFederatedOutput</h4>
<pre class="methodSignature">public&nbsp;<a href="../../runtime/instructions/fed/FEDInstruction.FederatedOutput.html" title="enum in org.apache.sysds.runtime.instructions.fed">FEDInstruction.FederatedOutput</a>&nbsp;getFederatedOutput()</pre>
</li>
</ul>
<a id="getInputDependency()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getInputDependency</h4>
<pre class="methodSignature">public&nbsp;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a>&lt;<a href="HopRel.html" title="class in org.apache.sysds.hops.cost">HopRel</a>&gt;&nbsp;getInputDependency()</pre>
</li>
</ul>
<a id="getHopRef()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getHopRef</h4>
<pre class="methodSignature">public&nbsp;<a href="../Hop.html" title="class in org.apache.sysds.hops">Hop</a>&nbsp;getHopRef()</pre>
</li>
</ul>
<a id="getFType()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFType</h4>
<pre class="methodSignature">public&nbsp;<a href="../fedplanner/FTypes.FType.html" title="enum in org.apache.sysds.hops.fedplanner">FTypes.FType</a>&nbsp;getFType()</pre>
</li>
</ul>
<a id="setFType(org.apache.sysds.hops.fedplanner.FTypes.FType)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setFType</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setFType&#8203;(<a href="../fedplanner/FTypes.FType.html" title="enum in org.apache.sysds.hops.fedplanner">FTypes.FType</a>&nbsp;fType)</pre>
</li>
</ul>
<a id="getExecType()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getExecType</h4>
<pre class="methodSignature">public&nbsp;<a href="../../common/Types.ExecType.html" title="enum in org.apache.sysds.common">Types.ExecType</a>&nbsp;getExecType()</pre>
</li>
</ul>
<a id="getCost()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCost</h4>
<pre class="methodSignature">public&nbsp;double&nbsp;getCost()</pre>
<div class="block">Get total cost as double</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>cost as double</dd>
</dl>
</li>
</ul>
<a id="getCostObject()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCostObject</h4>
<pre class="methodSignature">public&nbsp;<a href="FederatedCost.html" title="class in org.apache.sysds.hops.cost">FederatedCost</a>&nbsp;getCostObject()</pre>
<div class="block">Get cost object</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>cost object</dd>
</dl>
</li>
</ul>
<a id="toString()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toString</h4>
<pre class="methodSignature">public&nbsp;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;toString()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang" class="externalLink">toString</a></code>&nbsp;in class&nbsp;<code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></code></dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/HopRel.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" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses.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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</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 id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Copyright &#169; 2023 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</body>
</html>