org.apache.sysml.api.mlcontext

Class Metadata

  • Direct Known Subclasses:
    FrameMetadata, MatrixMetadata


    public abstract class Metadata
    extends Object
    Abstract metadata class for MLContext API. Complex types such as SystemML matrices and frames typically require metadata, so this abstract class serves as a common parent class of these types.
    • Field Detail

      • numColumns

        protected Long numColumns
      • numColumnsPerBlock

        protected Integer numColumnsPerBlock
      • numNonZeros

        protected Long numNonZeros
      • numRows

        protected Long numRows
      • numRowsPerBlock

        protected Integer numRowsPerBlock
    • Constructor Detail

      • Metadata

        public Metadata()
    • Method Detail

      • asMatrixCharacteristics

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

        protected String fieldDisplay(Object field)
      • getNumColumns

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

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

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

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

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

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

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

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

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

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

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

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