Package org.apache.sysds.api.mlcontext
Class FrameMetadata
- java.lang.Object
- 
- org.apache.sysds.api.mlcontext.Metadata
- 
- org.apache.sysds.api.mlcontext.FrameMetadata
 
 
- 
 public class FrameMetadata extends Metadata Frame metadata, such as the number of rows, the number of columns, the number of non-zero values, the number of rows per block, and the number of columns per block in the frame.
- 
- 
Constructor SummaryConstructors Constructor Description FrameMetadata()FrameMetadata(int numRows, int numColumns)Constructor to create a FrameMetadata object based on the number of rows and the number of columns in a frame.FrameMetadata(int numRows, int numColumns, int numNonZeros)Constructor to create a FrameMetadata object based on the number of rows, the number of columns, and the number of non-zero values in a frame.FrameMetadata(int numRows, int numColumns, int numNonZeros, int blen)Constructor to create a FrameMetadata object based on the number of rows, the number of columns, the number of non-zero values, the number of rows per block, and the number of columns per block in a frame.FrameMetadata(Long numRows, Long numColumns)Constructor to create a FrameMetadata object based on the number of rows and the number of columns in a frame.FrameMetadata(Long numRows, Long numColumns, Integer blen)Constructor to create a FrameMetadata object based on the number of rows, the number of columns, the number of rows per block, and the number of columns per block in a frame.FrameMetadata(Long numRows, Long numColumns, Long numNonZeros)Constructor to create a FrameMetadata object based on the number of rows, the number of columns, and the number of non-zero values in a frame.FrameMetadata(Long numRows, Long numColumns, Long numNonZeros, Integer blen)Constructor to create a FrameMetadata object based on the number of rows, the number of columns, the number of non-zero values, the number of rows per block, and the number of columns per block in a frame.FrameMetadata(String schema)Constructor to create a FrameMetadata object based on a string representation of a frame schema.FrameMetadata(FrameFormat frameFormat)Constructor to create a FrameMetadata object based on frame format.FrameMetadata(FrameFormat frameFormat, int numRows, int numColumns)Constructor to create a FrameMetadata object based on frame format, the number of rows, and the number of columns in a frame.FrameMetadata(FrameFormat frameFormat, int numRows, int numColumns, int numNonZeros)Constructor to create a FrameMetadata object based on frame format, the number of rows, the number of columns, and the number of non-zero values in a frame.FrameMetadata(FrameFormat frameFormat, int numRows, int numColumns, int numNonZeros, int blen)Constructor to create a FrameMetadata object based on frame format, the number of rows, the number of columns, the number of non-zero values, the number of rows per block, and the number of columns per block in a frame.FrameMetadata(FrameFormat frameFormat, Long numRows, Long numColumns)Constructor to create a FrameMetadata object based on frame format, the number of rows, and the number of columns in a frame.FrameMetadata(FrameFormat frameFormat, Long numRows, Long numColumns, Long numNonZeros)Constructor to create a FrameMetadata object based on frame format, the number of rows, the number of columns, and the number of non-zero values in a frame.FrameMetadata(FrameFormat frameFormat, Long numRows, Long numColumns, Long numNonZeros, Integer blen)Constructor to create a FrameMetadata object based on frame format, the number of rows, the number of columns, the number of non-zero values, the number of rows per block, and the number of columns per block in a frame.FrameMetadata(FrameFormat frameFormat, FrameSchema frameSchema)Constructor to create a FrameMetadata object based on frame format and frame schema.FrameMetadata(FrameFormat frameFormat, FrameSchema frameSchema, int numRows, int numColumns)Constructor to create a FrameMetadata object based on frame format, frame schema, the number of rows, and the number of columns in a frame.FrameMetadata(FrameFormat frameFormat, FrameSchema frameSchema, int numRows, int numColumns, int numNonZeros, int blen)Constructor to create a FrameMetadata object based on frame format, frame schema, the number of rows, the number of columns, the number of non-zero values, the number of rows per block, and the number of columns per block in a frame.FrameMetadata(FrameFormat frameFormat, FrameSchema frameSchema, Long numRows, Long numColumns)Constructor to create a FrameMetadata object based on frame format, frame schema, the number of rows, and the number of columns in a frame.FrameMetadata(FrameFormat frameFormat, FrameSchema frameSchema, Long numRows, Long numColumns, Long numNonZeros, Integer blen)Constructor to create a FrameMetadata object based on frame format, frame schema, the number of rows, the number of columns, the number of non-zero values, the number of rows per block, and the number of columns per block in a frame.FrameMetadata(FrameSchema frameSchema)Constructor to create a FrameMetadata object based on frame schema.FrameMetadata(FrameSchema frameSchema, MatrixCharacteristics matrixCharacteristics)Constructor to create a FrameMetadata object based on the frame schema and a DataCharacteristics object.FrameMetadata(DataCharacteristics dataCharacteristics)Constructor to create a FrameMetadata object based on a DataCharacteristics object.
 - 
