Matrix (SystemML 0.14.0 API)

java.lang.Object
- org.apache.sysml.api.mlcontext.Matrix

```
public class Matrix
extends Object
```
Matrix encapsulates a SystemML matrix. It allows for easy conversion to various other formats, such as RDDs, JavaRDDs, DataFrames, BinaryBlockMatrices, and double[][]s. After script execution, it offers a convenient format for obtaining SystemML matrix data in Scala tuples.

Constructor Summary

Constructors
Constructor and Description
`Matrix(org.apache.sysml.runtime.controlprogram.caching.MatrixObject matrixObject, org.apache.sysml.runtime.controlprogram.context.SparkExecutionContext sparkExecutionContext)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`MatrixMetadata`	`getMatrixMetadata()` Obtain the matrix metadata
`double[][]`	`to2DDoubleArray()` Obtain the matrix as a two-dimensional double array
`BinaryBlockMatrix`	`toBinaryBlockMatrix()` Obtain the matrix as a `BinaryBlockMatrix`
`org.apache.spark.sql.Dataset<org.apache.spark.sql.Row>`	`toDF()` Obtain the matrix as a `DataFrame` of doubles with an ID column
`org.apache.spark.sql.Dataset<org.apache.spark.sql.Row>`	`toDFDoubleNoIDColumn()` Obtain the matrix as a `DataFrame` of doubles with no ID column
`org.apache.spark.sql.Dataset<org.apache.spark.sql.Row>`	`toDFDoubleWithIDColumn()` Obtain the matrix as a `DataFrame` of doubles with an ID column
`org.apache.spark.sql.Dataset<org.apache.spark.sql.Row>`	`toDFVectorNoIDColumn()` Obtain the matrix as a `DataFrame` of vectors with no ID column
`org.apache.spark.sql.Dataset<org.apache.spark.sql.Row>`	`toDFVectorWithIDColumn()` Obtain the matrix as a `DataFrame` of vectors with an ID column
`org.apache.spark.api.java.JavaRDD<String>`	`toJavaRDDStringCSV()` Obtain the matrix as a `JavaRDD<String>` in CSV format
`org.apache.spark.api.java.JavaRDD<String>`	`toJavaRDDStringIJV()` Obtain the matrix as a `JavaRDD<String>` in IJV format
`org.apache.sysml.runtime.controlprogram.caching.MatrixObject`	`toMatrixObject()` Obtain the matrix as a SystemML MatrixObject.
`org.apache.spark.rdd.RDD<String>`	`toRDDStringCSV()` Obtain the matrix as a `RDD<String>` in CSV format
`org.apache.spark.rdd.RDD<String>`	`toRDDStringIJV()` Obtain the matrix as a `RDD<String>` in IJV format
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Matrix
```
public Matrix(org.apache.sysml.runtime.controlprogram.caching.MatrixObject matrixObject,
              org.apache.sysml.runtime.controlprogram.context.SparkExecutionContext sparkExecutionContext)
```
- Method Detail
  - toMatrixObject
```
public org.apache.sysml.runtime.controlprogram.caching.MatrixObject toMatrixObject()
```
    Obtain the matrix as a SystemML MatrixObject.
    
    Returns:
    
    the matrix as a SystemML MatrixObject
  - to2DDoubleArray
```
public double[][] to2DDoubleArray()
```
    Obtain the matrix as a two-dimensional double array
    
    Returns:
    
    the matrix as a two-dimensional double array
  - toJavaRDDStringIJV
```
public org.apache.spark.api.java.JavaRDD<String> toJavaRDDStringIJV()
```
    Obtain the matrix as a JavaRDD<String> in IJV format
    
    Returns:
    
    the matrix as a JavaRDD<String> in IJV format
  - toJavaRDDStringCSV
```
public org.apache.spark.api.java.JavaRDD<String> toJavaRDDStringCSV()
```
    Obtain the matrix as a JavaRDD<String> in CSV format
    
    Returns:
    
    the matrix as a JavaRDD<String> in CSV format
  - toRDDStringCSV
```
public org.apache.spark.rdd.RDD<String> toRDDStringCSV()
```
    Obtain the matrix as a RDD<String> in CSV format
    
    Returns:
    
    the matrix as a RDD<String> in CSV format
  - toRDDStringIJV
```
public org.apache.spark.rdd.RDD<String> toRDDStringIJV()
```
    Obtain the matrix as a RDD<String> in IJV format
    
    Returns:
    
    the matrix as a RDD<String> in IJV format
  - toDF
```
public org.apache.spark.sql.Dataset<org.apache.spark.sql.Row> toDF()
```
    Obtain the matrix as a DataFrame of doubles with an ID column
    
    Returns:
    
    the matrix as a DataFrame of doubles with an ID column
  - toDFDoubleWithIDColumn
```
public org.apache.spark.sql.Dataset<org.apache.spark.sql.Row> toDFDoubleWithIDColumn()
```
    Obtain the matrix as a DataFrame of doubles with an ID column
    
    Returns:
    
    the matrix as a DataFrame of doubles with an ID column
  - toDFDoubleNoIDColumn
```
public org.apache.spark.sql.Dataset<org.apache.spark.sql.Row> toDFDoubleNoIDColumn()
```
    Obtain the matrix as a DataFrame of doubles with no ID column
    
    Returns:
    
    the matrix as a DataFrame of doubles with no ID column
  - toDFVectorWithIDColumn
```
public org.apache.spark.sql.Dataset<org.apache.spark.sql.Row> toDFVectorWithIDColumn()
```
    Obtain the matrix as a DataFrame of vectors with an ID column
    
    Returns:
    
    the matrix as a DataFrame of vectors with an ID column
  - toDFVectorNoIDColumn
```
public org.apache.spark.sql.Dataset<org.apache.spark.sql.Row> toDFVectorNoIDColumn()
```
    Obtain the matrix as a DataFrame of vectors with no ID column
    
    Returns:
    
    the matrix as a DataFrame of vectors with no ID column
  - toBinaryBlockMatrix
```
public BinaryBlockMatrix toBinaryBlockMatrix()
```
    Obtain the matrix as a BinaryBlockMatrix
    
    Returns:
    
    the matrix as a BinaryBlockMatrix
  - getMatrixMetadata
```
public MatrixMetadata getMatrixMetadata()
```
    Obtain the matrix metadata
    
    Returns:
    
    the matrix metadata
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Methods inherited from class java.lang.Object

Matrix

toMatrixObject

to2DDoubleArray

toJavaRDDStringIJV

toJavaRDDStringCSV

toRDDStringCSV

toRDDStringIJV

toDF

toDFDoubleWithIDColumn

toDFDoubleNoIDColumn

toDFVectorWithIDColumn

toDFVectorNoIDColumn

toBinaryBlockMatrix

getMatrixMetadata

toString