org.apache.sysml.api.mlcontext

Class BinaryBlockFrame

java.lang.Object

org.apache.sysml.api.mlcontext.BinaryBlockFrame

public class BinaryBlockFrame
extends Object

BinaryBlockFrame stores data as a SystemML binary-block frame representation.

Constructor Summary

Constructors

Constructor and Description
BinaryBlockFrame(org.apache.spark.sql.Dataset<org.apache.spark.sql.Row> dataFrame) Convert a Spark DataFrame to a SystemML binary-block representation.
BinaryBlockFrame(org.apache.spark.sql.Dataset<org.apache.spark.sql.Row> dataFrame, FrameMetadata frameMetadata) Convert a Spark DataFrame to a SystemML binary-block representation.
BinaryBlockFrame(org.apache.spark.sql.Dataset<org.apache.spark.sql.Row> dataFrame, long numRows, long numCols) Convert a Spark DataFrame to a SystemML binary-block representation, specifying the number of rows and columns.
BinaryBlockFrame(org.apache.spark.api.java.JavaPairRDD<Long,FrameBlock> binaryBlocks, FrameMetadata frameMetadata) Create a BinaryBlockFrame, specifying the SystemML binary-block frame and its metadata.
BinaryBlockFrame(org.apache.spark.api.java.JavaPairRDD<Long,FrameBlock> binaryBlocks, MatrixCharacteristics matrixCharacteristics) Create a BinaryBlockFrame, specifying the SystemML binary-block frame and its metadata.

Method Summary

Modifier and Type	Method and Description
org.apache.spark.api.java.JavaPairRDD<Long,FrameBlock>	getBinaryBlocks() Obtain a SystemML binary-block frame as a JavaPairRDD<Long, FrameBlock>
FrameBlock	getFrameBlock() Obtain a SystemML binary-block frame as a FrameBlock
FrameMetadata	getFrameMetadata() Obtain the SystemML binary-block frame metadata
MatrixCharacteristics	getMatrixCharacteristics() Obtain the SystemML binary-block frame characteristics
void	setBinaryBlocks(org.apache.spark.api.java.JavaPairRDD<Long,FrameBlock> binaryBlocks) Set the SystemML binary-block frame as a JavaPairRDD<Long, FrameBlock>
void	setFrameMetadata(FrameMetadata frameMetadata) Set the SystemML binary-block frame metadata
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

BinaryBlockFrame

public BinaryBlockFrame(org.apache.spark.sql.Dataset<org.apache.spark.sql.Row> dataFrame,
                        FrameMetadata frameMetadata)

Convert a Spark DataFrame to a SystemML binary-block representation.

Parameters:

dataFrame - the Spark DataFrame

frameMetadata - frame metadata, such as number of rows and columns

BinaryBlockFrame

public BinaryBlockFrame(org.apache.spark.sql.Dataset<org.apache.spark.sql.Row> dataFrame,
                        long numRows,
                        long numCols)

Convert a Spark DataFrame to a SystemML binary-block representation, specifying the number of rows and columns.

Parameters:

dataFrame - the Spark DataFrame

numRows - the number of rows

numCols - the number of columns

BinaryBlockFrame

public BinaryBlockFrame(org.apache.spark.sql.Dataset<org.apache.spark.sql.Row> dataFrame)

Convert a Spark DataFrame to a SystemML binary-block representation.

Parameters:

dataFrame - the Spark DataFrame

BinaryBlockFrame

public BinaryBlockFrame(org.apache.spark.api.java.JavaPairRDD<Long,FrameBlock> binaryBlocks,
                        MatrixCharacteristics matrixCharacteristics)

Create a BinaryBlockFrame, specifying the SystemML binary-block frame and its metadata.

Parameters:

binaryBlocks - the JavaPairRDD<Long, FrameBlock> frame

matrixCharacteristics - the frame metadata as MatrixCharacteristics

BinaryBlockFrame

public BinaryBlockFrame(org.apache.spark.api.java.JavaPairRDD<Long,FrameBlock> binaryBlocks,
                        FrameMetadata frameMetadata)

Create a BinaryBlockFrame, specifying the SystemML binary-block frame and its metadata.

Parameters:

binaryBlocks - the JavaPairRDD<Long, FrameBlock> frame

frameMetadata - the frame metadata as FrameMetadata

Method Detail

getBinaryBlocks

public org.apache.spark.api.java.JavaPairRDD<Long,FrameBlock> getBinaryBlocks()

Obtain a SystemML binary-block frame as a JavaPairRDD<Long, FrameBlock>

Returns:

the SystemML binary-block frame

getFrameBlock

public FrameBlock getFrameBlock()

Obtain a SystemML binary-block frame as a FrameBlock

Returns:

the SystemML binary-block frame as a FrameBlock

getMatrixCharacteristics

public MatrixCharacteristics getMatrixCharacteristics()

Obtain the SystemML binary-block frame characteristics

Returns:

the frame metadata as MatrixCharacteristics

getFrameMetadata

public FrameMetadata getFrameMetadata()

Obtain the SystemML binary-block frame metadata

Returns:

the frame metadata as FrameMetadata

setFrameMetadata

public void setFrameMetadata(FrameMetadata frameMetadata)

Set the SystemML binary-block frame metadata

Parameters:

frameMetadata - the frame metadata

setBinaryBlocks

public void setBinaryBlocks(org.apache.spark.api.java.JavaPairRDD<Long,FrameBlock> binaryBlocks)

Set the SystemML binary-block frame as a JavaPairRDD<Long, FrameBlock>

Parameters:

binaryBlocks - the SystemML binary-block frame

toString

public String toString()

Overrides:

toString in class Object