| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>NaryOp (Apache SystemDS 3.3.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.1.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="NaryOp (Apache SystemDS 3.3.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}; |
| 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/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" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses.html">All 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: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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"> </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> <a href="package-summary.html">org.apache.sysds.hops</a></div> |
| <h2 title="Class NaryOp" class="title">Class NaryOp</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>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><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">NaryOp</span> |
| extends <a href="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 =========== --> |
| <section> |
| <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 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> |
| <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"> </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.OpOpN,org.apache.sysds.hops.Hop...)">NaryOp</a></span>​(<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> name, |
| <a href="../common/Types.DataType.html" title="enum in org.apache.sysds.common">Types.DataType</a> dataType, |
| <a href="../common/Types.ValueType.html" title="enum in org.apache.sysds.common">Types.ValueType</a> valueType, |
| <a href="../common/Types.OpOpN.html" title="enum in org.apache.sysds.common">Types.OpOpN</a> op, |
| <a href="Hop.html" title="class in org.apache.sysds.hops">Hop</a>... inputs)</code></th> |
| <td class="colLast"> |
| <div class="block">NaryOp constructor.</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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </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"> </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">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/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"> </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>​(<a href="Hop.html" title="class in org.apache.sysds.hops">Hop</a> that)</code></th> |
| <td class="colLast"> </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>​(<a href="MemoTable.html" title="class in org.apache.sysds.hops">MemoTable</a> 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"> |
| <div class="block">Construct the corresponding Lops for this Hop</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="../common/Types.OpOpN.html" title="enum in org.apache.sysds.common">Types.OpOpN</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getOp()">getOp</a></span>()</code></th> |
| <td class="colLast"> </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"> </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="#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="i9" class="rowColor"> |
| <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.Hop"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class 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.List)">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.Map)">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.Map)">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#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#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#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.Map)">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.Map)">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#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.List)">resetVisitStatus</a>, <a href="Hop.html#resetVisitStatus(java.util.List,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#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#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></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class 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="<init>(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 NaryOp​(<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> name, |
| <a href="../common/Types.DataType.html" title="enum in org.apache.sysds.common">Types.DataType</a> dataType, |
| <a href="../common/Types.ValueType.html" title="enum in org.apache.sysds.common">Types.ValueType</a> valueType, |
| <a href="../common/Types.OpOpN.html" title="enum in org.apache.sysds.common">Types.OpOpN</a> op, |
| <a href="Hop.html" title="class in org.apache.sysds.hops">Hop</a>... 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> |
| </section> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section> |
| <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 void 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="Hop.html#checkArity()">checkArity</a></code> in class <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 <a href="../common/Types.OpOpN.html" title="enum in org.apache.sysds.common">Types.OpOpN</a> getOp()</pre> |
| </li> |
| </ul> |
| <a id="getOpString()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getOpString</h4> |
| <pre class="methodSignature">public <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> getOpString()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="Hop.html#getOpString()">getOpString</a></code> in class <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 boolean isGPUEnabled()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <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> in class <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="constructLops()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>constructLops</h4> |
| <pre class="methodSignature">public <a href="../lops/Lop.html" title="class in org.apache.sysds.lops">Lop</a> 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="Hop.html#constructLops()">constructLops</a></code> in class <code><a href="Hop.html" title="class in org.apache.sysds.hops">Hop</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="allowsAllExecTypes()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>allowsAllExecTypes</h4> |
| <pre class="methodSignature">public boolean allowsAllExecTypes()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="Hop.html#allowsAllExecTypes()">allowsAllExecTypes</a></code> in class <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 void computeMemEstimate​(<a href="MemoTable.html" title="class in org.apache.sysds.hops">MemoTable</a> memo)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <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> in class <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="refreshSizeInformation()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>refreshSizeInformation</h4> |
| <pre class="methodSignature">public void refreshSizeInformation()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <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> in class <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 <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> 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> in class <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 boolean compare​(<a href="Hop.html" title="class in org.apache.sysds.hops">Hop</a> 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> in class <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/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" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses.html">All 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: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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 © 2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </body> |
| </html> |