Method SummaryAll Methods Instance Methods Concrete Methods Modifier and Type Method Description FrameFormatgetFrameFormat()Obtain the frame formatFrameSchemagetFrameSchema()Obtain the frame schemavoidsetFrameFormat(FrameFormat frameFormat)Set the frame formatvoidsetFrameSchema(FrameSchema frameSchema)Set the frame schemavoidsetMatrixCharacteristics(MatrixCharacteristics matrixCharacteristics)Set the FrameMetadata fields based on a DataCharacteristics object.- 
Methods inherited from class org.apache.sysds.api.mlcontext.MetadataasMatrixCharacteristics, getBlocksize, getNumColumns, getNumNonZeros, getNumRows, setBlocksize, setNumColumns, setNumNonZeros, setNumRows, toString
 
- 
 
- 
- 
- 
Constructor Detail- 
FrameMetadatapublic FrameMetadata() 
 - 
FrameMetadatapublic FrameMetadata(String schema) Constructor to create a FrameMetadata object based on a string representation of a frame schema.- Parameters:
- schema- String representation of the frame schema.
 
 - 
FrameMetadatapublic FrameMetadata(FrameFormat frameFormat) Constructor to create a FrameMetadata object based on frame format.- Parameters:
- frameFormat- The frame format.
 
 - 
FrameMetadatapublic FrameMetadata(FrameSchema frameSchema) Constructor to create a FrameMetadata object based on frame schema.- Parameters:
- frameSchema- The frame schema.
 
 - 
FrameMetadatapublic FrameMetadata(FrameFormat frameFormat, FrameSchema frameSchema) Constructor to create a FrameMetadata object based on frame format and frame schema.- Parameters:
- frameFormat- The frame format.
- frameSchema- The frame schema.
 
 - 
FrameMetadatapublic FrameMetadata(FrameFormat frameFormat, FrameSchema frameSchema, Long numRows, Long numColumns) Constructor to create a FrameMetadata object based on frame format, frame schema, the number of rows, and the number of columns in a frame.- Parameters:
- frameFormat- The frame format.
- frameSchema- The frame schema.
- numRows- The number of rows in the frame.
- numColumns- The number of columns in the frame.
 
 - 
FrameMetadatapublic FrameMetadata(FrameFormat frameFormat, FrameSchema frameSchema, int numRows, int numColumns) Constructor to create a FrameMetadata object based on frame format, frame schema, the number of rows, and the number of columns in a frame.- Parameters:
- frameFormat- The frame format.
- frameSchema- The frame schema.
- numRows- The number of rows in the frame.
- numColumns- The number of columns in the frame.
 
 - 
