Package org.apache.sysds.api.jmlc
Class ResultVariables
- java.lang.Object
- 
- org.apache.sysds.api.jmlc.ResultVariables
 
- 
 public class ResultVariables extends Object A ResultVariables object holds the data returned by a call toPreparedScript'sexecuteScriptmethod, which executes a DML/PyDML script.
- 
- 
Constructor SummaryConstructors Constructor Description ResultVariables()
 - 
Method SummaryAll Methods Instance Methods Concrete Methods Modifier and Type Method Description booleangetBoolean(String varname)Obtain the boolean value represented by the given output variable.doublegetDouble(String varname)Obtain the double value represented by the given output variable.String[][]getFrame(String varname)Obtain the frame represented by the given output variable.FrameBlockgetFrameBlock(String varname)Obtain the frame represented by the given output variable.longgetLong(String varname)Obtain the long value represented by the given output variable.double[][]getMatrix(String varname)Obtain the matrix represented by the given output variable.MatrixBlockgetMatrixBlock(String varname)Obtain the matrix represented by the given output variable.ScalarObjectgetScalarObject(String varname)Obtain the ScalarObject represented by the given output variable.StringgetString(String varname)Obtain the string value represented by the given output variable.Set<String>getVariableNames()Obtain the output variable names held by this ResultVariables object.intsize()Obtain the number of output data held by this ResultVariables object.
 
- 
- 
- 
Method Detail- 
getVariableNamespublic Set<String> getVariableNames() Obtain the output variable names held by this ResultVariables object.- Returns:
- the set of output variable names
 
 - 
sizepublic int size() Obtain the number of output data held by this ResultVariables object.- Returns:
- the number of output variables with data
 
 - 
getMatrixpublic double[][] getMatrix(String varname) Obtain the matrix represented by the given output variable.- Parameters:
- varname- output variable name
- Returns:
- matrix as a two-dimensional double array
 
 - 
getMatrixBlockpublic MatrixBlock getMatrixBlock(String varname) Obtain the matrix represented by the given output variable. Calling this method avoids unnecessary output conversions.- Parameters:
- varname- output variable name
- Returns:
- matrix as matrix block
 
 - 
getFramepublic String[][] getFrame(String varname) Obtain the frame represented by the given output variable.- Parameters:
- varname- output variable name
- Returns:
- frame as a two-dimensional string array
 
 - 
getFrameBlockpublic FrameBlock getFrameBlock(String varname) Obtain the frame represented by the given output variable. Calling this method avoids unnecessary output conversions.- Parameters:
- varname- output variable name
- Returns:
- frame as a frame block
 
 - 
getDoublepublic double getDouble(String varname) Obtain the double value represented by the given output variable.- Parameters:
- varname- output variable name
- Returns:
- double value
 
 - 
getBooleanpublic boolean getBoolean(String varname) Obtain the boolean value represented by the given output variable.- Parameters:
- varname- output variable name
- Returns:
- boolean value
 
 - 
getLongpublic long getLong(String varname) Obtain the long value represented by the given output variable.- Parameters:
- varname- output variable name
- Returns:
- long value
 
 - 
getStringpublic String getString(String varname) Obtain the string value represented by the given output variable.- Parameters:
- varname- output variable name
- Returns:
- string value
 
 - 
getScalarObjectpublic ScalarObject getScalarObject(String varname) Obtain the ScalarObject represented by the given output variable.- Parameters:
- varname- output variable name
- Returns:
- ScalarObject
 
 
- 
 
-