blob: 4d6bfbbc8a0b4437efabac39302f860cd37af30b [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>NaryOp (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="NaryOp (SystemDS 2.1.0-SNAPSHOT API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":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/NaryOp.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/MultiThreadedHop.html" title="class in org.apache.sysds.hops"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/sysds/hops/OptimizerUtils.html" title="class in org.apache.sysds.hops"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/sysds/hops/NaryOp.html" target="_top">Frames</a></li>
<li><a href="NaryOp.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><a href="#fields.inherited.from.class.org.apache.sysds.hops.Hop">Field</a>&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</div>
<h2 title="Class NaryOp" class="title">Class NaryOp</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/Hop.html" title="class in org.apache.sysds.hops">org.apache.sysds.hops.Hop</a></li>
<li>
<ul class="inheritance">
<li>org.apache.sysds.hops.NaryOp</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../org/apache/sysds/parser/ParseInfo.html" title="interface in org.apache.sysds.parser">ParseInfo</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">NaryOp</span>
extends <a href="../../../../org/apache/sysds/hops/Hop.html" title="class in org.apache.sysds.hops">Hop</a></pre>
<div class="block">The NaryOp Hop allows for a variable number of operands. Functionality
such as 'printf' (overloaded into the existing print function) is an example
of an operation that potentially takes a variable number of operands.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.apache.sysds.hops.Hop">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.apache.sysds.hops.<a href="../../../../org/apache/sysds/hops/Hop.html" title="class in org.apache.sysds.hops">Hop</a></h3>
<code><a href="../../../../org/apache/sysds/hops/Hop.html#Z:Z_beginColumn">_beginColumn</a>, <a href="../../../../org/apache/sysds/hops/Hop.html#Z:Z_beginLine">_beginLine</a>, <a href="../../../../org/apache/sysds/hops/Hop.html#Z:Z_endColumn">_endColumn</a>, <a href="../../../../org/apache/sysds/hops/Hop.html#Z:Z_endLine">_endLine</a>, <a href="../../../../org/apache/sysds/hops/Hop.html#Z:Z_filename">_filename</a>, <a href="../../../../org/apache/sysds/hops/Hop.html#Z:Z_text">_text</a>, <a href="../../../../org/apache/sysds/hops/Hop.html#CPThreshold">CPThreshold</a></code></li>
</ul>
</li>
</ul>
<!-- ======== 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/NaryOp.html#NaryOp-java.lang.String-org.apache.sysds.common.Types.DataType-org.apache.sysds.common.Types.ValueType-org.apache.sysds.common.Types.OpOpN-org.apache.sysds.hops.Hop...-">NaryOp</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name,
<a href="../../../../org/apache/sysds/common/Types.DataType.html" title="enum in org.apache.sysds.common">Types.DataType</a>&nbsp;dataType,
<a href="../../../../org/apache/sysds/common/Types.ValueType.html" title="enum in org.apache.sysds.common">Types.ValueType</a>&nbsp;valueType,
<a href="../../../../org/apache/sysds/common/Types.OpOpN.html" title="enum in org.apache.sysds.common">Types.OpOpN</a>&nbsp;op,
<a href="../../../../org/apache/sysds/hops/Hop.html" title="class in org.apache.sysds.hops">Hop</a>...&nbsp;inputs)</code>
<div class="block">NaryOp constructor.</div>
</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/NaryOp.html#allowsAllExecTypes--">allowsAllExecTypes</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/sysds/hops/NaryOp.html#checkArity--">checkArity</a></span>()</code>
<div class="block">MultipleOp may have any number of inputs.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><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></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/sysds/hops/NaryOp.html#clone--">clone</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/sysds/hops/NaryOp.html#compare-org.apache.sysds.hops.Hop-">compare</a></span>(<a href="../../../../org/apache/sysds/hops/Hop.html" title="class in org.apache.sysds.hops">Hop</a>&nbsp;that)</code>&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/sysds/hops/NaryOp.html#computeMemEstimate-org.apache.sysds.hops.MemoTable-">computeMemEstimate</a></span>(<a href="../../../../org/apache/sysds/hops/MemoTable.html" title="class in org.apache.sysds.hops">MemoTable</a>&nbsp;memo)</code>
<div class="block">Computes the estimate of memory required to store the input/output of this hop in memory.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/sysds/lops/Lop.html" title="class in org.apache.sysds.lops">Lop</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/sysds/hops/NaryOp.html#constructLops--">constructLops</a></span>()</code>
<div class="block">Construct the corresponding Lops for this Hop</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/sysds/common/Types.OpOpN.html" title="enum in org.apache.sysds.common">Types.OpOpN</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/sysds/hops/NaryOp.html#getOp--">getOp</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/sysds/hops/NaryOp.html#getOpString--">getOpString</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/sysds/hops/NaryOp.html#isGPUEnabled--">isGPUEnabled</a></span>()</code>
<div class="block">In memory-based optimizer mode (see OptimizerUtils.isMemoryBasedOptLevel()),
the exectype is determined by checking this method as well as memory budget of this Hop.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/sysds/hops/NaryOp.html#refreshSizeInformation--">refreshSizeInformation</a></span>()</code>
<div class="block">Update the output size information for this hop.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.sysds.hops.Hop">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.sysds.hops.<a href="../../../../org/apache/sysds/hops/Hop.html" title="class in org.apache.sysds.hops">Hop</a></h3>
<code><a href="../../../../org/apache/sysds/hops/Hop.html#addAllInputs-java.util.ArrayList-">addAllInputs</a>, <a href="../../../../org/apache/sysds/hops/Hop.html#addInput-org.apache.sysds.hops.Hop-">addInput</a>, <a href="../../../../org/apache/sysds/hops/Hop.html#checkAndSetForcedPlatform--">checkAndSetForcedPlatform</a>, <a href="../../../../org/apache/sysds/hops/Hop.html#checkAndSetInvalidCPDimsAndSize--">checkAndSetInvalidCPDimsAndSize</a>, <a href="../../../../org/apache/sysds/hops/Hop.html#clearMemEstimate--">clearMemEstimate</a>, <a href="../../../../org/apache/sysds/hops/Hop.html#colsKnown--">colsKnown</a>, <a href="../../../../org/apache/sysds/hops/Hop.html#computeBoundsInformation-org.apache.sysds.hops.Hop-">computeBoundsInformation</a>, <a href="../../../../org/apache/sysds/hops/Hop.html#computeBoundsInformation-org.apache.sysds.hops.Hop-org.apache.sysds.runtime.controlprogram.LocalVariableMap-">computeBoundsInformation</a>, <a href="../../../../org/apache/sysds/hops/Hop.html#computeBoundsInformation-org.apache.sysds.hops.Hop-org.apache.sysds.runtime.controlprogram.LocalVariableMap-java.util.HashMap-">computeBoundsInformation</a>, <a href="../../../../org/apache/sysds/hops/Hop.html#computeSizeInformation-org.apache.sysds.hops.Hop-">computeSizeInformation</a>, <a href="../../../../org/apache/sysds/hops/Hop.html#computeSizeInformation-org.apache.sysds.hops.Hop-org.apache.sysds.runtime.controlprogram.LocalVariableMap-">computeSizeInformation</a>, <a href="../../../../org/apache/sysds/hops/Hop.html#computeSizeInformation-org.apache.sysds.hops.Hop-org.apache.sysds.runtime.controlprogram.LocalVariableMap-java.util.HashMap-">computeSizeInformation</a>, <a href="../../../../org/apache/sysds/hops/Hop.html#constructAndSetLopsDataFlowProperties--">constructAndSetLopsDataFlowProperties</a>, <a href="../../../../org/apache/sysds/hops/Hop.html#createOffsetLop-org.apache.sysds.hops.Hop-boolean-">createOffsetLop</a>, <a href="../../../../org/apache/sysds/hops/Hop.html#dimsKnown--">dimsKnown</a>, <a href="../../../../org/apache/sysds/hops/Hop.html#dimsKnown-boolean-">dimsKnown</a>, <a href="../../../../org/apache/sysds/hops/Hop.html#dimsKnownAny--">dimsKnownAny</a>, <a href="../../../../org/apache/sysds/hops/Hop.html#getBeginColumn--">getBeginColumn</a>, <a href="../../../../org/apache/sysds/hops/Hop.html#getBeginLine--">getBeginLine</a>, <a href="../../../../org/apache/sysds/hops/Hop.html#getBlocksize--">getBlocksize</a>, <a href="../../../../org/apache/sysds/hops/Hop.html#getDataCharacteristics--">getDataCharacteristics</a>, <a href="../../../../org/apache/sysds/hops/Hop.html#getDataType--">getDataType</a>, <a href="../../../../org/apache/sysds/hops/Hop.html#getDim-int-">getDim</a>, <a href="../../../../org/apache/sysds/hops/Hop.html#getDim1--">getDim1</a>, <a href="../../../../org/apache/sysds/hops/Hop.html#getDim2--">getDim2</a>, <a href="../../../../org/apache/sysds/hops/Hop.html#getEndColumn--">getEndColumn</a>, <a href="../../../../org/apache/sysds/hops/Hop.html#getEndLine--">getEndLine</a>, <a href="../../../../org/apache/sysds/hops/Hop.html#getExecType--">getExecType</a>, <a href="../../../../org/apache/sysds/hops/Hop.html#getFilename--">getFilename</a>, <a href="../../../../org/apache/sysds/hops/Hop.html#getForcedExecType--">getForcedExecType</a>, <a href="../../../../org/apache/sysds/hops/Hop.html#getHopID--">getHopID</a>, <a href="../../../../org/apache/sysds/hops/Hop.html#getInput--">getInput</a>, <a href="../../../../org/apache/sysds/hops/Hop.html#getInput-int-">getInput</a>, <a href="../../../../org/apache/sysds/hops/Hop.html#getInputMemEstimate--">getInputMemEstimate</a>, <a href="../../../../org/apache/sysds/hops/Hop.html#getInputOutputSize-java.util.Collection-">getInputOutputSize</a>, <a href="../../../../org/apache/sysds/hops/Hop.html#getIntermediateMemEstimate--">getIntermediateMemEstimate</a>, <a href="../../../../org/apache/sysds/hops/Hop.html#getLength--">getLength</a>, <a href="../../../../org/apache/sysds/hops/Hop.html#getLops--">getLops</a>, <a href="../../../../org/apache/sysds/hops/Hop.html#getMemEstimate--">getMemEstimate</a>, <a href="../../../../org/apache/sysds/hops/Hop.html#getName--">getName</a>, <a href="../../../../org/apache/sysds/hops/Hop.html#getNnz--">getNnz</a>, <a href="../../../../org/apache/sysds/hops/Hop.html#getOutputMemEstimate--">getOutputMemEstimate</a>, <a href="../../../../org/apache/sysds/hops/Hop.html#getParent--">getParent</a>, <a href="../../../../org/apache/sysds/hops/Hop.html#getPrivacy--">getPrivacy</a>, <a href="../../../../org/apache/sysds/hops/Hop.html#getSparsity--">getSparsity</a>, <a href="../../../../org/apache/sysds/hops/Hop.html#getSpBroadcastSize--">getSpBroadcastSize</a>, <a href="../../../../org/apache/sysds/hops/Hop.html#getText--">getText</a>, <a href="../../../../org/apache/sysds/hops/Hop.html#getUpdateType--">getUpdateType</a>, <a href="../../../../org/apache/sysds/hops/Hop.html#getValueType--">getValueType</a>, <a href="../../../../org/apache/sysds/hops/Hop.html#hasMatrixInputWithDifferentBlocksizes--">hasMatrixInputWithDifferentBlocksizes</a>, <a href="../../../../org/apache/sysds/hops/Hop.html#hasValidCPDimsAndSize--">hasValidCPDimsAndSize</a>, <a href="../../../../org/apache/sysds/hops/Hop.html#isMatrix--">isMatrix</a>, <a href="../../../../org/apache/sysds/hops/Hop.html#isMemEstimated--">isMemEstimated</a>, <a href="../../../../org/apache/sysds/hops/Hop.html#isOutputEmptyBlocks--">isOutputEmptyBlocks</a>, <a href="../../../../org/apache/sysds/hops/Hop.html#isScalar--">isScalar</a>, <a href="../../../../org/apache/sysds/hops/Hop.html#isTransposeSafe--">isTransposeSafe</a>, <a href="../../../../org/apache/sysds/hops/Hop.html#isVisited--">isVisited</a>, <a href="../../../../org/apache/sysds/hops/Hop.html#printErrorLocation--">printErrorLocation</a>, <a href="../../../../org/apache/sysds/hops/Hop.html#refreshColsParameterInformation-org.apache.sysds.hops.Hop-org.apache.sysds.runtime.controlprogram.LocalVariableMap-">refreshColsParameterInformation</a>, <a href="../../../../org/apache/sysds/hops/Hop.html#refreshColsParameterInformation-org.apache.sysds.hops.Hop-org.apache.sysds.runtime.controlprogram.LocalVariableMap-java.util.HashMap-">refreshColsParameterInformation</a>, <a href="../../../../org/apache/sysds/hops/Hop.html#refreshMemEstimates-org.apache.sysds.hops.MemoTable-">refreshMemEstimates</a>, <a href="../../../../org/apache/sysds/hops/Hop.html#refreshRowsParameterInformation-org.apache.sysds.hops.Hop-org.apache.sysds.runtime.controlprogram.LocalVariableMap-">refreshRowsParameterInformation</a>, <a href="../../../../org/apache/sysds/hops/Hop.html#refreshRowsParameterInformation-org.apache.sysds.hops.Hop-org.apache.sysds.runtime.controlprogram.LocalVariableMap-java.util.HashMap-">refreshRowsParameterInformation</a>, <a href="../../../../org/apache/sysds/hops/Hop.html#requiresCheckpoint--">requiresCheckpoint</a>, <a href="../../../../org/apache/sysds/hops/Hop.html#requiresCompression--">requiresCompression</a>, <a href="../../../../org/apache/sysds/hops/Hop.html#requiresLineageCaching--">requiresLineageCaching</a>, <a href="../../../../org/apache/sysds/hops/Hop.html#requiresReblock--">requiresReblock</a>, <a href="../../../../org/apache/sysds/hops/Hop.html#requiresRecompile--">requiresRecompile</a>, <a href="../../../../org/apache/sysds/hops/Hop.html#resetExecType--">resetExecType</a>, <a href="../../../../org/apache/sysds/hops/Hop.html#resetRecompilationFlag-java.util.ArrayList-org.apache.sysds.lops.LopProperties.ExecType-org.apache.sysds.hops.recompile.Recompiler.ResetType-">resetRecompilationFlag</a>, <a href="../../../../org/apache/sysds/hops/Hop.html#resetRecompilationFlag-org.apache.sysds.hops.Hop-org.apache.sysds.lops.LopProperties.ExecType-org.apache.sysds.hops.recompile.Recompiler.ResetType-">resetRecompilationFlag</a>, <a href="../../../../org/apache/sysds/hops/Hop.html#resetVisitStatus--">resetVisitStatus</a>, <a href="../../../../org/apache/sysds/hops/Hop.html#resetVisitStatus-java.util.ArrayList-">resetVisitStatus</a>, <a href="../../../../org/apache/sysds/hops/Hop.html#resetVisitStatus-java.util.ArrayList-boolean-">resetVisitStatus</a>, <a href="../../../../org/apache/sysds/hops/Hop.html#resetVisitStatusForced-java.util.HashSet-">resetVisitStatusForced</a>, <a href="../../../../org/apache/sysds/hops/Hop.html#rowsKnown--">rowsKnown</a>, <a href="../../../../org/apache/sysds/hops/Hop.html#setBeginColumn-int-">setBeginColumn</a>, <a href="../../../../org/apache/sysds/hops/Hop.html#setBeginLine-int-">setBeginLine</a>, <a href="../../../../org/apache/sysds/hops/Hop.html#setBlocksize-int-">setBlocksize</a>, <a href="../../../../org/apache/sysds/hops/Hop.html#setDataType-org.apache.sysds.common.Types.DataType-">setDataType</a>, <a href="../../../../org/apache/sysds/hops/Hop.html#setDim-int-long-">setDim</a>, <a href="../../../../org/apache/sysds/hops/Hop.html#setDim1-long-">setDim1</a>, <a href="../../../../org/apache/sysds/hops/Hop.html#setDim2-long-">setDim2</a>, <a href="../../../../org/apache/sysds/hops/Hop.html#setEndColumn-int-">setEndColumn</a>, <a href="../../../../org/apache/sysds/hops/Hop.html#setEndLine-int-">setEndLine</a>, <a href="../../../../org/apache/sysds/hops/Hop.html#setFilename-java.lang.String-">setFilename</a>, <a href="../../../../org/apache/sysds/hops/Hop.html#setForcedExecType-org.apache.sysds.lops.LopProperties.ExecType-">setForcedExecType</a>, <a href="../../../../org/apache/sysds/hops/Hop.html#setLops-org.apache.sysds.lops.Lop-">setLops</a>, <a href="../../../../org/apache/sysds/hops/Hop.html#setMemEstimate-double-">setMemEstimate</a>, <a href="../../../../org/apache/sysds/hops/Hop.html#setName-java.lang.String-">setName</a>, <a href="../../../../org/apache/sysds/hops/Hop.html#setNnz-long-">setNnz</a>, <a href="../../../../org/apache/sysds/hops/Hop.html#setOutputEmptyBlocks-boolean-">setOutputEmptyBlocks</a>, <a href="../../../../org/apache/sysds/hops/Hop.html#setParseInfo-org.apache.sysds.parser.ParseInfo-">setParseInfo</a>, <a href="../../../../org/apache/sysds/hops/Hop.html#setPrivacy-org.apache.sysds.runtime.privacy.PrivacyConstraint-">setPrivacy</a>, <a href="../../../../org/apache/sysds/hops/Hop.html#setRequiresCheckpoint-boolean-">setRequiresCheckpoint</a>, <a href="../../../../org/apache/sysds/hops/Hop.html#setRequiresCompression-boolean-">setRequiresCompression</a>, <a href="../../../../org/apache/sysds/hops/Hop.html#setRequiresDeCompression-boolean-">setRequiresDeCompression</a>, <a href="../../../../org/apache/sysds/hops/Hop.html#setRequiresLineageCaching-boolean-">setRequiresLineageCaching</a>, <a href="../../../../org/apache/sysds/hops/Hop.html#setRequiresReblock-boolean-">setRequiresReblock</a>, <a href="../../../../org/apache/sysds/hops/Hop.html#setRequiresRecompile--">setRequiresRecompile</a>, <a href="../../../../org/apache/sysds/hops/Hop.html#setText-java.lang.String-">setText</a>, <a href="../../../../org/apache/sysds/hops/Hop.html#setUpdateType-org.apache.sysds.runtime.controlprogram.caching.MatrixObject.UpdateType-">setUpdateType</a>, <a href="../../../../org/apache/sysds/hops/Hop.html#setValueType-org.apache.sysds.common.Types.ValueType-">setValueType</a>, <a href="../../../../org/apache/sysds/hops/Hop.html#setVisited--">setVisited</a>, <a href="../../../../org/apache/sysds/hops/Hop.html#setVisited-boolean-">setVisited</a>, <a href="../../../../org/apache/sysds/hops/Hop.html#toString--">toString</a></code></li>
</ul>
<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#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>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.sysds.parser.ParseInfo">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.sysds.parser.<a href="../../../../org/apache/sysds/parser/ParseInfo.html" title="interface in org.apache.sysds.parser">ParseInfo</a></h3>
<code><a href="../../../../org/apache/sysds/parser/ParseInfo.html#ctxAndFilenameToParseInfo-org.antlr.v4.runtime.ParserRuleContext-java.lang.String-">ctxAndFilenameToParseInfo</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="NaryOp-java.lang.String-org.apache.sysds.common.Types.DataType-org.apache.sysds.common.Types.ValueType-org.apache.sysds.common.Types.OpOpN-org.apache.sysds.hops.Hop...-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>NaryOp</h4>
<pre>public&nbsp;NaryOp(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name,
<a href="../../../../org/apache/sysds/common/Types.DataType.html" title="enum in org.apache.sysds.common">Types.DataType</a>&nbsp;dataType,
<a href="../../../../org/apache/sysds/common/Types.ValueType.html" title="enum in org.apache.sysds.common">Types.ValueType</a>&nbsp;valueType,
<a href="../../../../org/apache/sysds/common/Types.OpOpN.html" title="enum in org.apache.sysds.common">Types.OpOpN</a>&nbsp;op,
<a href="../../../../org/apache/sysds/hops/Hop.html" title="class in org.apache.sysds.hops">Hop</a>...&nbsp;inputs)</pre>
<div class="block">NaryOp constructor.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - the target name, typically set by the DMLTranslator when
constructing Hops. (For example, 'parsertemp1'.)</dd>
<dd><code>dataType</code> - the target data type (SCALAR for printf)</dd>
<dd><code>valueType</code> - the target value type (STRING for printf)</dd>
<dd><code>op</code> - the operation type (such as PRINTF)</dd>
<dd><code>inputs</code> - a variable number of input Hops</dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="checkArity--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>checkArity</h4>
<pre>public&nbsp;void&nbsp;checkArity()</pre>
<div class="block">MultipleOp may have any number of inputs.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/apache/sysds/hops/Hop.html#checkArity--">checkArity</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/apache/sysds/hops/Hop.html" title="class in org.apache.sysds.hops">Hop</a></code></dd>
</dl>
</li>
</ul>
<a name="getOp--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOp</h4>
<pre>public&nbsp;<a href="../../../../org/apache/sysds/common/Types.OpOpN.html" title="enum in org.apache.sysds.common">Types.OpOpN</a>&nbsp;getOp()</pre>
</li>
</ul>
<a name="getOpString--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOpString</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getOpString()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/apache/sysds/hops/Hop.html#getOpString--">getOpString</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/apache/sysds/hops/Hop.html" title="class in org.apache.sysds.hops">Hop</a></code></dd>
</dl>
</li>
</ul>
<a name="isGPUEnabled--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isGPUEnabled</h4>
<pre>public&nbsp;boolean&nbsp;isGPUEnabled()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../org/apache/sysds/hops/Hop.html#isGPUEnabled--">Hop</a></code></span></div>
<div class="block">In memory-based optimizer mode (see OptimizerUtils.isMemoryBasedOptLevel()),
the exectype is determined by checking this method as well as memory budget of this Hop.
Please see findExecTypeByMemEstimate for more detail.
This method is necessary because not all operator are supported efficiently
on GPU (for example: operations on frames and scalar as well as operations such as table).</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/apache/sysds/hops/Hop.html#isGPUEnabled--">isGPUEnabled</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/apache/sysds/hops/Hop.html" title="class in org.apache.sysds.hops">Hop</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if the Hop is eligible for GPU Exectype.</dd>
</dl>
</li>
</ul>
<a name="constructLops--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>constructLops</h4>
<pre>public&nbsp;<a href="../../../../org/apache/sysds/lops/Lop.html" title="class in org.apache.sysds.lops">Lop</a>&nbsp;constructLops()</pre>
<div class="block">Construct the corresponding Lops for this Hop</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/apache/sysds/hops/Hop.html#constructLops--">constructLops</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/apache/sysds/hops/Hop.html" title="class in org.apache.sysds.hops">Hop</a></code></dd>
</dl>
</li>
</ul>
<a name="allowsAllExecTypes--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>allowsAllExecTypes</h4>
<pre>public&nbsp;boolean&nbsp;allowsAllExecTypes()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/apache/sysds/hops/Hop.html#allowsAllExecTypes--">allowsAllExecTypes</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/apache/sysds/hops/Hop.html" title="class in org.apache.sysds.hops">Hop</a></code></dd>
</dl>
</li>
</ul>
<a name="computeMemEstimate-org.apache.sysds.hops.MemoTable-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>computeMemEstimate</h4>
<pre>public&nbsp;void&nbsp;computeMemEstimate(<a href="../../../../org/apache/sysds/hops/MemoTable.html" title="class in org.apache.sysds.hops">MemoTable</a>&nbsp;memo)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../org/apache/sysds/hops/Hop.html#computeMemEstimate-org.apache.sysds.hops.MemoTable-">Hop</a></code></span></div>
<div class="block">Computes the estimate of memory required to store the input/output of this hop in memory.
This is the default implementation (orchestration of hop-specific implementation)
that should suffice for most hops. If a hop requires more control, this method should
be overwritten with awareness of (1) output estimates, and (2) propagation of worst-case
matrix characteristics (dimensions, sparsity).
TODO remove memo table and, on constructor refresh, inference in refresh, single compute mem,
maybe general computeMemEstimate, flags to indicate if estimate or not.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../org/apache/sysds/hops/Hop.html#computeMemEstimate-org.apache.sysds.hops.MemoTable-">computeMemEstimate</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/apache/sysds/hops/Hop.html" title="class in org.apache.sysds.hops">Hop</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>memo</code> - memory table</dd>
</dl>
</li>
</ul>
<a name="refreshSizeInformation--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>refreshSizeInformation</h4>
<pre>public&nbsp;void&nbsp;refreshSizeInformation()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../org/apache/sysds/hops/Hop.html#refreshSizeInformation--">Hop</a></code></span></div>
<div class="block">Update the output size information for this hop.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/apache/sysds/hops/Hop.html#refreshSizeInformation--">refreshSizeInformation</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/apache/sysds/hops/Hop.html" title="class in org.apache.sysds.hops">Hop</a></code></dd>
</dl>
</li>
</ul>
<a name="clone--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clone</h4>
<pre>public&nbsp;<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>&nbsp;clone()
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/CloneNotSupportedException.html?is-external=true" title="class or interface in java.lang">CloneNotSupportedException</a></pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/apache/sysds/hops/Hop.html#clone--">clone</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/apache/sysds/hops/Hop.html" title="class in org.apache.sysds.hops">Hop</a></code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/CloneNotSupportedException.html?is-external=true" title="class or interface in java.lang">CloneNotSupportedException</a></code></dd>
</dl>
</li>
</ul>
<a name="compare-org.apache.sysds.hops.Hop-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>compare</h4>
<pre>public&nbsp;boolean&nbsp;compare(<a href="../../../../org/apache/sysds/hops/Hop.html" title="class in org.apache.sysds.hops">Hop</a>&nbsp;that)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/apache/sysds/hops/Hop.html#compare-org.apache.sysds.hops.Hop-">compare</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/apache/sysds/hops/Hop.html" title="class in org.apache.sysds.hops">Hop</a></code></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/NaryOp.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/MultiThreadedHop.html" title="class in org.apache.sysds.hops"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/sysds/hops/OptimizerUtils.html" title="class in org.apache.sysds.hops"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/sysds/hops/NaryOp.html" target="_top">Frames</a></li>
<li><a href="NaryOp.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><a href="#fields.inherited.from.class.org.apache.sysds.hops.Hop">Field</a>&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>