FrameMetadatapublic FrameMetadata(FrameFormat frameFormat, FrameSchema frameSchema, Long numRows, Long numColumns, Long numNonZeros, Integer blen) Constructor to create a FrameMetadata object based on frame format, frame schema, the number of rows, the number of columns, the number of non-zero values, the number of rows per block, and the number of columns per block in a frame.- Parameters:
- frameFormat- The frame format.
- frameSchema- The frame schema.
- numRows- The number of rows in the frame.
- numColumns- The number of columns in the frame.
- numNonZeros- The number of non-zero values in the frame.
- blen- The number of rows/cols per block in the frame.
 
 - 
FrameMetadatapublic FrameMetadata(FrameFormat frameFormat, FrameSchema frameSchema, int numRows, int numColumns, int numNonZeros, int blen) Constructor to create a FrameMetadata object based on frame format, frame schema, the number of rows, the number of columns, the number of non-zero values, the number of rows per block, and the number of columns per block in a frame.- Parameters:
- frameFormat- The frame format.
- frameSchema- The frame schema.
- numRows- The number of rows in the frame.
- numColumns- The number of columns in the frame.
- numNonZeros- The number of non-zero values in the frame.
- blen- The number of rows/cols per block in the frame.
 
 - 
FrameMetadatapublic FrameMetadata(FrameFormat frameFormat, Long numRows, Long numColumns) Constructor to create a FrameMetadata object based on frame format, the number of rows, and the number of columns in a frame.- Parameters:
- frameFormat- The frame format.
- numRows- The number of rows in the frame.
- numColumns- The number of columns in the frame.
 
 - 
FrameMetadatapublic FrameMetadata(FrameFormat frameFormat, int numRows, int numColumns) Constructor to create a FrameMetadata object based on frame format, the number of rows, and the number of columns in a frame.- Parameters:
- frameFormat- The frame format.
- numRows- The number of rows in the frame.
- numColumns- The number of columns in the frame.
 
 - 
FrameMetadatapublic FrameMetadata(FrameFormat frameFormat, Long numRows, Long numColumns, Long numNonZeros) Constructor to create a FrameMetadata object based on frame format, the number of rows, the number of columns, and the number of non-zero values in a frame.- Parameters:
- frameFormat- The frame format.
- numRows- The number of rows in the frame.
- numColumns- The number of columns in the frame.
- numNonZeros- The number of non-zero values in the frame.
 
 - 
FrameMetadatapublic FrameMetadata(FrameFormat frameFormat, int numRows, int numColumns, int numNonZeros) Constructor to create a FrameMetadata object based on frame format, the number of rows, the number of columns, and the number of non-zero values in a frame.- Parameters:
- frameFormat- The frame format.
- numRows- The number of rows in the frame.
- numColumns- The number of columns in the frame.
- numNonZeros- The number of non-zero values in the frame.
 
 - 
FrameMetadatapublic FrameMetadata(FrameFormat frameFormat, Long numRows, Long numColumns, Long numNonZeros, Integer blen) Constructor to create a FrameMetadata object based on frame format, the number of rows, the number of columns, the number of non-zero values, the number of rows per block, and the number of columns per block in a frame.- Parameters:
- frameFormat- The frame format.
- numRows- The number of rows in the frame.
- numColumns- The number of columns in the frame.
- numNonZeros- The number of non-zero values in the frame.
- blen- The number of rows/cols per block in the frame.
 
 - 
FrameMetadatapublic FrameMetadata(FrameFormat frameFormat, int numRows, int numColumns, int numNonZeros, int blen) Constructor to create a FrameMetadata object based on frame format, the number of rows, the number of columns, the number of non-zero values, the number of rows per block, and the number of columns per block in a frame.- Parameters:
- frameFormat- The frame format.
- numRows- The number of rows in the frame.
- numColumns- The number of columns in the frame.
- numNonZeros- The number of non-zero values in the frame.
- blen- The number of rows/cols per block in the frame.
 
 - 
FrameMetadatapublic FrameMetadata(Long numRows, Long numColumns) Constructor to create a FrameMetadata object based on the number of rows and the number of columns in a frame.- Parameters:
- numRows- The number of rows in the frame.
- numColumns- The number of columns in the frame.
 
 - 
