blob: 087237b590aafa1cc2a77e728ceafe4539860bab [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>UnaryOp (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.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.5.1.js"></script>
<script type="text/javascript" src="../../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="UnaryOp (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,"i13":10,"i14":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/UnaryOp.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><a href="#field.summary">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 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</a></div>
<h2 title="Class UnaryOp" class="title">Class UnaryOp</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><a href="Hop.html" title="class in org.apache.sysds.hops">org.apache.sysds.hops.Hop</a></li>
<li>
<ul class="inheritance">
<li><a href="MultiThreadedHop.html" title="class in org.apache.sysds.hops">org.apache.sysds.hops.MultiThreadedHop</a></li>
<li>
<ul class="inheritance">
<li>org.apache.sysds.hops.UnaryOp</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="../parser/ParseInfo.html" title="interface in org.apache.sysds.parser">ParseInfo</a></code></dd>
</dl>
<hr>
<pre>public class <span class="typeNameLabel">UnaryOp</span>
extends <a href="MultiThreadedHop.html" title="class in org.apache.sysds.hops">MultiThreadedHop</a></pre>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<ul class="blockList">
<li class="blockList"><a id="fields.inherited.from.class.org.apache.sysds.hops.Hop">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.apache.sysds.hops.<a href="Hop.html" title="class in org.apache.sysds.hops">Hop</a></h3>
<code><a href="Hop.html#_beginColumn">_beginColumn</a>, <a href="Hop.html#_beginLine">_beginLine</a>, <a href="Hop.html#_endColumn">_endColumn</a>, <a href="Hop.html#_endLine">_endLine</a>, <a href="Hop.html#_filename">_filename</a>, <a href="Hop.html#_text">_text</a>, <a href="Hop.html#CPThreshold">CPThreshold</a></code></li>
</ul>
</li>
</ul>
</section>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<section role="region">
<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(java.lang.String,org.apache.sysds.common.Types.DataType,org.apache.sysds.common.Types.ValueType,org.apache.sysds.common.Types.OpOp1,org.apache.sysds.hops.Hop)">UnaryOp</a></span>&#8203;(<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;l,
<a href="../common/Types.DataType.html" title="enum in org.apache.sysds.common">Types.DataType</a>&nbsp;dt,
<a href="../common/Types.ValueType.html" title="enum in org.apache.sysds.common">Types.ValueType</a>&nbsp;vt,
<a href="../common/Types.OpOp1.html" title="enum in org.apache.sysds.common">Types.OpOp1</a>&nbsp;o,
<a href="Hop.html" title="class in org.apache.sysds.hops">Hop</a>&nbsp;inp)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
<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>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#allowsAllExecTypes()">allowsAllExecTypes</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#checkArity()">checkArity</a></span>()</code></th>
<td class="colLast">
<div class="block">Check whether this Hop has a correct number of inputs.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><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></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#clone()">clone</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#compare(org.apache.sysds.hops.Hop)">compare</a></span>&#8203;(<a href="Hop.html" title="class in org.apache.sysds.hops">Hop</a>&nbsp;that)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#computeMemEstimate(org.apache.sysds.hops.MemoTable)">computeMemEstimate</a></span>&#8203;(<a href="MemoTable.html" title="class in org.apache.sysds.hops">MemoTable</a>&nbsp;memo)</code></th>
<td class="colLast">
<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="../lops/Lop.html" title="class in org.apache.sysds.lops">Lop</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#constructLops()">constructLops</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="../common/Types.OpOp1.html" title="enum in org.apache.sysds.common">Types.OpOp1</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getOp()">getOp</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<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="#getOpString()">getOpString</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isCastUnaryOperation()">isCastUnaryOperation</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="#isCumulativeUnaryOperation()">isCumulativeUnaryOperation</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="#isExpensiveUnaryOperation()">isExpensiveUnaryOperation</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isGPUEnabled()">isGPUEnabled</a></span>()</code></th>
<td class="colLast">
<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="i12" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isMetadataOperation()">isMetadataOperation</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isMultiThreadedOpType()">isMultiThreadedOpType</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#refreshSizeInformation()">refreshSizeInformation</a></span>()</code></th>
<td class="colLast">
<div class="block">Update the output size information for this hop.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.apache.sysds.hops.MultiThreadedHop">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.sysds.hops.<a href="MultiThreadedHop.html" title="class in org.apache.sysds.hops">MultiThreadedHop</a></h3>
<code><a href="MultiThreadedHop.html#getMaxNumThreads()">getMaxNumThreads</a>, <a href="MultiThreadedHop.html#setMaxNumThreads(int)">setMaxNumThreads</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.apache.sysds.hops.Hop">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.sysds.hops.<a href="Hop.html" title="class in org.apache.sysds.hops">Hop</a></h3>
<code><a href="Hop.html#activatePrefetch()">activatePrefetch</a>, <a href="Hop.html#addAllInputs(java.util.ArrayList)">addAllInputs</a>, <a href="Hop.html#addInput(org.apache.sysds.hops.Hop)">addInput</a>, <a href="Hop.html#checkAndSetForcedPlatform()">checkAndSetForcedPlatform</a>, <a href="Hop.html#checkAndSetInvalidCPDimsAndSize()">checkAndSetInvalidCPDimsAndSize</a>, <a href="Hop.html#clearMemEstimate()">clearMemEstimate</a>, <a href="Hop.html#colsKnown()">colsKnown</a>, <a href="Hop.html#compressedSize()">compressedSize</a>, <a href="Hop.html#computeBoundsInformation(org.apache.sysds.hops.Hop)">computeBoundsInformation</a>, <a href="Hop.html#computeBoundsInformation(org.apache.sysds.hops.Hop,org.apache.sysds.runtime.controlprogram.LocalVariableMap)">computeBoundsInformation</a>, <a href="Hop.html#computeBoundsInformation(org.apache.sysds.hops.Hop,org.apache.sysds.runtime.controlprogram.LocalVariableMap,java.util.HashMap)">computeBoundsInformation</a>, <a href="Hop.html#computeSizeInformation(org.apache.sysds.hops.Hop)">computeSizeInformation</a>, <a href="Hop.html#computeSizeInformation(org.apache.sysds.hops.Hop,org.apache.sysds.runtime.controlprogram.LocalVariableMap)">computeSizeInformation</a>, <a href="Hop.html#computeSizeInformation(org.apache.sysds.hops.Hop,org.apache.sysds.runtime.controlprogram.LocalVariableMap,java.util.HashMap)">computeSizeInformation</a>, <a href="Hop.html#constructAndSetLopsDataFlowProperties()">constructAndSetLopsDataFlowProperties</a>, <a href="Hop.html#createOffsetLop(org.apache.sysds.hops.Hop,boolean)">createOffsetLop</a>, <a href="Hop.html#deactivatePrefetch()">deactivatePrefetch</a>, <a href="Hop.html#dimsKnown()">dimsKnown</a>, <a href="Hop.html#dimsKnown(boolean)">dimsKnown</a>, <a href="Hop.html#dimsKnownAny()">dimsKnownAny</a>, <a href="Hop.html#federatedCostInitialized()">federatedCostInitialized</a>, <a href="Hop.html#getBeginColumn()">getBeginColumn</a>, <a href="Hop.html#getBeginLine()">getBeginLine</a>, <a href="Hop.html#getBlocksize()">getBlocksize</a>, <a href="Hop.html#getCompressedSize()">getCompressedSize</a>, <a href="Hop.html#getDataCharacteristics()">getDataCharacteristics</a>, <a href="Hop.html#getDataType()">getDataType</a>, <a href="Hop.html#getDim(int)">getDim</a>, <a href="Hop.html#getDim1()">getDim1</a>, <a href="Hop.html#getDim2()">getDim2</a>, <a href="Hop.html#getEndColumn()">getEndColumn</a>, <a href="Hop.html#getEndLine()">getEndLine</a>, <a href="Hop.html#getExecType()">getExecType</a>, <a href="Hop.html#getFederatedCost()">getFederatedCost</a>, <a href="Hop.html#getFederatedOutput()">getFederatedOutput</a>, <a href="Hop.html#getFilename()">getFilename</a>, <a href="Hop.html#getForcedExecType()">getForcedExecType</a>, <a href="Hop.html#getHopID()">getHopID</a>, <a href="Hop.html#getInput()">getInput</a>, <a href="Hop.html#getInput(int)">getInput</a>, <a href="Hop.html#getInputMemEstimate()">getInputMemEstimate</a>, <a href="Hop.html#getInputMemEstimate(double)">getInputMemEstimate</a>, <a href="Hop.html#getInputOutputSize(java.util.Collection)">getInputOutputSize</a>, <a href="Hop.html#getIntermediateMemEstimate()">getIntermediateMemEstimate</a>, <a href="Hop.html#getLength()">getLength</a>, <a href="Hop.html#getLops()">getLops</a>, <a href="Hop.html#getMemEstimate()">getMemEstimate</a>, <a href="Hop.html#getName()">getName</a>, <a href="Hop.html#getNnz()">getNnz</a>, <a href="Hop.html#getOutputMemEstimate()">getOutputMemEstimate</a>, <a href="Hop.html#getOutputMemEstimate(double)">getOutputMemEstimate</a>, <a href="Hop.html#getParent()">getParent</a>, <a href="Hop.html#getPrivacy()">getPrivacy</a>, <a href="Hop.html#getRepetitions()">getRepetitions</a>, <a href="Hop.html#getSparsity()">getSparsity</a>, <a href="Hop.html#getSpBroadcastSize()">getSpBroadcastSize</a>, <a href="Hop.html#getText()">getText</a>, <a href="Hop.html#getUpdateType()">getUpdateType</a>, <a href="Hop.html#getValueType()">getValueType</a>, <a href="Hop.html#hasCompressedInput()">hasCompressedInput</a>, <a href="Hop.html#hasFederatedOutput()">hasFederatedOutput</a>, <a href="Hop.html#hasLocalOutput()">hasLocalOutput</a>, <a href="Hop.html#hasMatrixInputWithDifferentBlocksizes()">hasMatrixInputWithDifferentBlocksizes</a>, <a href="Hop.html#hasValidCPDimsAndSize()">hasValidCPDimsAndSize</a>, <a href="Hop.html#isCompressedOutput()">isCompressedOutput</a>, <a href="Hop.html#isFederated()">isFederated</a>, <a href="Hop.html#isFederatedDataOp()">isFederatedDataOp</a>, <a href="Hop.html#isMatrix()">isMatrix</a>, <a href="Hop.html#isMemEstimated()">isMemEstimated</a>, <a href="Hop.html#isOutputEmptyBlocks()">isOutputEmptyBlocks</a>, <a href="Hop.html#isRequiredDecompression()">isRequiredDecompression</a>, <a href="Hop.html#isScalar()">isScalar</a>, <a href="Hop.html#isTransposeSafe()">isTransposeSafe</a>, <a href="Hop.html#isVisited()">isVisited</a>, <a href="Hop.html#prefetchActivated()">prefetchActivated</a>, <a href="Hop.html#printErrorLocation()">printErrorLocation</a>, <a href="Hop.html#refreshColsParameterInformation(org.apache.sysds.hops.Hop,org.apache.sysds.runtime.controlprogram.LocalVariableMap)">refreshColsParameterInformation</a>, <a href="Hop.html#refreshColsParameterInformation(org.apache.sysds.hops.Hop,org.apache.sysds.runtime.controlprogram.LocalVariableMap,java.util.HashMap)">refreshColsParameterInformation</a>, <a href="Hop.html#refreshMemEstimates(org.apache.sysds.hops.MemoTable)">refreshMemEstimates</a>, <a href="Hop.html#refreshRowsParameterInformation(org.apache.sysds.hops.Hop,org.apache.sysds.runtime.controlprogram.LocalVariableMap)">refreshRowsParameterInformation</a>, <a href="Hop.html#refreshRowsParameterInformation(org.apache.sysds.hops.Hop,org.apache.sysds.runtime.controlprogram.LocalVariableMap,java.util.HashMap)">refreshRowsParameterInformation</a>, <a href="Hop.html#requiresCheckpoint()">requiresCheckpoint</a>, <a href="Hop.html#requiresCompression()">requiresCompression</a>, <a href="Hop.html#requiresLineageCaching()">requiresLineageCaching</a>, <a href="Hop.html#requiresReblock()">requiresReblock</a>, <a href="Hop.html#requiresRecompile()">requiresRecompile</a>, <a href="Hop.html#resetExecType()">resetExecType</a>, <a href="Hop.html#resetFederatedCost()">resetFederatedCost</a>, <a href="Hop.html#resetRecompilationFlag(java.util.ArrayList,org.apache.sysds.common.Types.ExecType,org.apache.sysds.hops.recompile.Recompiler.ResetType)">resetRecompilationFlag</a>, <a href="Hop.html#resetRecompilationFlag(org.apache.sysds.hops.Hop,org.apache.sysds.common.Types.ExecType,org.apache.sysds.hops.recompile.Recompiler.ResetType)">resetRecompilationFlag</a>, <a href="Hop.html#resetVisitStatus()">resetVisitStatus</a>, <a href="Hop.html#resetVisitStatus(java.util.ArrayList)">resetVisitStatus</a>, <a href="Hop.html#resetVisitStatus(java.util.ArrayList,boolean)">resetVisitStatus</a>, <a href="Hop.html#resetVisitStatusForced(java.util.HashSet)">resetVisitStatusForced</a>, <a href="Hop.html#rowsKnown()">rowsKnown</a>, <a href="Hop.html#setBeginColumn(int)">setBeginColumn</a>, <a href="Hop.html#setBeginLine(int)">setBeginLine</a>, <a href="Hop.html#setBlocksize(int)">setBlocksize</a>, <a href="Hop.html#setCompressedOutput(boolean)">setCompressedOutput</a>, <a href="Hop.html#setCompressedSize(long)">setCompressedSize</a>, <a href="Hop.html#setDataType(org.apache.sysds.common.Types.DataType)">setDataType</a>, <a href="Hop.html#setDim(int,long)">setDim</a>, <a href="Hop.html#setDim1(long)">setDim1</a>, <a href="Hop.html#setDim2(long)">setDim2</a>, <a href="Hop.html#setEndColumn(int)">setEndColumn</a>, <a href="Hop.html#setEndLine(int)">setEndLine</a>, <a href="Hop.html#setExecType(org.apache.sysds.common.Types.ExecType)">setExecType</a>, <a href="Hop.html#setFederatedCost(org.apache.sysds.hops.cost.FederatedCost)">setFederatedCost</a>, <a href="Hop.html#setFederatedOutput(org.apache.sysds.runtime.instructions.fed.FEDInstruction.FederatedOutput)">setFederatedOutput</a>, <a href="Hop.html#setFilename(java.lang.String)">setFilename</a>, <a href="Hop.html#setForcedExecType(org.apache.sysds.common.Types.ExecType)">setForcedExecType</a>, <a href="Hop.html#setLops(org.apache.sysds.lops.Lop)">setLops</a>, <a href="Hop.html#setMemEstimate(double)">setMemEstimate</a>, <a href="Hop.html#setName(java.lang.String)">setName</a>, <a href="Hop.html#setNnz(long)">setNnz</a>, <a href="Hop.html#setOutputEmptyBlocks(boolean)">setOutputEmptyBlocks</a>, <a href="Hop.html#setParseInfo(org.apache.sysds.parser.ParseInfo)">setParseInfo</a>, <a href="Hop.html#setPrivacy(org.apache.sysds.runtime.privacy.PrivacyConstraint)">setPrivacy</a>, <a href="Hop.html#setRequiresCheckpoint(boolean)">setRequiresCheckpoint</a>, <a href="Hop.html#setRequiresCompression()">setRequiresCompression</a>, <a href="Hop.html#setRequiresCompression(org.apache.sysds.runtime.compress.workload.AWTreeNode)">setRequiresCompression</a>, <a href="Hop.html#setRequiresDeCompression()">setRequiresDeCompression</a>, <a href="Hop.html#setRequiresLineageCaching(boolean)">setRequiresLineageCaching</a>, <a href="Hop.html#setRequiresReblock(boolean)">setRequiresReblock</a>, <a href="Hop.html#setRequiresRecompile()">setRequiresRecompile</a>, <a href="Hop.html#setText(java.lang.String)">setText</a>, <a href="Hop.html#setUpdateType(org.apache.sysds.runtime.controlprogram.caching.MatrixObject.UpdateType)">setUpdateType</a>, <a href="Hop.html#setValueType(org.apache.sysds.common.Types.ValueType)">setValueType</a>, <a href="Hop.html#setVisited()">setVisited</a>, <a href="Hop.html#setVisited(boolean)">setVisited</a>, <a href="Hop.html#someInputFederated()">someInputFederated</a>, <a href="Hop.html#toString()">toString</a>, <a href="Hop.html#updateLopFedOut(org.apache.sysds.lops.Lop)">updateLopFedOut</a>, <a href="Hop.html#updateLopFedOut(org.apache.sysds.lops.Lop,org.apache.sysds.common.Types.ExecType,org.apache.sysds.runtime.instructions.fed.FEDInstruction.FederatedOutput)">updateLopFedOut</a>, <a href="Hop.html#updateRepetitionEstimates(double)">updateRepetitionEstimates</a></code></li>
</ul>
<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 role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a id="&lt;init&gt;(java.lang.String,org.apache.sysds.common.Types.DataType,org.apache.sysds.common.Types.ValueType,org.apache.sysds.common.Types.OpOp1,org.apache.sysds.hops.Hop)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>UnaryOp</h4>
<pre>public&nbsp;UnaryOp&#8203;(<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;l,
<a href="../common/Types.DataType.html" title="enum in org.apache.sysds.common">Types.DataType</a>&nbsp;dt,
<a href="../common/Types.ValueType.html" title="enum in org.apache.sysds.common">Types.ValueType</a>&nbsp;vt,
<a href="../common/Types.OpOp1.html" title="enum in org.apache.sysds.common">Types.OpOp1</a>&nbsp;o,
<a href="Hop.html" title="class in org.apache.sysds.hops">Hop</a>&nbsp;inp)</pre>
</li>
</ul>
</li>
</ul>
</section>
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="checkArity()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>checkArity</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;checkArity()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="Hop.html#checkArity()">Hop</a></code></span></div>
<div class="block">Check whether this Hop has a correct number of inputs.
(Some Hops can have a variable number of inputs, such as DataOp, DataGenOp, ParameterizedBuiltinOp,
ReorgOp, TernaryOp, QuaternaryOp, MultipleOp, DnnOp, and SpoofFusedOp.)
Parameterized Hops (such as DataOp) can check that the number of parameters matches the number of inputs.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="Hop.html#checkArity()">checkArity</a></code>&nbsp;in class&nbsp;<code><a href="Hop.html" title="class in org.apache.sysds.hops">Hop</a></code></dd>
</dl>
</li>
</ul>
<a id="getOp()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOp</h4>
<pre class="methodSignature">public&nbsp;<a href="../common/Types.OpOp1.html" title="enum in org.apache.sysds.common">Types.OpOp1</a>&nbsp;getOp()</pre>
</li>
</ul>
<a id="getOpString()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOpString</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;getOpString()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="Hop.html#getOpString()">getOpString</a></code>&nbsp;in class&nbsp;<code><a href="Hop.html" title="class in org.apache.sysds.hops">Hop</a></code></dd>
</dl>
</li>
</ul>
<a id="isGPUEnabled()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isGPUEnabled</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isGPUEnabled()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="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="Hop.html#isGPUEnabled()">isGPUEnabled</a></code>&nbsp;in class&nbsp;<code><a href="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 id="isMultiThreadedOpType()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isMultiThreadedOpType</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isMultiThreadedOpType()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="MultiThreadedHop.html#isMultiThreadedOpType()">isMultiThreadedOpType</a></code>&nbsp;in class&nbsp;<code><a href="MultiThreadedHop.html" title="class in org.apache.sysds.hops">MultiThreadedHop</a></code></dd>
</dl>
</li>
</ul>
<a id="constructLops()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>constructLops</h4>
<pre class="methodSignature">public&nbsp;<a href="../lops/Lop.html" title="class in org.apache.sysds.lops">Lop</a>&nbsp;constructLops()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="Hop.html#constructLops()">constructLops</a></code>&nbsp;in class&nbsp;<code><a href="Hop.html" title="class in org.apache.sysds.hops">Hop</a></code></dd>
</dl>
</li>
</ul>
<a id="computeMemEstimate(org.apache.sysds.hops.MemoTable)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>computeMemEstimate</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;computeMemEstimate&#8203;(<a href="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="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="Hop.html#computeMemEstimate(org.apache.sysds.hops.MemoTable)">computeMemEstimate</a></code>&nbsp;in class&nbsp;<code><a href="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 id="allowsAllExecTypes()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>allowsAllExecTypes</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;allowsAllExecTypes()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="Hop.html#allowsAllExecTypes()">allowsAllExecTypes</a></code>&nbsp;in class&nbsp;<code><a href="Hop.html" title="class in org.apache.sysds.hops">Hop</a></code></dd>
</dl>
</li>
</ul>
<a id="isCumulativeUnaryOperation()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isCumulativeUnaryOperation</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isCumulativeUnaryOperation()</pre>
</li>
</ul>
<a id="isCastUnaryOperation()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isCastUnaryOperation</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isCastUnaryOperation()</pre>
</li>
</ul>
<a id="isExpensiveUnaryOperation()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isExpensiveUnaryOperation</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isExpensiveUnaryOperation()</pre>
</li>
</ul>
<a id="isMetadataOperation()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isMetadataOperation</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isMetadataOperation()</pre>
</li>
</ul>
<a id="refreshSizeInformation()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>refreshSizeInformation</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;refreshSizeInformation()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="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="Hop.html#refreshSizeInformation()">refreshSizeInformation</a></code>&nbsp;in class&nbsp;<code><a href="Hop.html" title="class in org.apache.sysds.hops">Hop</a></code></dd>
</dl>
</li>
</ul>
<a id="clone()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clone</h4>
<pre class="methodSignature">public&nbsp;<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>&nbsp;clone()
throws <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/CloneNotSupportedException.html?is-external=true" title="class or interface in java.lang" class="externalLink">CloneNotSupportedException</a></pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="Hop.html#clone()">clone</a></code>&nbsp;in class&nbsp;<code><a href="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/en/java/javase/11/docs/api/java.base/java/lang/CloneNotSupportedException.html?is-external=true" title="class or interface in java.lang" class="externalLink">CloneNotSupportedException</a></code></dd>
</dl>
</li>
</ul>
<a id="compare(org.apache.sysds.hops.Hop)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>compare</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;compare&#8203;(<a href="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="Hop.html#compare(org.apache.sysds.hops.Hop)">compare</a></code>&nbsp;in class&nbsp;<code><a href="Hop.html" title="class in org.apache.sysds.hops">Hop</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/UnaryOp.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><a href="#field.summary">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 id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Copyright &#169; 2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</body>
</html>