blob: 8dbebf55938511988b1bbb56e657f3cfb36af60f [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>PreparedScript (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="PreparedScript (SystemDS 2.1.0-SNAPSHOT API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10,"i27":10,"i28":10,"i29":10,"i30":10,"i31":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</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/PreparedScript.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/jmlc/JMLCUtils.html" title="class in org.apache.sysds.api.jmlc"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/sysds/api/jmlc/ResultVariables.html" title="class in org.apache.sysds.api.jmlc"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/sysds/api/jmlc/PreparedScript.html" target="_top">Frames</a></li>
<li><a href="PreparedScript.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>Field&nbsp;|&nbsp;</li>
<li>Constr&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>Constr&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.jmlc</div>
<h2 title="Class PreparedScript" class="title">Class PreparedScript</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.jmlc.PreparedScript</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../../org/apache/sysds/api/ConfigurableAPI.html" title="interface in org.apache.sysds.api">ConfigurableAPI</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">PreparedScript</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>
implements <a href="../../../../../org/apache/sysds/api/ConfigurableAPI.html" title="interface in org.apache.sysds.api">ConfigurableAPI</a></pre>
<div class="block">Representation of a prepared (precompiled) DML/PyDML script.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== 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="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="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sysds/api/jmlc/PreparedScript.html#clearParameters--">clearParameters</a></span>()</code>
<div class="block">Remove all current values bound to input or output variables.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sysds/api/jmlc/PreparedScript.html#clearPinnedData--">clearPinnedData</a></span>()</code>
<div class="block">Remove all references to pinned variables from this script.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><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></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sysds/api/jmlc/PreparedScript.html#clone--">clone</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/sysds/api/jmlc/PreparedScript.html" title="class in org.apache.sysds.api.jmlc">PreparedScript</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sysds/api/jmlc/PreparedScript.html#clone-boolean-">clone</a></span>(boolean&nbsp;deep)</code>
<div class="block">Creates a cloned instance of the prepared script, which
allows for concurrent execution without side effects.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sysds/api/jmlc/PreparedScript.html#enableFunctionRecompile-java.lang.String-java.lang.String...-">enableFunctionRecompile</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;fnamespace,
<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;fnames)</code>
<div class="block">Enables function recompilation, selectively for the given functions.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/sysds/api/jmlc/ResultVariables.html" title="class in org.apache.sysds.api.jmlc">ResultVariables</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sysds/api/jmlc/PreparedScript.html#executeScript--">executeScript</a></span>()</code>
<div class="block">Executes the prepared script over the bound inputs, creating the
result variables according to bound and registered outputs.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><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/jmlc/PreparedScript.html#explain--">explain</a></span>()</code>
<div class="block">Explain the DML/PyDML program and view result as a string.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/sysds/conf/CompilerConfig.html" title="class in org.apache.sysds.conf">CompilerConfig</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sysds/api/jmlc/PreparedScript.html#getCompilerConfig--">getCompilerConfig</a></span>()</code>
<div class="block">Get the compiler configuration object associated with
the prepared script instance.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/sysds/conf/DMLConfig.html" title="class in org.apache.sysds.conf">DMLConfig</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sysds/api/jmlc/PreparedScript.html#getDMLConfig--">getDMLConfig</a></span>()</code>
<div class="block">Get the dml configuration object associated with
the prepared script instance.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code><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/jmlc/PreparedScript.html#getLineageTrace-java.lang.String-">getLineageTrace</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;var)</code>
<div class="block">Capture lineage of the DML/PyDML program and view result as a string.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sysds/api/jmlc/PreparedScript.html#resetConfig--">resetConfig</a></span>()</code>
<div class="block">Reset configuration settings to default settings.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sysds/api/jmlc/PreparedScript.html#setConfigProperty-java.lang.String-java.lang.String-">setConfigProperty</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;propertyName,
<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;propertyValue)</code>
<div class="block">Set configuration property, such as
<code>setConfigProperty("sysds.localtmpdir", "/tmp/systemds")</code>.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sysds/api/jmlc/PreparedScript.html#setFrame-java.lang.String-org.apache.sysds.runtime.matrix.data.FrameBlock-boolean-">setFrame</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;varname,
<a href="../../../../../org/apache/sysds/runtime/matrix/data/FrameBlock.html" title="class in org.apache.sysds.runtime.matrix.data">FrameBlock</a>&nbsp;frame,
boolean&nbsp;reuse)</code>
<div class="block">Binds a frame object to a registered input variable.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sysds/api/jmlc/PreparedScript.html#setFrame-java.lang.String-java.lang.String:A:A-">setFrame</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;varname,
<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;frame)</code>
<div class="block">Binds a frame object to a registered input variable.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sysds/api/jmlc/PreparedScript.html#setFrame-java.lang.String-java.lang.String:A:A-boolean-">setFrame</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;varname,
<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;frame,
boolean&nbsp;reuse)</code>
<div class="block">Binds a frame object to a registered input variable.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sysds/api/jmlc/PreparedScript.html#setFrame-java.lang.String-java.lang.String:A:A-java.util.List-">setFrame</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;varname,
<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;frame,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../org/apache/sysds/common/Types.ValueType.html" title="enum in org.apache.sysds.common">Types.ValueType</a>&gt;&nbsp;schema)</code>
<div class="block">Binds a frame object to a registered input variable.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sysds/api/jmlc/PreparedScript.html#setFrame-java.lang.String-java.lang.String:A:A-java.util.List-boolean-">setFrame</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;varname,
<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;frame,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../org/apache/sysds/common/Types.ValueType.html" title="enum in org.apache.sysds.common">Types.ValueType</a>&gt;&nbsp;schema,
boolean&nbsp;reuse)</code>
<div class="block">Binds a frame object to a registered input variable.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sysds/api/jmlc/PreparedScript.html#setFrame-java.lang.String-java.lang.String:A:A-java.util.List-java.util.List-">setFrame</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;varname,
<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;frame,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../org/apache/sysds/common/Types.ValueType.html" title="enum in org.apache.sysds.common">Types.ValueType</a>&gt;&nbsp;schema,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<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>&gt;&nbsp;colnames)</code>
<div class="block">Binds a frame object to a registered input variable.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sysds/api/jmlc/PreparedScript.html#setFrame-java.lang.String-java.lang.String:A:A-java.util.List-java.util.List-boolean-">setFrame</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;varname,
<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;frame,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../org/apache/sysds/common/Types.ValueType.html" title="enum in org.apache.sysds.common">Types.ValueType</a>&gt;&nbsp;schema,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<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>&gt;&nbsp;colnames,
boolean&nbsp;reuse)</code>
<div class="block">Binds a frame object to a registered input variable.</div>
</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sysds/api/jmlc/PreparedScript.html#setMatrix-java.lang.String-double:A:A-">setMatrix</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;varname,
double[][]&nbsp;matrix)</code>
<div class="block">Binds a matrix object to a registered input variable.</div>
</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sysds/api/jmlc/PreparedScript.html#setMatrix-java.lang.String-double:A:A-boolean-">setMatrix</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;varname,
double[][]&nbsp;matrix,
boolean&nbsp;reuse)</code>
<div class="block">Binds a matrix object to a registered input variable.</div>
</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sysds/api/jmlc/PreparedScript.html#setMatrix-java.lang.String-org.apache.sysds.runtime.matrix.data.MatrixBlock-boolean-">setMatrix</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;varname,
<a href="../../../../../org/apache/sysds/runtime/matrix/data/MatrixBlock.html" title="class in org.apache.sysds.runtime.matrix.data">MatrixBlock</a>&nbsp;matrix,
boolean&nbsp;reuse)</code>
<div class="block">Binds a matrix object to a registered input variable.</div>
</td>
</tr>
<tr id="i22" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sysds/api/jmlc/PreparedScript.html#setScalar-java.lang.String-boolean-">setScalar</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;varname,
boolean&nbsp;scalar)</code>
<div class="block">Binds a scalar boolean to a registered input variable.</div>
</td>
</tr>
<tr id="i23" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sysds/api/jmlc/PreparedScript.html#setScalar-java.lang.String-boolean-boolean-">setScalar</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;varname,
boolean&nbsp;scalar,
boolean&nbsp;reuse)</code>
<div class="block">Binds a scalar boolean to a registered input variable.</div>
</td>
</tr>
<tr id="i24" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sysds/api/jmlc/PreparedScript.html#setScalar-java.lang.String-double-">setScalar</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;varname,
double&nbsp;scalar)</code>
<div class="block">Binds a scalar double to a registered input variable.</div>
</td>
</tr>
<tr id="i25" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sysds/api/jmlc/PreparedScript.html#setScalar-java.lang.String-double-boolean-">setScalar</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;varname,
double&nbsp;scalar,
boolean&nbsp;reuse)</code>
<div class="block">Binds a scalar double to a registered input variable.</div>
</td>
</tr>
<tr id="i26" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sysds/api/jmlc/PreparedScript.html#setScalar-java.lang.String-long-">setScalar</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;varname,
long&nbsp;scalar)</code>
<div class="block">Binds a scalar long to a registered input variable.</div>
</td>
</tr>
<tr id="i27" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sysds/api/jmlc/PreparedScript.html#setScalar-java.lang.String-long-boolean-">setScalar</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;varname,
long&nbsp;scalar,
boolean&nbsp;reuse)</code>
<div class="block">Binds a scalar long to a registered input variable.</div>
</td>
</tr>
<tr id="i28" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sysds/api/jmlc/PreparedScript.html#setScalar-java.lang.String-org.apache.sysds.runtime.instructions.cp.ScalarObject-boolean-">setScalar</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;varname,
<a href="../../../../../org/apache/sysds/runtime/instructions/cp/ScalarObject.html" title="class in org.apache.sysds.runtime.instructions.cp">ScalarObject</a>&nbsp;scalar,
boolean&nbsp;reuse)</code>
<div class="block">Binds a scalar object to a registered input variable.</div>
</td>
</tr>
<tr id="i29" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sysds/api/jmlc/PreparedScript.html#setScalar-java.lang.String-java.lang.String-">setScalar</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;varname,
<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;scalar)</code>
<div class="block">Binds a scalar string to a registered input variable.</div>
</td>
</tr>
<tr id="i30" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sysds/api/jmlc/PreparedScript.html#setScalar-java.lang.String-java.lang.String-boolean-">setScalar</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;varname,
<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;scalar,
boolean&nbsp;reuse)</code>
<div class="block">Binds a scalar string to a registered input variable.</div>
</td>
</tr>
<tr id="i31" class="rowColor">
<td class="colFirst"><code><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/jmlc/PreparedScript.html#statistics--">statistics</a></span>()</code>
<div class="block">Return a string containing runtime statistics.</div>
</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">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="resetConfig--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>resetConfig</h4>
<pre>public&nbsp;void&nbsp;resetConfig()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/sysds/api/ConfigurableAPI.html#resetConfig--">ConfigurableAPI</a></code></span></div>
<div class="block">Reset configuration settings to default settings.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/sysds/api/ConfigurableAPI.html#resetConfig--">resetConfig</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/sysds/api/ConfigurableAPI.html" title="interface in org.apache.sysds.api">ConfigurableAPI</a></code></dd>
</dl>
</li>
</ul>
<a name="setConfigProperty-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setConfigProperty</h4>
<pre>public&nbsp;void&nbsp;setConfigProperty(<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;propertyName,
<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;propertyValue)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/sysds/api/ConfigurableAPI.html#setConfigProperty-java.lang.String-java.lang.String-">ConfigurableAPI</a></code></span></div>
<div class="block">Set configuration property, such as
<code>setConfigProperty("sysds.localtmpdir", "/tmp/systemds")</code>.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/sysds/api/ConfigurableAPI.html#setConfigProperty-java.lang.String-java.lang.String-">setConfigProperty</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/sysds/api/ConfigurableAPI.html" title="interface in org.apache.sysds.api">ConfigurableAPI</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>propertyName</code> - property name</dd>
<dd><code>propertyValue</code> - property value</dd>
</dl>
</li>
</ul>
<a name="getDMLConfig--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDMLConfig</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/sysds/conf/DMLConfig.html" title="class in org.apache.sysds.conf">DMLConfig</a>&nbsp;getDMLConfig()</pre>
<div class="block">Get the dml configuration object associated with
the prepared script instance.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>dml configuration</dd>
</dl>
</li>
</ul>
<a name="getCompilerConfig--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCompilerConfig</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/sysds/conf/CompilerConfig.html" title="class in org.apache.sysds.conf">CompilerConfig</a>&nbsp;getCompilerConfig()</pre>
<div class="block">Get the compiler configuration object associated with
the prepared script instance.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>compiler configuration</dd>
</dl>
</li>
</ul>
<a name="setScalar-java.lang.String-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setScalar</h4>
<pre>public&nbsp;void&nbsp;setScalar(<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;varname,
boolean&nbsp;scalar)</pre>
<div class="block">Binds a scalar boolean to a registered input variable.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>varname</code> - input variable name</dd>
<dd><code>scalar</code> - boolean value</dd>
</dl>
</li>
</ul>
<a name="setScalar-java.lang.String-boolean-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setScalar</h4>
<pre>public&nbsp;void&nbsp;setScalar(<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;varname,
boolean&nbsp;scalar,
boolean&nbsp;reuse)</pre>
<div class="block">Binds a scalar boolean to a registered input variable.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>varname</code> - input variable name</dd>
<dd><code>scalar</code> - boolean value</dd>
<dd><code>reuse</code> - if <code>true</code>, preserve value over multiple <code>executeScript</code> calls</dd>
</dl>
</li>
</ul>
<a name="setScalar-java.lang.String-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setScalar</h4>
<pre>public&nbsp;void&nbsp;setScalar(<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;varname,
long&nbsp;scalar)</pre>
<div class="block">Binds a scalar long to a registered input variable.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>varname</code> - input variable name</dd>
<dd><code>scalar</code> - long value</dd>
</dl>
</li>
</ul>
<a name="setScalar-java.lang.String-long-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setScalar</h4>
<pre>public&nbsp;void&nbsp;setScalar(<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;varname,
long&nbsp;scalar,
boolean&nbsp;reuse)</pre>
<div class="block">Binds a scalar long to a registered input variable.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>varname</code> - input variable name</dd>
<dd><code>scalar</code> - long value</dd>
<dd><code>reuse</code> - if <code>true</code>, preserve value over multiple <code>executeScript</code> calls</dd>
</dl>
</li>
</ul>
<a name="setScalar-java.lang.String-double-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setScalar</h4>
<pre>public&nbsp;void&nbsp;setScalar(<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;varname,
double&nbsp;scalar)</pre>
<div class="block">Binds a scalar double to a registered input variable.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>varname</code> - input variable name</dd>
<dd><code>scalar</code> - double value</dd>
</dl>
</li>
</ul>
<a name="setScalar-java.lang.String-double-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setScalar</h4>
<pre>public&nbsp;void&nbsp;setScalar(<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;varname,
double&nbsp;scalar,
boolean&nbsp;reuse)</pre>
<div class="block">Binds a scalar double to a registered input variable.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>varname</code> - input variable name</dd>
<dd><code>scalar</code> - double value</dd>
<dd><code>reuse</code> - if <code>true</code>, preserve value over multiple <code>executeScript</code> calls</dd>
</dl>
</li>
</ul>
<a name="setScalar-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setScalar</h4>
<pre>public&nbsp;void&nbsp;setScalar(<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;varname,
<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;scalar)</pre>
<div class="block">Binds a scalar string to a registered input variable.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>varname</code> - input variable name</dd>
<dd><code>scalar</code> - string value</dd>
</dl>
</li>
</ul>
<a name="setScalar-java.lang.String-java.lang.String-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setScalar</h4>
<pre>public&nbsp;void&nbsp;setScalar(<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;varname,
<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;scalar,
boolean&nbsp;reuse)</pre>
<div class="block">Binds a scalar string to a registered input variable.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>varname</code> - input variable name</dd>
<dd><code>scalar</code> - string value</dd>
<dd><code>reuse</code> - if <code>true</code>, preserve value over multiple <code>executeScript</code> calls</dd>
</dl>
</li>
</ul>
<a name="setScalar-java.lang.String-org.apache.sysds.runtime.instructions.cp.ScalarObject-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setScalar</h4>
<pre>public&nbsp;void&nbsp;setScalar(<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;varname,
<a href="../../../../../org/apache/sysds/runtime/instructions/cp/ScalarObject.html" title="class in org.apache.sysds.runtime.instructions.cp">ScalarObject</a>&nbsp;scalar,
boolean&nbsp;reuse)</pre>
<div class="block">Binds a scalar object to a registered input variable.
If reuse requested, then the input is guaranteed to be
preserved over multiple <code>executeScript</code> calls.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>varname</code> - input variable name</dd>
<dd><code>scalar</code> - scalar object</dd>
<dd><code>reuse</code> - if <code>true</code>, preserve value over multiple <code>executeScript</code> calls</dd>
</dl>
</li>
</ul>
<a name="setMatrix-java.lang.String-double:A:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMatrix</h4>
<pre>public&nbsp;void&nbsp;setMatrix(<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;varname,
double[][]&nbsp;matrix)</pre>
<div class="block">Binds a matrix object to a registered input variable.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>varname</code> - input variable name</dd>
<dd><code>matrix</code> - two-dimensional double array matrix representation</dd>
</dl>
</li>
</ul>
<a name="setMatrix-java.lang.String-double:A:A-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMatrix</h4>
<pre>public&nbsp;void&nbsp;setMatrix(<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;varname,
double[][]&nbsp;matrix,
boolean&nbsp;reuse)</pre>
<div class="block">Binds a matrix object to a registered input variable.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>varname</code> - input variable name</dd>
<dd><code>matrix</code> - two-dimensional double array matrix representation</dd>
<dd><code>reuse</code> - if <code>true</code>, preserve value over multiple <code>executeScript</code> calls</dd>
</dl>
</li>
</ul>
<a name="setMatrix-java.lang.String-org.apache.sysds.runtime.matrix.data.MatrixBlock-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMatrix</h4>
<pre>public&nbsp;void&nbsp;setMatrix(<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;varname,
<a href="../../../../../org/apache/sysds/runtime/matrix/data/MatrixBlock.html" title="class in org.apache.sysds.runtime.matrix.data">MatrixBlock</a>&nbsp;matrix,
boolean&nbsp;reuse)</pre>
<div class="block">Binds a matrix object to a registered input variable.
If reuse requested, then the input is guaranteed to be
preserved over multiple <code>executeScript</code> calls.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>varname</code> - input variable name</dd>
<dd><code>matrix</code> - matrix represented as a MatrixBlock</dd>
<dd><code>reuse</code> - if <code>true</code>, preserve value over multiple <code>executeScript</code> calls</dd>
</dl>
</li>
</ul>
<a name="setFrame-java.lang.String-java.lang.String:A:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setFrame</h4>
<pre>public&nbsp;void&nbsp;setFrame(<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;varname,
<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;frame)</pre>
<div class="block">Binds a frame object to a registered input variable.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>varname</code> - input variable name</dd>
<dd><code>frame</code> - two-dimensional string array frame representation</dd>
</dl>
</li>
</ul>
<a name="setFrame-java.lang.String-java.lang.String:A:A-java.util.List-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setFrame</h4>
<pre>public&nbsp;void&nbsp;setFrame(<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;varname,
<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;frame,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../org/apache/sysds/common/Types.ValueType.html" title="enum in org.apache.sysds.common">Types.ValueType</a>&gt;&nbsp;schema)</pre>
<div class="block">Binds a frame object to a registered input variable.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>varname</code> - input variable name</dd>
<dd><code>frame</code> - two-dimensional string array frame representation</dd>
<dd><code>schema</code> - list representing the types of the frame columns</dd>
</dl>
</li>
</ul>
<a name="setFrame-java.lang.String-java.lang.String:A:A-java.util.List-java.util.List-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setFrame</h4>
<pre>public&nbsp;void&nbsp;setFrame(<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;varname,
<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;frame,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../org/apache/sysds/common/Types.ValueType.html" title="enum in org.apache.sysds.common">Types.ValueType</a>&gt;&nbsp;schema,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<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>&gt;&nbsp;colnames)</pre>
<div class="block">Binds a frame object to a registered input variable.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>varname</code> - input variable name</dd>
<dd><code>frame</code> - two-dimensional string array frame representation</dd>
<dd><code>schema</code> - list representing the types of the frame columns</dd>
<dd><code>colnames</code> - frame column names</dd>
</dl>
</li>
</ul>
<a name="setFrame-java.lang.String-java.lang.String:A:A-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setFrame</h4>
<pre>public&nbsp;void&nbsp;setFrame(<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;varname,
<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;frame,
boolean&nbsp;reuse)</pre>
<div class="block">Binds a frame object to a registered input variable.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>varname</code> - input variable name</dd>
<dd><code>frame</code> - two-dimensional string array frame representation</dd>
<dd><code>reuse</code> - if <code>true</code>, preserve value over multiple <code>executeScript</code> calls</dd>
</dl>
</li>
</ul>
<a name="setFrame-java.lang.String-java.lang.String:A:A-java.util.List-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setFrame</h4>
<pre>public&nbsp;void&nbsp;setFrame(<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;varname,
<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;frame,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../org/apache/sysds/common/Types.ValueType.html" title="enum in org.apache.sysds.common">Types.ValueType</a>&gt;&nbsp;schema,
boolean&nbsp;reuse)</pre>
<div class="block">Binds a frame object to a registered input variable.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>varname</code> - input variable name</dd>
<dd><code>frame</code> - two-dimensional string array frame representation</dd>
<dd><code>schema</code> - list representing the types of the frame columns</dd>
<dd><code>reuse</code> - if <code>true</code>, preserve value over multiple <code>executeScript</code> calls</dd>
</dl>
</li>
</ul>
<a name="setFrame-java.lang.String-java.lang.String:A:A-java.util.List-java.util.List-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setFrame</h4>
<pre>public&nbsp;void&nbsp;setFrame(<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;varname,
<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;frame,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../org/apache/sysds/common/Types.ValueType.html" title="enum in org.apache.sysds.common">Types.ValueType</a>&gt;&nbsp;schema,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<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>&gt;&nbsp;colnames,
boolean&nbsp;reuse)</pre>
<div class="block">Binds a frame object to a registered input variable.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>varname</code> - input variable name</dd>
<dd><code>frame</code> - two-dimensional string array frame representation</dd>
<dd><code>schema</code> - list representing the types of the frame columns</dd>
<dd><code>colnames</code> - frame column names</dd>
<dd><code>reuse</code> - if <code>true</code>, preserve value over multiple <code>executeScript</code> calls</dd>
</dl>
</li>
</ul>
<a name="setFrame-java.lang.String-org.apache.sysds.runtime.matrix.data.FrameBlock-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setFrame</h4>
<pre>public&nbsp;void&nbsp;setFrame(<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;varname,
<a href="../../../../../org/apache/sysds/runtime/matrix/data/FrameBlock.html" title="class in org.apache.sysds.runtime.matrix.data">FrameBlock</a>&nbsp;frame,
boolean&nbsp;reuse)</pre>
<div class="block">Binds a frame object to a registered input variable.
If reuse requested, then the input is guaranteed to be
preserved over multiple <code>executeScript</code> calls.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>varname</code> - input variable name</dd>
<dd><code>frame</code> - frame represented as a FrameBlock</dd>
<dd><code>reuse</code> - if <code>true</code>, preserve value over multiple <code>executeScript</code> calls</dd>
</dl>
</li>
</ul>
<a name="clearParameters--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clearParameters</h4>
<pre>public&nbsp;void&nbsp;clearParameters()</pre>
<div class="block">Remove all current values bound to input or output variables.</div>
</li>
</ul>
<a name="clearPinnedData--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clearPinnedData</h4>
<pre>public&nbsp;void&nbsp;clearPinnedData()</pre>
<div class="block">Remove all references to pinned variables from this script.
Note: this *does not* remove the underlying data. It merely
removes a reference to it from this prepared script. This is
useful if you want to maintain an independent cache of weights
and allow the JVM to garbage collect under memory pressure.</div>
</li>
</ul>
<a name="executeScript--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>executeScript</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/sysds/api/jmlc/ResultVariables.html" title="class in org.apache.sysds.api.jmlc">ResultVariables</a>&nbsp;executeScript()</pre>
<div class="block">Executes the prepared script over the bound inputs, creating the
result variables according to bound and registered outputs.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>ResultVariables object encapsulating output results</dd>
</dl>
</li>
</ul>
<a name="explain--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>explain</h4>
<pre>public&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;explain()</pre>
<div class="block">Explain the DML/PyDML program and view result as a string.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>string results of explain</dd>
</dl>
</li>
</ul>
<a name="getLineageTrace-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLineageTrace</h4>
<pre>public&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;getLineageTrace(<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;var)</pre>
<div class="block">Capture lineage of the DML/PyDML program and view result as a string.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>var</code> - the output variable name on which lineage trace is sought</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>string results of lineage trace</dd>
</dl>
</li>
</ul>
<a name="statistics--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>statistics</h4>
<pre>public&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;statistics()</pre>
<div class="block">Return a string containing runtime statistics. Note: these are not thread local
and will reflect execution in all threads</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>string containing statistics</dd>
</dl>
</li>
</ul>
<a name="enableFunctionRecompile-java.lang.String-java.lang.String...-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>enableFunctionRecompile</h4>
<pre>public&nbsp;void&nbsp;enableFunctionRecompile(<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;fnamespace,
<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;fnames)</pre>
<div class="block">Enables function recompilation, selectively for the given functions.
If dynamic recompilation is globally enabled this has no additional
effect; otherwise the given functions are dynamically recompiled once
on every entry but not at the granularity of individually last-level
program blocks. Use this fine-grained recompilation option for important
functions in small-data scenarios where dynamic recompilation overheads
might not be amortized.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>fnamespace</code> - function namespace, null for default namespace</dd>
<dd><code>fnames</code> - function name</dd>
</dl>
</li>
</ul>
<a name="clone-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clone</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/sysds/api/jmlc/PreparedScript.html" title="class in org.apache.sysds.api.jmlc">PreparedScript</a>&nbsp;clone(boolean&nbsp;deep)</pre>
<div class="block">Creates a cloned instance of the prepared script, which
allows for concurrent execution without side effects.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>deep</code> - indicator if a deep copy needs to be created;
if false, only a shallow (i.e., by reference) copy of the
program and read-only meta data is created.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an equivalent prepared script</dd>
</dl>
</li>
</ul>
<a name="clone--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>clone</h4>
<pre>public&nbsp;<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>&nbsp;clone()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a></code>&nbsp;in class&nbsp;<code><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></code></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/PreparedScript.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/jmlc/JMLCUtils.html" title="class in org.apache.sysds.api.jmlc"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/sysds/api/jmlc/ResultVariables.html" title="class in org.apache.sysds.api.jmlc"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/sysds/api/jmlc/PreparedScript.html" target="_top">Frames</a></li>
<li><a href="PreparedScript.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>Field&nbsp;|&nbsp;</li>
<li>Constr&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>Constr&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>