## Uses of Class
org.apache.sysds.api.mlcontext.MatrixMetadata

- Packages that use MatrixMetadata
  Package | Description
  --- | ---
  org.apache.sysds.api.mlcontext |

- - ### Uses of MatrixMetadata in org.apache.sysds.api.mlcontext

    Methods in org.apache.sysds.api.mlcontext that return MatrixMetadata
    Modifier and Type | Method and Description
    --- | ---
    `MatrixMetadata` | Matrix.`getMatrixMetadata()` Obtain the matrix metadata

    Methods in org.apache.sysds.api.mlcontext with parameters of type MatrixMetadata
    Modifier and Type | Method and Description
    --- | ---
    `static MatrixBlock` | MLContextConversionUtil.`binaryBlocksToMatrixBlock(org.apache.spark.api.java.JavaPairRDD<MatrixIndexes,MatrixBlock> binaryBlocks, MatrixMetadata matrixMetadata)` Convert a `JavaPairRDD<MatrixIndexes, MatrixBlock>` to a `MatrixBlock`
    `static MatrixObject` | MLContextConversionUtil.`binaryBlocksToMatrixObject(org.apache.spark.api.java.JavaPairRDD<MatrixIndexes,MatrixBlock> binaryBlocks, MatrixMetadata matrixMetadata)` Convert a `JavaPairRDD<MatrixIndexes, MatrixBlock>` to a `MatrixObject`.
    `static org.apache.spark.api.java.JavaPairRDD<MatrixIndexes,MatrixBlock>` | MLContextConversionUtil.`dataFrameToMatrixBinaryBlocks(org.apache.spark.sql.Dataset<org.apache.spark.sql.Row> dataFrame, MatrixMetadata matrixMetadata)` Convert a `DataFrame` to a `JavaPairRDD<MatrixIndexes, MatrixBlock>` binary-block matrix.
    `static MatrixObject` | MLContextConversionUtil.`dataFrameToMatrixObject(org.apache.spark.sql.Dataset<org.apache.spark.sql.Row> dataFrame, MatrixMetadata matrixMetadata)` Convert a `DataFrame` to a `MatrixObject`.
    `static void` | MLContextConversionUtil.`determineMatrixFormatIfNeeded(org.apache.spark.sql.Dataset<org.apache.spark.sql.Row> dataFrame, MatrixMetadata matrixMetadata)` If the MatrixFormat of the DataFrame has not been explicitly specified, attempt to determine the proper MatrixFormat.
    `static MatrixObject` | MLContextConversionUtil.`doubleMatrixToMatrixObject(String variableName, double[][] doubleMatrix, MatrixMetadata matrixMetadata)` Convert a two-dimensional double array to a `MatrixObject`.
    `static boolean` | MLContextConversionUtil.`isDataFrameWithIDColumn(MatrixMetadata matrixMetadata)` Return whether or not the DataFrame has an ID column.
    `static boolean` | MLContextConversionUtil.`isVectorBasedDataFrame(MatrixMetadata matrixMetadata)` Return whether or not the DataFrame is vector-based.
    `static MatrixObject` | MLContextConversionUtil.`javaRDDStringCSVToMatrixObject(org.apache.spark.api.java.JavaRDD<String> javaRDD, MatrixMetadata matrixMetadata)` Convert a `JavaRDD<String>` in CSV format to a `MatrixObject`
    `static MatrixObject` | MLContextConversionUtil.`javaRDDStringIJVToMatrixObject(org.apache.spark.api.java.JavaRDD<String> javaRDD, MatrixMetadata matrixMetadata)` Convert a `JavaRDD<String>` in IJV format to a `MatrixObject` .
    `static MatrixObject` | MLContextConversionUtil.`matrixBlockToMatrixObject(String variableName, MatrixBlock matrixBlock, MatrixMetadata matrixMetadata)` Convert a `MatrixBlock` to a `MatrixObject`.
    `static MatrixObject` | MLContextConversionUtil.`rddStringCSVToMatrixObject(org.apache.spark.rdd.RDD<String> rdd, MatrixMetadata matrixMetadata)` Convert a `RDD<String>` in CSV format to a `MatrixObject`
    `static MatrixObject` | MLContextConversionUtil.`rddStringIJVToMatrixObject(org.apache.spark.rdd.RDD<String> rdd, MatrixMetadata matrixMetadata)` Convert a `RDD<String>` in IJV format to a `MatrixObject`.
    `static MatrixObject` | MLContextConversionUtil.`urlToMatrixObject(URL url, MatrixMetadata matrixMetadata)` Convert a matrix at a URL to a `MatrixObject`.

    Constructors in org.apache.sysds.api.mlcontext with parameters of type MatrixMetadata
    Constructor and Description
    `Matrix(org.apache.spark.sql.Dataset<org.apache.spark.sql.Row> dataFrame, MatrixMetadata matrixMetadata)` Convert a Spark DataFrame to a SystemDS binary-block representation.
    `Matrix(org.apache.spark.api.java.JavaPairRDD<MatrixIndexes,MatrixBlock> binaryBlocks, MatrixMetadata matrixMetadata)` Create a Matrix, specifying the SystemDS binary-block matrix and its metadata.

Copyright © 2021 The Apache Software Foundation. All rights reserved.