FrameMetadatapublic FrameMetadata(int numRows, int numColumns)Constructor to create a FrameMetadata object based on the number of rows and the number of columns in a frame.- Parameters:
- numRows- The number of rows in the frame.
- numColumns- The number of columns in the frame.
 
 - 
FrameMetadatapublic FrameMetadata(Long numRows, Long numColumns, Long numNonZeros) Constructor to create a FrameMetadata object based on the number of rows, the number of columns, and the number of non-zero values in a frame.- Parameters:
- numRows- The number of rows in the frame.
- numColumns- The number of columns in the frame.
- numNonZeros- The number of non-zero values in the frame.
 
 - 
FrameMetadatapublic FrameMetadata(int numRows, int numColumns, int numNonZeros)Constructor to create a FrameMetadata object based on the number of rows, the number of columns, and the number of non-zero values in a frame.- Parameters:
- numRows- The number of rows in the frame.
- numColumns- The number of columns in the frame.
- numNonZeros- The number of non-zero values in the frame.
 
 - 
FrameMetadatapublic FrameMetadata(Long numRows, Long numColumns, Integer blen) Constructor to create a FrameMetadata object based on the number of rows, the number of columns, the number of rows per block, and the number of columns per block in a frame.- Parameters:
- numRows- The number of rows in the frame.
- numColumns- The number of columns in the frame.
- blen- The number of rows/cols per block in the frame.
 
 - 
FrameMetadatapublic FrameMetadata(Long numRows, Long numColumns, Long numNonZeros, Integer blen) Constructor to create a FrameMetadata object based on the number of rows, the number of columns, the number of non-zero values, the number of rows per block, and the number of columns per block in a frame.- Parameters:
- numRows- The number of rows in the frame.
- numColumns- The number of columns in the frame.
- numNonZeros- The number of non-zero values in the frame.
- blen- The number of rows/cols per block in the frame.
 
 - 
FrameMetadatapublic FrameMetadata(int numRows, int numColumns, int numNonZeros, int blen)Constructor to create a FrameMetadata object based on the number of rows, the number of columns, the number of non-zero values, the number of rows per block, and the number of columns per block in a frame.- Parameters:
- numRows- The number of rows in the frame.
- numColumns- The number of columns in the frame.
- numNonZeros- The number of non-zero values in the frame.
- blen- The number of rows/cols per block in the frame.
 
 - 
FrameMetadatapublic FrameMetadata(DataCharacteristics dataCharacteristics) Constructor to create a FrameMetadata object based on a DataCharacteristics object.- Parameters:
- dataCharacteristics- the frame metadata as a DataCharacteristics object
 
 - 
FrameMetadatapublic FrameMetadata(FrameSchema frameSchema, MatrixCharacteristics matrixCharacteristics) Constructor to create a FrameMetadata object based on the frame schema and a DataCharacteristics object.- Parameters:
- frameSchema- The frame schema.
- matrixCharacteristics- the frame metadata as a DataCharacteristics object
 
 
- 
 - 
Method Detail- 
setMatrixCharacteristicspublic void setMatrixCharacteristics(MatrixCharacteristics matrixCharacteristics) Set the FrameMetadata fields based on a DataCharacteristics object.- Overrides:
- setMatrixCharacteristicsin class- Metadata
- Parameters:
- matrixCharacteristics- the frame metadata as a DataCharacteristics object
 
 - 
getFrameFormatpublic FrameFormat getFrameFormat() Obtain the frame format- Returns:
- the frame format
 
 - 
setFrameFormatpublic void setFrameFormat(FrameFormat frameFormat) Set the frame format- Parameters:
- frameFormat- the frame format
 
 - 
getFrameSchemapublic FrameSchema getFrameSchema() Obtain the frame schema- Returns:
- the frame schema
 
 - 
setFrameSchemapublic void setFrameSchema(FrameSchema frameSchema) Set the frame schema- Parameters:
- frameSchema- the frame schema
 
 
- 
 
-