blob: 0c48aca91ff2ddc3736c075bc7701951ba10b0be [file]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>PartialAggregate (Apache SystemDS 3.2.0-SNAPSHOT API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
<script type="text/javascript" src="../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../jquery/jquery-3.6.0.min.js"></script>
<script type="text/javascript" src="../../../../jquery/jquery-ui.min.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="PartialAggregate (Apache SystemDS 3.2.0-SNAPSHOT API)";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":10,"i2":9,"i3":10,"i4":9,"i5":10,"i6":9,"i7":10};
var tabs = {65535:["t0","All Methods"],1:["t1","Static 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/PartialAggregate.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><a href="#nested.class.summary">Nested</a>&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.lops</a></div>
<h2 title="Class PartialAggregate" class="title">Class PartialAggregate</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="Lop.html" title="class in org.apache.sysds.lops">org.apache.sysds.lops.Lop</a></li>
<li>
<ul class="inheritance">
<li>org.apache.sysds.lops.PartialAggregate</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<pre>public class <span class="typeNameLabel">PartialAggregate</span>
extends <a href="Lop.html" title="class in org.apache.sysds.lops">Lop</a></pre>
<div class="block">Lop to perform a partial aggregation. It was introduced to do some initial
aggregation operations on blocks in the mapper/reducer.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<ul class="blockList">
<li class="blockList"><a id="nested.classes.inherited.from.class.org.apache.sysds.lops.Lop">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from class&nbsp;org.apache.sysds.lops.<a href="Lop.html" title="class in org.apache.sysds.lops">Lop</a></h3>
<code><a href="Lop.SimpleInstType.html" title="enum in org.apache.sysds.lops">Lop.SimpleInstType</a>, <a href="Lop.Type.html" title="enum in org.apache.sysds.lops">Lop.Type</a>, <a href="Lop.VisitStatus.html" title="enum in org.apache.sysds.lops">Lop.VisitStatus</a></code></li>
</ul>
</li>
</ul>
</section>
<!-- =========== 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.lops.Lop">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.apache.sysds.lops.<a href="Lop.html" title="class in org.apache.sysds.lops">Lop</a></h3>
<code><a href="Lop.html#_beginColumn">_beginColumn</a>, <a href="Lop.html#_beginLine">_beginLine</a>, <a href="Lop.html#_endColumn">_endColumn</a>, <a href="Lop.html#_endLine">_endLine</a>, <a href="Lop.html#_filename">_filename</a>, <a href="Lop.html#CP_CHILD_THREAD">CP_CHILD_THREAD</a>, <a href="Lop.html#CP_ROOT_THREAD_ID">CP_ROOT_THREAD_ID</a>, <a href="Lop.html#DATATYPE_PREFIX">DATATYPE_PREFIX</a>, <a href="Lop.html#FILE_SEPARATOR">FILE_SEPARATOR</a>, <a href="Lop.html#FRAME_VAR_NAME_PREFIX">FRAME_VAR_NAME_PREFIX</a>, <a href="Lop.html#INSTRUCTION_DELIMITOR">INSTRUCTION_DELIMITOR</a>, <a href="Lop.html#LITERAL_PREFIX">LITERAL_PREFIX</a>, <a href="Lop.html#MATRIX_VAR_NAME_PREFIX">MATRIX_VAR_NAME_PREFIX</a>, <a href="Lop.html#NAME_VALUE_SEPARATOR">NAME_VALUE_SEPARATOR</a>, <a href="Lop.html#OPERAND_DELIMITOR">OPERAND_DELIMITOR</a>, <a href="Lop.html#PROCESS_PREFIX">PROCESS_PREFIX</a>, <a href="Lop.html#SCALAR_VAR_NAME_PREFIX">SCALAR_VAR_NAME_PREFIX</a>, <a href="Lop.html#UPDATE_INPLACE_PREFIX">UPDATE_INPLACE_PREFIX</a>, <a href="Lop.html#VALUETYPE_PREFIX">VALUETYPE_PREFIX</a>, <a href="Lop.html#VARIABLE_NAME_PLACEHOLDER">VARIABLE_NAME_PLACEHOLDER</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">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.apache.sysds.lops.Lop,org.apache.sysds.common.Types.AggOp,org.apache.sysds.common.Types.Direction,org.apache.sysds.common.Types.DataType,org.apache.sysds.common.Types.ValueType,org.apache.sysds.common.Types.ExecType,int)">PartialAggregate</a></span>&#8203;(<a href="Lop.html" title="class in org.apache.sysds.lops">Lop</a>&nbsp;input,
<a href="../common/Types.AggOp.html" title="enum in org.apache.sysds.common">Types.AggOp</a>&nbsp;op,
<a href="../common/Types.Direction.html" title="enum in org.apache.sysds.common">Types.Direction</a>&nbsp;direct,
<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.ExecType.html" title="enum in org.apache.sysds.common">Types.ExecType</a>&nbsp;et,
int&nbsp;k)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.apache.sysds.lops.Lop,org.apache.sysds.common.Types.AggOp,org.apache.sysds.common.Types.Direction,org.apache.sysds.common.Types.DataType,org.apache.sysds.common.Types.ValueType,org.apache.sysds.hops.AggBinaryOp.SparkAggType,org.apache.sysds.common.Types.ExecType)">PartialAggregate</a></span>&#8203;(<a href="Lop.html" title="class in org.apache.sysds.lops">Lop</a>&nbsp;input,
<a href="../common/Types.AggOp.html" title="enum in org.apache.sysds.common">Types.AggOp</a>&nbsp;op,
<a href="../common/Types.Direction.html" title="enum in org.apache.sysds.common">Types.Direction</a>&nbsp;direct,
<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="../hops/AggBinaryOp.SparkAggType.html" title="enum in org.apache.sysds.hops">AggBinaryOp.SparkAggType</a>&nbsp;aggtype,
<a href="../common/Types.ExecType.html" title="enum in org.apache.sysds.common">Types.ExecType</a>&nbsp;et)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ========== METHOD SUMMARY =========== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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><a href="../hops/AggBinaryOp.SparkAggType.html" title="enum in org.apache.sysds.hops">AggBinaryOp.SparkAggType</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAggType()">getAggType</a></span>()</code></th>
<td class="colLast">
<div class="block">Method to get aggregate type if applicable.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../common/Types.CorrectionLocationType.html" title="enum in org.apache.sysds.common">Types.CorrectionLocationType</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCorrectionLocation()">getCorrectionLocation</a></span>()</code></th>
<td class="colLast">
<div class="block">This method computes the location of "correction" terms in the output
produced by PartialAgg instruction.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>static <a href="../common/Types.CorrectionLocationType.html" title="enum in org.apache.sysds.common">Types.CorrectionLocationType</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCorrectionLocation(org.apache.sysds.common.Types.AggOp,org.apache.sysds.common.Types.Direction)">getCorrectionLocation</a></span>&#8203;(<a href="../common/Types.AggOp.html" title="enum in org.apache.sysds.common">Types.AggOp</a>&nbsp;operation,
<a href="../common/Types.Direction.html" title="enum in org.apache.sysds.common">Types.Direction</a>&nbsp;direction)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i3" 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="#getInstructions(java.lang.String,java.lang.String)">getInstructions</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;input1,
<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;output)</code></th>
<td class="colLast">
<div class="block">Instruction generation for CP and Spark</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>static <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="#getOpcode(org.apache.sysds.common.Types.AggOp,org.apache.sysds.common.Types.Direction)">getOpcode</a></span>&#8203;(<a href="../common/Types.AggOp.html" title="enum in org.apache.sysds.common">Types.AggOp</a>&nbsp;op,
<a href="../common/Types.Direction.html" title="enum in org.apache.sysds.common">Types.Direction</a>&nbsp;dir)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setDimensionsBasedOnDirection(long,long,long)">setDimensionsBasedOnDirection</a></span>&#8203;(long&nbsp;dim1,
long&nbsp;dim2,
long&nbsp;blen)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>static void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setDimensionsBasedOnDirection(org.apache.sysds.lops.Lop,long,long,long,org.apache.sysds.common.Types.Direction)">setDimensionsBasedOnDirection</a></span>&#8203;(<a href="Lop.html" title="class in org.apache.sysds.lops">Lop</a>&nbsp;lop,
long&nbsp;dim1,
long&nbsp;dim2,
long&nbsp;blen,
<a href="../common/Types.Direction.html" title="enum in org.apache.sysds.common">Types.Direction</a>&nbsp;dir)</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="#toString()">toString</a></span>()</code></th>
<td class="colLast">
<div class="block">Method to have Lops print their state.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.apache.sysds.lops.Lop">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.sysds.lops.<a href="Lop.html" title="class in org.apache.sysds.lops">Lop</a></h3>
<code><a href="Lop.html#activatePrefetch()">activatePrefetch</a>, <a href="Lop.html#addInput(org.apache.sysds.lops.Lop)">addInput</a>, <a href="Lop.html#addOutput(org.apache.sysds.lops.Lop)">addOutput</a>, <a href="Lop.html#addToDag(org.apache.sysds.lops.compile.Dag)">addToDag</a>, <a href="Lop.html#createReachable(int)">createReachable</a>, <a href="Lop.html#getBeginColumn()">getBeginColumn</a>, <a href="Lop.html#getBeginLine()">getBeginLine</a>, <a href="Lop.html#getBroadcastInput()">getBroadcastInput</a>, <a href="Lop.html#getDataType()">getDataType</a>, <a href="Lop.html#getEndColumn()">getEndColumn</a>, <a href="Lop.html#getEndLine()">getEndLine</a>, <a href="Lop.html#getExecType()">getExecType</a>, <a href="Lop.html#getFederatedOutput()">getFederatedOutput</a>, <a href="Lop.html#getFilename()">getFilename</a>, <a href="Lop.html#getID()">getID</a>, <a href="Lop.html#getInputs()">getInputs</a>, <a href="Lop.html#getInstructions()">getInstructions</a>, <a href="Lop.html#getInstructions(int,int,int,int,int,int,int,int)">getInstructions</a>, <a href="Lop.html#getInstructions(java.lang.String)">getInstructions</a>, <a href="Lop.html#getInstructions(java.lang.String%5B%5D,java.lang.String)">getInstructions</a>, <a href="Lop.html#getInstructions(java.lang.String%5B%5D,java.lang.String%5B%5D)">getInstructions</a>, <a href="Lop.html#getInstructions(java.lang.String,java.lang.String,java.lang.String)">getInstructions</a>, <a href="Lop.html#getInstructions(java.lang.String,java.lang.String,java.lang.String,java.lang.String)">getInstructions</a>, <a href="Lop.html#getInstructions(java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String)">getInstructions</a>, <a href="Lop.html#getInstructions(java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String)">getInstructions</a>, <a href="Lop.html#getInstructions(java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String)">getInstructions</a>, <a href="Lop.html#getInstructions(java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String)">getInstructions</a>, <a href="Lop.html#getLevel()">getLevel</a>, <a href="Lop.html#getOutputParameters()">getOutputParameters</a>, <a href="Lop.html#getOutputs()">getOutputs</a>, <a href="Lop.html#getPrivacyConstraint()">getPrivacyConstraint</a>, <a href="Lop.html#getProducesIntermediateOutput()">getProducesIntermediateOutput</a>, <a href="Lop.html#getReachable()">getReachable</a>, <a href="Lop.html#getSimpleInstructionType()">getSimpleInstructionType</a>, <a href="Lop.html#getType()">getType</a>, <a href="Lop.html#getValueType()">getValueType</a>, <a href="Lop.html#getVisited()">getVisited</a>, <a href="Lop.html#isAllOutputsCP()">isAllOutputsCP</a>, <a href="Lop.html#isAsynchronousOp()">isAsynchronousOp</a>, <a href="Lop.html#isDataExecLocation()">isDataExecLocation</a>, <a href="Lop.html#isExecSpark()">isExecSpark</a>, <a href="Lop.html#isVariable()">isVariable</a>, <a href="Lop.html#isVisited()">isVisited</a>, <a href="Lop.html#prefetchActivated()">prefetchActivated</a>, <a href="Lop.html#prepInputOperand(int)">prepInputOperand</a>, <a href="Lop.html#prepInputOperand(java.lang.String)">prepInputOperand</a>, <a href="Lop.html#prepOperand(java.lang.String,org.apache.sysds.common.Types.DataType,org.apache.sysds.common.Types.ValueType)">prepOperand</a>, <a href="Lop.html#prepOperand(java.lang.String,org.apache.sysds.common.Types.DataType,org.apache.sysds.common.Types.ValueType,boolean)">prepOperand</a>, <a href="Lop.html#prepOutputOperand()">prepOutputOperand</a>, <a href="Lop.html#prepOutputOperand(int)">prepOutputOperand</a>, <a href="Lop.html#prepOutputOperand(java.lang.String)">prepOutputOperand</a>, <a href="Lop.html#prepScalarInputOperand(java.lang.String)">prepScalarInputOperand</a>, <a href="Lop.html#prepScalarInputOperand(org.apache.sysds.common.Types.ExecType)">prepScalarInputOperand</a>, <a href="Lop.html#prepScalarLabel()">prepScalarLabel</a>, <a href="Lop.html#prepScalarOperand(org.apache.sysds.common.Types.ExecType,java.lang.String)">prepScalarOperand</a>, <a href="Lop.html#printErrorLocation()">printErrorLocation</a>, <a href="Lop.html#removeConsumer()">removeConsumer</a>, <a href="Lop.html#removeInput(org.apache.sysds.lops.Lop)">removeInput</a>, <a href="Lop.html#removeOutput(org.apache.sysds.lops.Lop)">removeOutput</a>, <a href="Lop.html#replaceInput(org.apache.sysds.lops.Lop,org.apache.sysds.lops.Lop)">replaceInput</a>, <a href="Lop.html#resetVisitStatus()">resetVisitStatus</a>, <a href="Lop.html#setAllPositions(java.lang.String,int,int,int,int)">setAllPositions</a>, <a href="Lop.html#setAsynchronous(boolean)">setAsynchronous</a>, <a href="Lop.html#setBeginColumn(int)">setBeginColumn</a>, <a href="Lop.html#setBeginLine(int)">setBeginLine</a>, <a href="Lop.html#setConsumerCount(int)">setConsumerCount</a>, <a href="Lop.html#setDataType(org.apache.sysds.common.Types.DataType)">setDataType</a>, <a href="Lop.html#setEndColumn(int)">setEndColumn</a>, <a href="Lop.html#setEndLine(int)">setEndLine</a>, <a href="Lop.html#setExecType(org.apache.sysds.common.Types.ExecType)">setExecType</a>, <a href="Lop.html#setFederatedOutput(org.apache.sysds.runtime.instructions.fed.FEDInstruction.FederatedOutput)">setFederatedOutput</a>, <a href="Lop.html#setFilename(java.lang.String)">setFilename</a>, <a href="Lop.html#setNewID()">setNewID</a>, <a href="Lop.html#setPrivacyConstraint(org.apache.sysds.runtime.privacy.PrivacyConstraint)">setPrivacyConstraint</a>, <a href="Lop.html#setValueType(org.apache.sysds.common.Types.ValueType)">setValueType</a>, <a href="Lop.html#setVisited()">setVisited</a>, <a href="Lop.html#setVisited(org.apache.sysds.lops.Lop.VisitStatus)">setVisited</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>
<ul class="blockList">
<li class="blockList"><a id="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a id="&lt;init&gt;(org.apache.sysds.lops.Lop,org.apache.sysds.common.Types.AggOp,org.apache.sysds.common.Types.Direction,org.apache.sysds.common.Types.DataType,org.apache.sysds.common.Types.ValueType,org.apache.sysds.common.Types.ExecType,int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>PartialAggregate</h4>
<pre>public&nbsp;PartialAggregate&#8203;(<a href="Lop.html" title="class in org.apache.sysds.lops">Lop</a>&nbsp;input,
<a href="../common/Types.AggOp.html" title="enum in org.apache.sysds.common">Types.AggOp</a>&nbsp;op,
<a href="../common/Types.Direction.html" title="enum in org.apache.sysds.common">Types.Direction</a>&nbsp;direct,
<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.ExecType.html" title="enum in org.apache.sysds.common">Types.ExecType</a>&nbsp;et,
int&nbsp;k)</pre>
</li>
</ul>
<a id="&lt;init&gt;(org.apache.sysds.lops.Lop,org.apache.sysds.common.Types.AggOp,org.apache.sysds.common.Types.Direction,org.apache.sysds.common.Types.DataType,org.apache.sysds.common.Types.ValueType,org.apache.sysds.hops.AggBinaryOp.SparkAggType,org.apache.sysds.common.Types.ExecType)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>PartialAggregate</h4>
<pre>public&nbsp;PartialAggregate&#8203;(<a href="Lop.html" title="class in org.apache.sysds.lops">Lop</a>&nbsp;input,
<a href="../common/Types.AggOp.html" title="enum in org.apache.sysds.common">Types.AggOp</a>&nbsp;op,
<a href="../common/Types.Direction.html" title="enum in org.apache.sysds.common">Types.Direction</a>&nbsp;direct,
<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="../hops/AggBinaryOp.SparkAggType.html" title="enum in org.apache.sysds.hops">AggBinaryOp.SparkAggType</a>&nbsp;aggtype,
<a href="../common/Types.ExecType.html" title="enum in org.apache.sysds.common">Types.ExecType</a>&nbsp;et)</pre>
</li>
</ul>
</li>
</ul>
</section>
<!-- ============ METHOD DETAIL ========== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="getCorrectionLocation()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCorrectionLocation</h4>
<pre class="methodSignature">public&nbsp;<a href="../common/Types.CorrectionLocationType.html" title="enum in org.apache.sysds.common">Types.CorrectionLocationType</a>&nbsp;getCorrectionLocation()</pre>
<div class="block">This method computes the location of "correction" terms in the output
produced by PartialAgg instruction.
When computing the stable sum, "correction" refers to the compensation as
defined by the original Kahan algorithm. When computing the stable mean,
"correction" refers to two extra values (the running mean, count)
produced by each Mapper i.e., by each PartialAgg instruction.
This method is invoked during hop-to-lop translation, while creating the
corresponding Aggregate lop
Computed information is encoded in the PartialAgg instruction so that the
appropriate aggregate operator is used at runtime (see:
dml.runtime.matrix.operator.AggregateOperator.java and dml.runtime.matrix)</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>correct location</dd>
</dl>
</li>
</ul>
<a id="getCorrectionLocation(org.apache.sysds.common.Types.AggOp,org.apache.sysds.common.Types.Direction)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCorrectionLocation</h4>
<pre class="methodSignature">public static&nbsp;<a href="../common/Types.CorrectionLocationType.html" title="enum in org.apache.sysds.common">Types.CorrectionLocationType</a>&nbsp;getCorrectionLocation&#8203;(<a href="../common/Types.AggOp.html" title="enum in org.apache.sysds.common">Types.AggOp</a>&nbsp;operation,
<a href="../common/Types.Direction.html" title="enum in org.apache.sysds.common">Types.Direction</a>&nbsp;direction)</pre>
</li>
</ul>
<a id="getAggType()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAggType</h4>
<pre class="methodSignature">public&nbsp;<a href="../hops/AggBinaryOp.SparkAggType.html" title="enum in org.apache.sysds.hops">AggBinaryOp.SparkAggType</a>&nbsp;getAggType()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="Lop.html#getAggType()">Lop</a></code></span></div>
<div class="block">Method to get aggregate type if applicable.
This method is overridden by the Lops with aggregate types (e.g. MapMult)</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="Lop.html#getAggType()">getAggType</a></code>&nbsp;in class&nbsp;<code><a href="Lop.html" title="class in org.apache.sysds.lops">Lop</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>SparkAggType</dd>
</dl>
</li>
</ul>
<a id="setDimensionsBasedOnDirection(long,long,long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setDimensionsBasedOnDirection</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setDimensionsBasedOnDirection&#8203;(long&nbsp;dim1,
long&nbsp;dim2,
long&nbsp;blen)</pre>
</li>
</ul>
<a id="setDimensionsBasedOnDirection(org.apache.sysds.lops.Lop,long,long,long,org.apache.sysds.common.Types.Direction)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setDimensionsBasedOnDirection</h4>
<pre class="methodSignature">public static&nbsp;void&nbsp;setDimensionsBasedOnDirection&#8203;(<a href="Lop.html" title="class in org.apache.sysds.lops">Lop</a>&nbsp;lop,
long&nbsp;dim1,
long&nbsp;dim2,
long&nbsp;blen,
<a href="../common/Types.Direction.html" title="enum in org.apache.sysds.common">Types.Direction</a>&nbsp;dir)</pre>
</li>
</ul>
<a id="toString()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toString</h4>
<pre class="methodSignature">public&nbsp;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;toString()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="Lop.html#toString()">Lop</a></code></span></div>
<div class="block">Method to have Lops print their state. This is for debugging purposes.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="Lop.html#toString()">toString</a></code>&nbsp;in class&nbsp;<code><a href="Lop.html" title="class in org.apache.sysds.lops">Lop</a></code></dd>
</dl>
</li>
</ul>
<a id="getInstructions(java.lang.String,java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getInstructions</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;getInstructions&#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;input1,
<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;output)</pre>
<div class="block">Instruction generation for CP and Spark</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="Lop.html#getInstructions(java.lang.String,java.lang.String)">getInstructions</a></code>&nbsp;in class&nbsp;<code><a href="Lop.html" title="class in org.apache.sysds.lops">Lop</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>input1</code> - input 1</dd>
<dd><code>output</code> - output</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>instructions as string</dd>
</dl>
</li>
</ul>
<a id="getOpcode(org.apache.sysds.common.Types.AggOp,org.apache.sysds.common.Types.Direction)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getOpcode</h4>
<pre class="methodSignature">public static&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;getOpcode&#8203;(<a href="../common/Types.AggOp.html" title="enum in org.apache.sysds.common">Types.AggOp</a>&nbsp;op,
<a href="../common/Types.Direction.html" title="enum in org.apache.sysds.common">Types.Direction</a>&nbsp;dir)</pre>
</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/PartialAggregate.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><a href="#nested.class.summary">Nested</a>&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; 2023 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</body>
</html>