blob: 8103d065af9b5205ecb65b65366aa6e1af212ea6 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>org.apache.sysds.runtime.functionobjects (SystemDS 2.1.0-SNAPSHOT API)</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="org.apache.sysds.runtime.functionobjects (SystemDS 2.1.0-SNAPSHOT API)";
}
}
catch(err) {
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/sysds/runtime/data/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../org/apache/sysds/runtime/instructions/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/sysds/runtime/functionobjects/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h1 title="Package" class="title">Package&nbsp;org.apache.sysds.runtime.functionobjects</h1>
</div>
<div class="contentContainer">
<ul class="blockList">
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation">
<caption><span>Interface Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Interface</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/sysds/runtime/functionobjects/TernaryValueFunction.ValueFunctionWithConstant.html" title="interface in org.apache.sysds.runtime.functionobjects">TernaryValueFunction.ValueFunctionWithConstant</a></td>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation">
<caption><span>Class Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/sysds/runtime/functionobjects/And.html" title="class in org.apache.sysds.runtime.functionobjects">And</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/sysds/runtime/functionobjects/BitwAnd.html" title="class in org.apache.sysds.runtime.functionobjects">BitwAnd</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/sysds/runtime/functionobjects/BitwOr.html" title="class in org.apache.sysds.runtime.functionobjects">BitwOr</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/sysds/runtime/functionobjects/BitwShiftL.html" title="class in org.apache.sysds.runtime.functionobjects">BitwShiftL</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/sysds/runtime/functionobjects/BitwShiftR.html" title="class in org.apache.sysds.runtime.functionobjects">BitwShiftR</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/sysds/runtime/functionobjects/BitwXor.html" title="class in org.apache.sysds.runtime.functionobjects">BitwXor</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/sysds/runtime/functionobjects/Builtin.html" title="class in org.apache.sysds.runtime.functionobjects">Builtin</a></td>
<td class="colLast">
<div class="block">Class with pre-defined set of objects.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/sysds/runtime/functionobjects/CM.html" title="class in org.apache.sysds.runtime.functionobjects">CM</a></td>
<td class="colLast">
<div class="block">GENERAL NOTE:
* 05/28/2014: We decided to do handle weights consistently to SPSS in an operation-specific manner,
i.e., we (1) round instead of casting where required (e.g.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/sysds/runtime/functionobjects/COV.html" title="class in org.apache.sysds.runtime.functionobjects">COV</a></td>
<td class="colLast">
<div class="block">GENERAL NOTE:
* 05/28/2014: We decided to do handle weights consistently to SPSS in an operation-specific manner,
i.e., we (1) round instead of casting where required (e.g.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/sysds/runtime/functionobjects/CTable.html" title="class in org.apache.sysds.runtime.functionobjects">CTable</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/sysds/runtime/functionobjects/DiagIndex.html" title="class in org.apache.sysds.runtime.functionobjects">DiagIndex</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/sysds/runtime/functionobjects/Divide.html" title="class in org.apache.sysds.runtime.functionobjects">Divide</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/sysds/runtime/functionobjects/Equals.html" title="class in org.apache.sysds.runtime.functionobjects">Equals</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/sysds/runtime/functionobjects/FileFunction.html" title="class in org.apache.sysds.runtime.functionobjects">FileFunction</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/sysds/runtime/functionobjects/FunctionObject.html" title="class in org.apache.sysds.runtime.functionobjects">FunctionObject</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/sysds/runtime/functionobjects/GreaterThan.html" title="class in org.apache.sysds.runtime.functionobjects">GreaterThan</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/sysds/runtime/functionobjects/GreaterThanEquals.html" title="class in org.apache.sysds.runtime.functionobjects">GreaterThanEquals</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/sysds/runtime/functionobjects/IfElse.html" title="class in org.apache.sysds.runtime.functionobjects">IfElse</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/sysds/runtime/functionobjects/IndexFunction.html" title="class in org.apache.sysds.runtime.functionobjects">IndexFunction</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/sysds/runtime/functionobjects/IntegerDivide.html" title="class in org.apache.sysds.runtime.functionobjects">IntegerDivide</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/sysds/runtime/functionobjects/KahanFunction.html" title="class in org.apache.sysds.runtime.functionobjects">KahanFunction</a></td>
<td class="colLast">
<div class="block">Runtime function type to perform the summation of values using
the Kahan summation algorithm.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/sysds/runtime/functionobjects/KahanPlus.html" title="class in org.apache.sysds.runtime.functionobjects">KahanPlus</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/sysds/runtime/functionobjects/KahanPlusSq.html" title="class in org.apache.sysds.runtime.functionobjects">KahanPlusSq</a></td>
<td class="colLast">
<div class="block">Runtime function to perform the summation of squared values using
the Kahan summation algorithm.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/sysds/runtime/functionobjects/LessThan.html" title="class in org.apache.sysds.runtime.functionobjects">LessThan</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/sysds/runtime/functionobjects/LessThanEquals.html" title="class in org.apache.sysds.runtime.functionobjects">LessThanEquals</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/sysds/runtime/functionobjects/Mean.html" title="class in org.apache.sysds.runtime.functionobjects">Mean</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/sysds/runtime/functionobjects/Minus.html" title="class in org.apache.sysds.runtime.functionobjects">Minus</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/sysds/runtime/functionobjects/Minus1Multiply.html" title="class in org.apache.sysds.runtime.functionobjects">Minus1Multiply</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/sysds/runtime/functionobjects/MinusMultiply.html" title="class in org.apache.sysds.runtime.functionobjects">MinusMultiply</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/sysds/runtime/functionobjects/MinusNz.html" title="class in org.apache.sysds.runtime.functionobjects">MinusNz</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/sysds/runtime/functionobjects/Modulus.html" title="class in org.apache.sysds.runtime.functionobjects">Modulus</a></td>
<td class="colLast">
<div class="block">Integer modulus, where we adhere to the defined R semantics:
("%% indicates x mod y and %/% indicates integer division.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/sysds/runtime/functionobjects/Multiply.html" title="class in org.apache.sysds.runtime.functionobjects">Multiply</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/sysds/runtime/functionobjects/Multiply2.html" title="class in org.apache.sysds.runtime.functionobjects">Multiply2</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/sysds/runtime/functionobjects/Not.html" title="class in org.apache.sysds.runtime.functionobjects">Not</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/sysds/runtime/functionobjects/NotEquals.html" title="class in org.apache.sysds.runtime.functionobjects">NotEquals</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/sysds/runtime/functionobjects/OffsetColumnIndex.html" title="class in org.apache.sysds.runtime.functionobjects">OffsetColumnIndex</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/sysds/runtime/functionobjects/Or.html" title="class in org.apache.sysds.runtime.functionobjects">Or</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/sysds/runtime/functionobjects/ParameterizedBuiltin.html" title="class in org.apache.sysds.runtime.functionobjects">ParameterizedBuiltin</a></td>
<td class="colLast">
<div class="block">Function object for builtin function that takes a list of name=value parameters.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/sysds/runtime/functionobjects/Plus.html" title="class in org.apache.sysds.runtime.functionobjects">Plus</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/sysds/runtime/functionobjects/PlusMultiply.html" title="class in org.apache.sysds.runtime.functionobjects">PlusMultiply</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/sysds/runtime/functionobjects/Power.html" title="class in org.apache.sysds.runtime.functionobjects">Power</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/sysds/runtime/functionobjects/Power2.html" title="class in org.apache.sysds.runtime.functionobjects">Power2</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/sysds/runtime/functionobjects/ReduceAll.html" title="class in org.apache.sysds.runtime.functionobjects">ReduceAll</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/sysds/runtime/functionobjects/ReduceCol.html" title="class in org.apache.sysds.runtime.functionobjects">ReduceCol</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/sysds/runtime/functionobjects/ReduceDiag.html" title="class in org.apache.sysds.runtime.functionobjects">ReduceDiag</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/sysds/runtime/functionobjects/ReduceRow.html" title="class in org.apache.sysds.runtime.functionobjects">ReduceRow</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/sysds/runtime/functionobjects/RevIndex.html" title="class in org.apache.sysds.runtime.functionobjects">RevIndex</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/sysds/runtime/functionobjects/SortIndex.html" title="class in org.apache.sysds.runtime.functionobjects">SortIndex</a></td>
<td class="colLast">
<div class="block">This index function is NOT used for actual sorting but just as a reference
in ReorgOperator in order to identify sort operations.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/sysds/runtime/functionobjects/SwapIndex.html" title="class in org.apache.sysds.runtime.functionobjects">SwapIndex</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/sysds/runtime/functionobjects/TernaryValueFunction.html" title="class in org.apache.sysds.runtime.functionobjects">TernaryValueFunction</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/sysds/runtime/functionobjects/ValueComparisonFunction.html" title="class in org.apache.sysds.runtime.functionobjects">ValueComparisonFunction</a></td>
<td class="colLast">
<div class="block">Abstraction for comparison (relational) operators in order to
force a proper implementation by all relevant subclasses.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/sysds/runtime/functionobjects/ValueFunction.html" title="class in org.apache.sysds.runtime.functionobjects">ValueFunction</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/sysds/runtime/functionobjects/Xor.html" title="class in org.apache.sysds.runtime.functionobjects">Xor</a></td>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Summary table, listing enums, and an explanation">
<caption><span>Enum Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Enum</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/sysds/runtime/functionobjects/Builtin.BuiltinCode.html" title="enum in org.apache.sysds.runtime.functionobjects">Builtin.BuiltinCode</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/sysds/runtime/functionobjects/ParameterizedBuiltin.ParameterizedBuiltinCode.html" title="enum in org.apache.sysds.runtime.functionobjects">ParameterizedBuiltin.ParameterizedBuiltinCode</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/sysds/runtime/functionobjects/ParameterizedBuiltin.ProbabilityDistributionCode.html" title="enum in org.apache.sysds.runtime.functionobjects">ParameterizedBuiltin.ProbabilityDistributionCode</a></td>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
</table>
</li>
</ul>
</div>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/sysds/runtime/data/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../org/apache/sysds/runtime/instructions/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/sysds/runtime/functionobjects/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2021 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>