org.apache.sysml.api.mlcontext

Class 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 Summary

      Constructors 
      Constructor and Description
      FrameMetadata() 
      FrameMetadata(FrameFormat frameFormat)
      Constructor to create a FrameMetadata object based on frame format.
      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 numRowsPerBlock, int numColumnsPerBlock)
      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 numRowsPerBlock, Integer numColumnsPerBlock)
      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, 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 numRowsPerBlock, int numColumnsPerBlock)
      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 numRowsPerBlock, Integer numColumnsPerBlock)
      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(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 MatrixCharacteristics object.
      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 numRowsPerBlock, int numColumnsPerBlock)
      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(int numRows, int numColumns, int numNonZeros, int numRowsPerBlock, int numColumnsPerBlock)
      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 numRowsPerBlock, Integer numColumnsPerBlock)
      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 numRowsPerBlock, Integer numColumnsPerBlock)
      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(MatrixCharacteristics matrixCharacteristics)
      Constructor to create a FrameMetadata object based on a MatrixCharacteristics object.
      FrameMetadata(String schema)
      Constructor to create a FrameMetadata object based on a string representation of a frame schema.
    • Constructor Detail

      • FrameMetadata

        public FrameMetadata()
      • FrameMetadata

        public 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.
      • FrameMetadata

        public FrameMetadata(FrameFormat frameFormat)
        Constructor to create a FrameMetadata object based on frame format.
        Parameters:
        frameFormat - The frame format.
      • FrameMetadata

        public FrameMetadata(FrameSchema frameSchema)
        Constructor to create a FrameMetadata object based on frame schema.
        Parameters:
        frameSchema - The frame schema.
      • FrameMetadata

        public 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.
      • FrameMetadata

        public 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.
      • FrameMetadata

        public 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.
      • FrameMetadata

        public FrameMetadata(FrameFormat frameFormat,
                             FrameSchema frameSchema,
                             Long numRows,
                             Long numColumns,
                             Long numNonZeros,
                             Integer numRowsPerBlock,
                             Integer numColumnsPerBlock)
        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.
        numRowsPerBlock - The number of rows per block in the frame.
        numColumnsPerBlock - The number of columns per block in the frame.
      • FrameMetadata

        public FrameMetadata(FrameFormat frameFormat,
                             FrameSchema frameSchema,
                             int numRows,
                             int numColumns,
                             int numNonZeros,
                             int numRowsPerBlock,
                             int numColumnsPerBlock)
        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.
        numRowsPerBlock - The number of rows per block in the frame.
        numColumnsPerBlock - The number of columns per block in the frame.
      • FrameMetadata

        public 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.
      • FrameMetadata

        public 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.
      • FrameMetadata

        public 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.
      • FrameMetadata

        public 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.
      • FrameMetadata

        public FrameMetadata(FrameFormat frameFormat,
                             Long numRows,
                             Long numColumns,
                             Long numNonZeros,
                             Integer numRowsPerBlock,
                             Integer numColumnsPerBlock)
        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.
        numRowsPerBlock - The number of rows per block in the frame.
        numColumnsPerBlock - The number of columns per block in the frame.
      • FrameMetadata

        public FrameMetadata(FrameFormat frameFormat,
                             int numRows,
                             int numColumns,
                             int numNonZeros,
                             int numRowsPerBlock,
                             int numColumnsPerBlock)
        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.
        numRowsPerBlock - The number of rows per block in the frame.
        numColumnsPerBlock - The number of columns per block in the frame.
      • FrameMetadata

        public 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.
      • FrameMetadata

        public 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.
      • FrameMetadata

        public 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.
      • FrameMetadata

        public 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.
      • FrameMetadata

        public FrameMetadata(Long numRows,
                             Long numColumns,
                             Integer numRowsPerBlock,
                             Integer numColumnsPerBlock)
        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.
        numRowsPerBlock - The number of rows per block in the frame.
        numColumnsPerBlock - The number of columns per block in the frame.
      • FrameMetadata

        public FrameMetadata(int numRows,
                             int numColumns,
                             int numRowsPerBlock,
                             int numColumnsPerBlock)
        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.
        numRowsPerBlock - The number of rows per block in the frame.
        numColumnsPerBlock - The number of columns per block in the frame.
      • FrameMetadata

        public FrameMetadata(Long numRows,
                             Long numColumns,
                             Long numNonZeros,
                             Integer numRowsPerBlock,
                             Integer numColumnsPerBlock)
        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.
        numRowsPerBlock - The number of rows per block in the frame.
        numColumnsPerBlock - The number of columns per block in the frame.
      • FrameMetadata

        public FrameMetadata(int numRows,
                             int numColumns,
                             int numNonZeros,
                             int numRowsPerBlock,
                             int numColumnsPerBlock)
        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.
        numRowsPerBlock - The number of rows per block in the frame.
        numColumnsPerBlock - The number of columns per block in the frame.
      • FrameMetadata

        public FrameMetadata(MatrixCharacteristics matrixCharacteristics)
        Constructor to create a FrameMetadata object based on a MatrixCharacteristics object.
        Parameters:
        matrixCharacteristics - the frame metadata as a MatrixCharacteristics object
      • FrameMetadata

        public FrameMetadata(FrameSchema frameSchema,
                             MatrixCharacteristics matrixCharacteristics)
        Constructor to create a FrameMetadata object based on the frame schema and a MatrixCharacteristics object.
        Parameters:
        frameSchema - The frame schema.
        matrixCharacteristics - the frame metadata as a MatrixCharacteristics object
    • Method Detail

      • setMatrixCharacteristics

        public void setMatrixCharacteristics(MatrixCharacteristics matrixCharacteristics)
        Set the FrameMetadata fields based on a MatrixCharacteristics object.
        Parameters:
        matrixCharacteristics - the frame metadata as a MatrixCharacteristics object
      • getNumRows

        public Long getNumRows()
        Obtain the number of rows
        Returns:
        the number of rows
      • setNumRows

        public void setNumRows(Long numRows)
        Set the number of rows
        Parameters:
        numRows - the number of rows
      • getNumColumns

        public Long getNumColumns()
        Obtain the number of columns
        Returns:
        the number of columns
      • setNumColumns

        public void setNumColumns(Long numColumns)
        Set the number of columns
        Parameters:
        numColumns - the number of columns
      • getNumNonZeros

        public Long getNumNonZeros()
        Obtain the number of non-zero values
        Returns:
        the number of non-zero values
      • setNumNonZeros

        public void setNumNonZeros(Long numNonZeros)
        Set the number of non-zero values
        Parameters:
        numNonZeros - the number of non-zero values
      • getNumRowsPerBlock

        public Integer getNumRowsPerBlock()
        Obtain the number of rows per block
        Returns:
        the number of rows per block
      • setNumRowsPerBlock

        public void setNumRowsPerBlock(Integer numRowsPerBlock)
        Set the number of rows per block
        Parameters:
        numRowsPerBlock - the number of rows per block
      • getNumColumnsPerBlock

        public Integer getNumColumnsPerBlock()
        Obtain the number of columns per block
        Returns:
        the number of columns per block
      • setNumColumnsPerBlock

        public void setNumColumnsPerBlock(Integer numColumnsPerBlock)
        Set the number of columns per block
        Parameters:
        numColumnsPerBlock - the number of columns per block
      • asMatrixCharacteristics

        public MatrixCharacteristics asMatrixCharacteristics()
        Convert the frame metadata to a MatrixCharacteristics object. If all field values are null, null is returned.
        Returns:
        the frame metadata as a MatrixCharacteristics object, or null if all field values are null
      • getFrameFormat

        public FrameFormat getFrameFormat()
        Obtain the frame format
        Returns:
        the frame format
      • setFrameFormat

        public void setFrameFormat(FrameFormat frameFormat)
        Set the frame format
        Parameters:
        frameFormat - the frame format
      • getFrameSchema

        public FrameSchema getFrameSchema()
        Obtain the frame schema
        Returns:
        the frame schema
      • setFrameSchema

        public void setFrameSchema(FrameSchema frameSchema)
        Set the frame schema
        Parameters:
        frameSchema - the frame schema

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