public class PreparedScript extends Object implements ConfigurableAPI
| Modifier and Type | Method and Description | 
|---|---|
| void | clearParameters()Remove all current values bound to input or output variables. | 
| void | clearPinnedData()Remove all references to pinned variables from this script. | 
| Object | clone() | 
| PreparedScript | clone(boolean deep)Creates a cloned instance of the prepared script, which
 allows for concurrent execution without side effects. | 
| void | enableFunctionRecompile(String fnamespace,
                       String... fnames)Enables function recompilation, selectively for the given functions. | 
| ResultVariables | executeScript()Executes the prepared script over the bound inputs, creating the
 result variables according to bound and registered outputs. | 
| String | explain()Explain the DML/PyDML program and view result as a string. | 
| CompilerConfig | getCompilerConfig()Get the compiler configuration object associated with
 the prepared script instance. | 
| DMLConfig | getDMLConfig()Get the dml configuration object associated with
 the prepared script instance. | 
| String | getLineageTrace(String var)Capture lineage of the DML/PyDML program and view result as a string. | 
| void | resetConfig()Reset configuration settings to default settings. | 
| void | setConfigProperty(String propertyName,
                 String propertyValue)Set configuration property, such as
  setConfigProperty("sysds.localtmpdir", "/tmp/systemds"). | 
| void | setFrame(String varname,
        FrameBlock frame,
        boolean reuse)Binds a frame object to a registered input variable. | 
| void | setFrame(String varname,
        String[][] frame)Binds a frame object to a registered input variable. | 
| void | setFrame(String varname,
        String[][] frame,
        boolean reuse)Binds a frame object to a registered input variable. | 
| void | setFrame(String varname,
        String[][] frame,
        List<Types.ValueType> schema)Binds a frame object to a registered input variable. | 
| void | setFrame(String varname,
        String[][] frame,
        List<Types.ValueType> schema,
        boolean reuse)Binds a frame object to a registered input variable. | 
| void | setFrame(String varname,
        String[][] frame,
        List<Types.ValueType> schema,
        List<String> colnames)Binds a frame object to a registered input variable. | 
| void | setFrame(String varname,
        String[][] frame,
        List<Types.ValueType> schema,
        List<String> colnames,
        boolean reuse)Binds a frame object to a registered input variable. | 
| void | setMatrix(String varname,
         double[][] matrix)Binds a matrix object to a registered input variable. | 
| void | setMatrix(String varname,
         double[][] matrix,
         boolean reuse)Binds a matrix object to a registered input variable. | 
| void | setMatrix(String varname,
         MatrixBlock matrix,
         boolean reuse)Binds a matrix object to a registered input variable. | 
| void | setScalar(String varname,
         boolean scalar)Binds a scalar boolean to a registered input variable. | 
| void | setScalar(String varname,
         boolean scalar,
         boolean reuse)Binds a scalar boolean to a registered input variable. | 
| void | setScalar(String varname,
         double scalar)Binds a scalar double to a registered input variable. | 
| void | setScalar(String varname,
         double scalar,
         boolean reuse)Binds a scalar double to a registered input variable. | 
| void | setScalar(String varname,
         long scalar)Binds a scalar long to a registered input variable. | 
| void | setScalar(String varname,
         long scalar,
         boolean reuse)Binds a scalar long to a registered input variable. | 
| void | setScalar(String varname,
         ScalarObject scalar,
         boolean reuse)Binds a scalar object to a registered input variable. | 
| void | setScalar(String varname,
         String scalar)Binds a scalar string to a registered input variable. | 
| void | setScalar(String varname,
         String scalar,
         boolean reuse)Binds a scalar string to a registered input variable. | 
| String | statistics()Return a string containing runtime statistics. | 
public void resetConfig()
ConfigurableAPIresetConfig in interface ConfigurableAPIpublic void setConfigProperty(String propertyName, String propertyValue)
ConfigurableAPIsetConfigProperty("sysds.localtmpdir", "/tmp/systemds").setConfigProperty in interface ConfigurableAPIpropertyName - property namepropertyValue - property valuepublic DMLConfig getDMLConfig()
public CompilerConfig getCompilerConfig()
public void setScalar(String varname, boolean scalar)
varname - input variable namescalar - boolean valuepublic void setScalar(String varname, boolean scalar, boolean reuse)
varname - input variable namescalar - boolean valuereuse - if true, preserve value over multiple executeScript callspublic void setScalar(String varname, long scalar)
varname - input variable namescalar - long valuepublic void setScalar(String varname, long scalar, boolean reuse)
varname - input variable namescalar - long valuereuse - if true, preserve value over multiple executeScript callspublic void setScalar(String varname, double scalar)
varname - input variable namescalar - double valuepublic void setScalar(String varname, double scalar, boolean reuse)
varname - input variable namescalar - double valuereuse - if true, preserve value over multiple executeScript callspublic void setScalar(String varname, String scalar)
varname - input variable namescalar - string valuepublic void setScalar(String varname, String scalar, boolean reuse)
varname - input variable namescalar - string valuereuse - if true, preserve value over multiple executeScript callspublic void setScalar(String varname, ScalarObject scalar, boolean reuse)
executeScript calls.varname - input variable namescalar - scalar objectreuse - if true, preserve value over multiple executeScript callspublic void setMatrix(String varname, double[][] matrix)
varname - input variable namematrix - two-dimensional double array matrix representationpublic void setMatrix(String varname, double[][] matrix, boolean reuse)
varname - input variable namematrix - two-dimensional double array matrix representationreuse - if true, preserve value over multiple executeScript callspublic void setMatrix(String varname, MatrixBlock matrix, boolean reuse)
executeScript calls.varname - input variable namematrix - matrix represented as a MatrixBlockreuse - if true, preserve value over multiple executeScript callspublic void setFrame(String varname, String[][] frame)
varname - input variable nameframe - two-dimensional string array frame representationpublic void setFrame(String varname, String[][] frame, List<Types.ValueType> schema)
varname - input variable nameframe - two-dimensional string array frame representationschema - list representing the types of the frame columnspublic void setFrame(String varname, String[][] frame, List<Types.ValueType> schema, List<String> colnames)
varname - input variable nameframe - two-dimensional string array frame representationschema - list representing the types of the frame columnscolnames - frame column namespublic void setFrame(String varname, String[][] frame, boolean reuse)
varname - input variable nameframe - two-dimensional string array frame representationreuse - if true, preserve value over multiple executeScript callspublic void setFrame(String varname, String[][] frame, List<Types.ValueType> schema, boolean reuse)
varname - input variable nameframe - two-dimensional string array frame representationschema - list representing the types of the frame columnsreuse - if true, preserve value over multiple executeScript callspublic void setFrame(String varname, String[][] frame, List<Types.ValueType> schema, List<String> colnames, boolean reuse)
varname - input variable nameframe - two-dimensional string array frame representationschema - list representing the types of the frame columnscolnames - frame column namesreuse - if true, preserve value over multiple executeScript callspublic void setFrame(String varname, FrameBlock frame, boolean reuse)
executeScript calls.varname - input variable nameframe - frame represented as a FrameBlockreuse - if true, preserve value over multiple executeScript callspublic void clearParameters()
public void clearPinnedData()
public ResultVariables executeScript()
public String explain()
public String getLineageTrace(String var)
var - the output variable name on which lineage trace is soughtpublic String statistics()
public void enableFunctionRecompile(String fnamespace, String... fnames)
fnamespace - function namespace, null for default namespacefnames - function namepublic PreparedScript clone(boolean deep)
deep - 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.Copyright © 2020 The Apache Software Foundation. All rights reserved.