blob: 460befe68f250e1519924d9f9c05aabaa0b25103 [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>DMLScript (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="DMLScript (SystemDS 2.1.0-SNAPSHOT API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9,"i5":9,"i6":9,"i7":9,"i8":9,"i9":9,"i10":9,"i11":9,"i12":9};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/DMLScript.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/api/DMLOptions.html" title="class in org.apache.sysds.api"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/sysds/api/PythonDMLScript.html" title="class in org.apache.sysds.api"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/sysds/api/DMLScript.html" target="_top">Frames</a></li>
<li><a href="DMLScript.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#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><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.sysds.api</div>
<h2 title="Class DMLScript" class="title">Class DMLScript</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>org.apache.sysds.api.DMLScript</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="typeNameLabel">DMLScript</span>
extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/sysds/api/DMLScript.html#Z:Z_activeAM">_activeAM</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/sysds/api/DMLScript.html#Z:Z_suppressPrint2Stdout">_suppressPrint2Stdout</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/sysds/api/DMLScript.html#Z:Z_uuid">_uuid</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/sysds/api/DMLScript.html#CHECK_PRIVACY">CHECK_PRIVACY</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/sysds/api/DMLScript.html#DML_FILE_PATH_ANTLR_PARSER">DML_FILE_PATH_ANTLR_PARSER</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/sysds/api/DMLScript.html#EAGER_CUDA_FREE">EAGER_CUDA_FREE</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/sysds/api/DMLScript.html#EVICTION_SHADOW_BUFFER_CURR_BYTES">EVICTION_SHADOW_BUFFER_CURR_BYTES</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/sysds/api/DMLScript.html#EVICTION_SHADOW_BUFFER_MAX_BYTES">EVICTION_SHADOW_BUFFER_MAX_BYTES</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../../org/apache/sysds/utils/Explain.ExplainType.html" title="enum in org.apache.sysds.utils">Explain.ExplainType</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/sysds/api/DMLScript.html#EXPLAIN">EXPLAIN</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/sysds/api/DMLScript.html#FLOATING_POINT_PRECISION">FLOATING_POINT_PRECISION</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/sysds/api/DMLScript.html#FORCE_ACCELERATOR">FORCE_ACCELERATOR</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/sysds/api/DMLScript.html#GPU_MEMORY_ALLOCATOR">GPU_MEMORY_ALLOCATOR</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static double</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/sysds/api/DMLScript.html#GPU_MEMORY_UTILIZATION_FACTOR">GPU_MEMORY_UTILIZATION_FACTOR</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/sysds/api/DMLScript.html#JMLC_MEM_STATISTICS">JMLC_MEM_STATISTICS</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/sysds/api/DMLScript.html#LINEAGE">LINEAGE</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/sysds/api/DMLScript.html#LINEAGE_DEDUP">LINEAGE_DEDUP</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/sysds/api/DMLScript.html#LINEAGE_ESTIMATE">LINEAGE_ESTIMATE</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../../../org/apache/sysds/runtime/lineage/LineageCacheConfig.LineageCachePolicy.html" title="enum in org.apache.sysds.runtime.lineage">LineageCacheConfig.LineageCachePolicy</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/sysds/api/DMLScript.html#LINEAGE_POLICY">LINEAGE_POLICY</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../../org/apache/sysds/runtime/lineage/LineageCacheConfig.ReuseCacheType.html" title="enum in org.apache.sysds.runtime.lineage">LineageCacheConfig.ReuseCacheType</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/sysds/api/DMLScript.html#LINEAGE_REUSE">LINEAGE_REUSE</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/sysds/api/DMLScript.html#PRINT_GPU_MEMORY_INFO">PRINT_GPU_MEMORY_INFO</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/sysds/api/DMLScript.html#STATISTICS">STATISTICS</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/sysds/api/DMLScript.html#STATISTICS_COUNT">STATISTICS_COUNT</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/sysds/api/DMLScript.html#STATISTICS_MAX_WRAP_LEN">STATISTICS_MAX_WRAP_LEN</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/sysds/api/DMLScript.html#SYNCHRONIZE_GPU">SYNCHRONIZE_GPU</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/sysds/api/DMLScript.html#USE_ACCELERATOR">USE_ACCELERATOR</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/sysds/api/DMLScript.html#USE_LOCAL_SPARK_CONFIG">USE_LOCAL_SPARK_CONFIG</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/sysds/api/DMLScript.html#VALIDATOR_IGNORE_ISSUES">VALIDATOR_IGNORE_ISSUES</a></span></code>
<div class="block">If true, allow DMLProgram to be generated while not halting due to validation errors/warnings</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/sysds/api/DMLScript.html#DMLScript--">DMLScript</a></span>()</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/sysds/api/DMLScript.html#cleanupHadoopExecution-org.apache.sysds.conf.DMLConfig-">cleanupHadoopExecution</a></span>(<a href="../../../../org/apache/sysds/conf/DMLConfig.html" title="class in org.apache.sysds.conf">DMLConfig</a>&nbsp;config)</code>&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/sysds/api/DMLScript.html#errorPrint-java.lang.Exception-">errorPrint</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a>&nbsp;e)</code>
<div class="block">Print the error in a user friendly manner.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>static boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/sysds/api/DMLScript.html#executeScript-org.apache.hadoop.conf.Configuration-java.lang.String:A-">executeScript</a></span>(org.apache.hadoop.conf.Configuration&nbsp;conf,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]&nbsp;args)</code>
<div class="block">Single entry point for all public invocation alternatives (e.g.,
main, executeScript, JaqlUdf etc)</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>static <a href="../../../../org/apache/sysds/common/Types.ExecMode.html" title="enum in org.apache.sysds.common">Types.ExecMode</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/sysds/api/DMLScript.html#getGlobalExecMode--">getGlobalExecMode</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/sysds/api/DMLScript.html#getUUID--">getUUID</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/sysds/api/DMLScript.html#initHadoopExecution-org.apache.sysds.conf.DMLConfig-">initHadoopExecution</a></span>(<a href="../../../../org/apache/sysds/conf/DMLConfig.html" title="class in org.apache.sysds.conf">DMLConfig</a>&nbsp;config)</code>&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>static boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/sysds/api/DMLScript.html#isActiveAM--">isActiveAM</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/sysds/api/DMLScript.html#main-java.lang.String:A-">main</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]&nbsp;args)</code>
<div class="block">Main entry point for systemDS dml script execution</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/sysds/api/DMLScript.html#setActiveAM--">setActiveAM</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/sysds/api/DMLScript.html#setGlobalExecMode-org.apache.sysds.common.Types.ExecMode-">setGlobalExecMode</a></span>(<a href="../../../../org/apache/sysds/common/Types.ExecMode.html" title="enum in org.apache.sysds.common">Types.ExecMode</a>&nbsp;mode)</code>&nbsp;</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/sysds/api/DMLScript.html#setGlobalFlags-org.apache.sysds.conf.DMLConfig-">setGlobalFlags</a></span>(<a href="../../../../org/apache/sysds/conf/DMLConfig.html" title="class in org.apache.sysds.conf">DMLConfig</a>&nbsp;dmlconf)</code>
<div class="block">Sets the global flags in DMLScript based on user provided configuration</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/sysds/api/DMLScript.html#setUUID-java.lang.String-">setUUID</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;uuid)</code>
<div class="block">Used to set master UUID on all nodes (in parfor remote, where DMLScript passed)
in order to simplify cleanup of scratch_space and local working dirs.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>static boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/sysds/api/DMLScript.html#suppressPrint2Stdout--">suppressPrint2Stdout</a></span>()</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="STATISTICS">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>STATISTICS</h4>
<pre>public static&nbsp;boolean STATISTICS</pre>
</li>
</ul>
<a name="JMLC_MEM_STATISTICS">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>JMLC_MEM_STATISTICS</h4>
<pre>public static&nbsp;boolean JMLC_MEM_STATISTICS</pre>
</li>
</ul>
<a name="STATISTICS_COUNT">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>STATISTICS_COUNT</h4>
<pre>public static&nbsp;int STATISTICS_COUNT</pre>
</li>
</ul>
<a name="STATISTICS_MAX_WRAP_LEN">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>STATISTICS_MAX_WRAP_LEN</h4>
<pre>public static&nbsp;int STATISTICS_MAX_WRAP_LEN</pre>
</li>
</ul>
<a name="EXPLAIN">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>EXPLAIN</h4>
<pre>public static&nbsp;<a href="../../../../org/apache/sysds/utils/Explain.ExplainType.html" title="enum in org.apache.sysds.utils">Explain.ExplainType</a> EXPLAIN</pre>
</li>
</ul>
<a name="DML_FILE_PATH_ANTLR_PARSER">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DML_FILE_PATH_ANTLR_PARSER</h4>
<pre>public static&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> DML_FILE_PATH_ANTLR_PARSER</pre>
</li>
</ul>
<a name="FLOATING_POINT_PRECISION">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>FLOATING_POINT_PRECISION</h4>
<pre>public static&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> FLOATING_POINT_PRECISION</pre>
</li>
</ul>
<a name="PRINT_GPU_MEMORY_INFO">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>PRINT_GPU_MEMORY_INFO</h4>
<pre>public static&nbsp;boolean PRINT_GPU_MEMORY_INFO</pre>
</li>
</ul>
<a name="EVICTION_SHADOW_BUFFER_MAX_BYTES">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>EVICTION_SHADOW_BUFFER_MAX_BYTES</h4>
<pre>public static&nbsp;long EVICTION_SHADOW_BUFFER_MAX_BYTES</pre>
</li>
</ul>
<a name="EVICTION_SHADOW_BUFFER_CURR_BYTES">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>EVICTION_SHADOW_BUFFER_CURR_BYTES</h4>
<pre>public static&nbsp;long EVICTION_SHADOW_BUFFER_CURR_BYTES</pre>
</li>
</ul>
<a name="GPU_MEMORY_UTILIZATION_FACTOR">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>GPU_MEMORY_UTILIZATION_FACTOR</h4>
<pre>public static&nbsp;double GPU_MEMORY_UTILIZATION_FACTOR</pre>
</li>
</ul>
<a name="GPU_MEMORY_ALLOCATOR">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>GPU_MEMORY_ALLOCATOR</h4>
<pre>public static&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> GPU_MEMORY_ALLOCATOR</pre>
</li>
</ul>
<a name="LINEAGE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>LINEAGE</h4>
<pre>public static&nbsp;boolean LINEAGE</pre>
</li>
</ul>
<a name="LINEAGE_DEDUP">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>LINEAGE_DEDUP</h4>
<pre>public static&nbsp;boolean LINEAGE_DEDUP</pre>
</li>
</ul>
<a name="LINEAGE_REUSE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>LINEAGE_REUSE</h4>
<pre>public static&nbsp;<a href="../../../../org/apache/sysds/runtime/lineage/LineageCacheConfig.ReuseCacheType.html" title="enum in org.apache.sysds.runtime.lineage">LineageCacheConfig.ReuseCacheType</a> LINEAGE_REUSE</pre>
</li>
</ul>
<a name="LINEAGE_POLICY">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>LINEAGE_POLICY</h4>
<pre>public static&nbsp;<a href="../../../../org/apache/sysds/runtime/lineage/LineageCacheConfig.LineageCachePolicy.html" title="enum in org.apache.sysds.runtime.lineage">LineageCacheConfig.LineageCachePolicy</a> LINEAGE_POLICY</pre>
</li>
</ul>
<a name="LINEAGE_ESTIMATE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>LINEAGE_ESTIMATE</h4>
<pre>public static&nbsp;boolean LINEAGE_ESTIMATE</pre>
</li>
</ul>
<a name="CHECK_PRIVACY">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>CHECK_PRIVACY</h4>
<pre>public static&nbsp;boolean CHECK_PRIVACY</pre>
</li>
</ul>
<a name="USE_ACCELERATOR">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>USE_ACCELERATOR</h4>
<pre>public static&nbsp;boolean USE_ACCELERATOR</pre>
</li>
</ul>
<a name="FORCE_ACCELERATOR">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>FORCE_ACCELERATOR</h4>
<pre>public static&nbsp;boolean FORCE_ACCELERATOR</pre>
</li>
</ul>
<a name="SYNCHRONIZE_GPU">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>SYNCHRONIZE_GPU</h4>
<pre>public static&nbsp;boolean SYNCHRONIZE_GPU</pre>
</li>
</ul>
<a name="EAGER_CUDA_FREE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>EAGER_CUDA_FREE</h4>
<pre>public static&nbsp;boolean EAGER_CUDA_FREE</pre>
</li>
</ul>
<a name="Z:Z_suppressPrint2Stdout">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>_suppressPrint2Stdout</h4>
<pre>public static&nbsp;boolean _suppressPrint2Stdout</pre>
</li>
</ul>
<a name="USE_LOCAL_SPARK_CONFIG">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>USE_LOCAL_SPARK_CONFIG</h4>
<pre>public static&nbsp;boolean USE_LOCAL_SPARK_CONFIG</pre>
</li>
</ul>
<a name="Z:Z_activeAM">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>_activeAM</h4>
<pre>public static&nbsp;boolean _activeAM</pre>
</li>
</ul>
<a name="VALIDATOR_IGNORE_ISSUES">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>VALIDATOR_IGNORE_ISSUES</h4>
<pre>public static&nbsp;boolean VALIDATOR_IGNORE_ISSUES</pre>
<div class="block">If true, allow DMLProgram to be generated while not halting due to validation errors/warnings</div>
</li>
</ul>
<a name="Z:Z_uuid">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>_uuid</h4>
<pre>public static&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> _uuid</pre>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="DMLScript--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>DMLScript</h4>
<pre>public&nbsp;DMLScript()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getUUID--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getUUID</h4>
<pre>public static&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getUUID()</pre>
</li>
</ul>
<a name="setUUID-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setUUID</h4>
<pre>public static&nbsp;void&nbsp;setUUID(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;uuid)</pre>
<div class="block">Used to set master UUID on all nodes (in parfor remote, where DMLScript passed)
in order to simplify cleanup of scratch_space and local working dirs.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>uuid</code> - master UUID to set on all nodes</dd>
</dl>
</li>
</ul>
<a name="suppressPrint2Stdout--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>suppressPrint2Stdout</h4>
<pre>public static&nbsp;boolean&nbsp;suppressPrint2Stdout()</pre>
</li>
</ul>
<a name="setActiveAM--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setActiveAM</h4>
<pre>public static&nbsp;void&nbsp;setActiveAM()</pre>
</li>
</ul>
<a name="isActiveAM--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isActiveAM</h4>
<pre>public static&nbsp;boolean&nbsp;isActiveAM()</pre>
</li>
</ul>
<a name="main-java.lang.String:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>main</h4>
<pre>public static&nbsp;void&nbsp;main(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]&nbsp;args)</pre>
<div class="block">Main entry point for systemDS dml script execution</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>args</code> - command-line arguments</dd>
</dl>
</li>
</ul>
<a name="executeScript-org.apache.hadoop.conf.Configuration-java.lang.String:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>executeScript</h4>
<pre>public static&nbsp;boolean&nbsp;executeScript(org.apache.hadoop.conf.Configuration&nbsp;conf,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]&nbsp;args)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a>,
<a href="../../../../org/apache/sysds/parser/ParseException.html" title="class in org.apache.sysds.parser">ParseException</a>,
<a href="../../../../org/apache/sysds/runtime/DMLScriptException.html" title="class in org.apache.sysds.runtime">DMLScriptException</a></pre>
<div class="block">Single entry point for all public invocation alternatives (e.g.,
main, executeScript, JaqlUdf etc)</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>conf</code> - Hadoop configuration</dd>
<dd><code>args</code> - arguments</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if success, false otherwise</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - If an internal IOException happens.</dd>
<dd><code><a href="../../../../org/apache/sysds/parser/ParseException.html" title="class in org.apache.sysds.parser">ParseException</a></code></dd>
<dd><code><a href="../../../../org/apache/sysds/runtime/DMLScriptException.html" title="class in org.apache.sysds.runtime">DMLScriptException</a></code></dd>
</dl>
</li>
</ul>
<a name="setGlobalFlags-org.apache.sysds.conf.DMLConfig-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setGlobalFlags</h4>
<pre>public static&nbsp;void&nbsp;setGlobalFlags(<a href="../../../../org/apache/sysds/conf/DMLConfig.html" title="class in org.apache.sysds.conf">DMLConfig</a>&nbsp;dmlconf)</pre>
<div class="block">Sets the global flags in DMLScript based on user provided configuration</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>dmlconf</code> - user provided configuration</dd>
</dl>
</li>
</ul>
<a name="initHadoopExecution-org.apache.sysds.conf.DMLConfig-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>initHadoopExecution</h4>
<pre>public static&nbsp;void&nbsp;initHadoopExecution(<a href="../../../../org/apache/sysds/conf/DMLConfig.html" title="class in org.apache.sysds.conf">DMLConfig</a>&nbsp;config)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a>,
<a href="../../../../org/apache/sysds/parser/ParseException.html" title="class in org.apache.sysds.parser">ParseException</a>,
<a href="../../../../org/apache/sysds/runtime/DMLRuntimeException.html" title="class in org.apache.sysds.runtime">DMLRuntimeException</a></pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
<dd><code><a href="../../../../org/apache/sysds/parser/ParseException.html" title="class in org.apache.sysds.parser">ParseException</a></code></dd>
<dd><code><a href="../../../../org/apache/sysds/runtime/DMLRuntimeException.html" title="class in org.apache.sysds.runtime">DMLRuntimeException</a></code></dd>
</dl>
</li>
</ul>
<a name="cleanupHadoopExecution-org.apache.sysds.conf.DMLConfig-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>cleanupHadoopExecution</h4>
<pre>public static&nbsp;void&nbsp;cleanupHadoopExecution(<a href="../../../../org/apache/sysds/conf/DMLConfig.html" title="class in org.apache.sysds.conf">DMLConfig</a>&nbsp;config)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a>,
<a href="../../../../org/apache/sysds/parser/ParseException.html" title="class in org.apache.sysds.parser">ParseException</a></pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
<dd><code><a href="../../../../org/apache/sysds/parser/ParseException.html" title="class in org.apache.sysds.parser">ParseException</a></code></dd>
</dl>
</li>
</ul>
<a name="getGlobalExecMode--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getGlobalExecMode</h4>
<pre>public static&nbsp;<a href="../../../../org/apache/sysds/common/Types.ExecMode.html" title="enum in org.apache.sysds.common">Types.ExecMode</a>&nbsp;getGlobalExecMode()</pre>
</li>
</ul>
<a name="setGlobalExecMode-org.apache.sysds.common.Types.ExecMode-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setGlobalExecMode</h4>
<pre>public static&nbsp;void&nbsp;setGlobalExecMode(<a href="../../../../org/apache/sysds/common/Types.ExecMode.html" title="enum in org.apache.sysds.common">Types.ExecMode</a>&nbsp;mode)</pre>
</li>
</ul>
<a name="errorPrint-java.lang.Exception-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>errorPrint</h4>
<pre>public static&nbsp;void&nbsp;errorPrint(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a>&nbsp;e)</pre>
<div class="block">Print the error in a user friendly manner.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>e</code> - The exception thrown.</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/DMLScript.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/api/DMLOptions.html" title="class in org.apache.sysds.api"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/sysds/api/PythonDMLScript.html" title="class in org.apache.sysds.api"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/sysds/api/DMLScript.html" target="_top">Frames</a></li>
<li><a href="DMLScript.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#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><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2021 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>