Package org.ejml.ops

Class MatrixIO

  • public class MatrixIO
extends java.lang.Object
    Provides simple to use routines for reading and writing matrices to and from files.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String DEFAULT_FLOAT_FORMAT
      Default printf float format
      static int DEFAULT_LENGTH
      Number of digits in pretty format
      static java.lang.String MATLAB_FORMAT
      Specified the printf format used when printing out in Matlab format

    • Constructor Summary

      Constructors 
      Constructor Description
      MatrixIO()  

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static <T extends DMatrix>
      T      		 loadBin​(java.lang.String fileName)
      Loads a DMatrix which has been saved to file using Java binary serialization.
      static <T extends DMatrix>
      T      		 loadCSV​(java.lang.String fileName, boolean doublePrecision)
      Reads a matrix in which has been encoded using a Column Space Value (CSV) file format.
      static DMatrixRMaj loadCSV​(java.lang.String fileName, int numRows, int numCols)
      Reads a matrix in which has been encoded using a Column Space Value (CSV) file format.
      static DMatrixSparseTriplet loadMatrixMarketD​(java.io.Reader reader)
      Reads a stream in Matrix Market Coordinate format https://math.nist.gov/MatrixMarket/formats.html
      static FMatrixSparseTriplet loadMatrixMarketF​(java.io.InputStream streamIn)
      Reads a stream in Matrix Market Coordinate format https://math.nist.gov/MatrixMarket/formats.html
      static FMatrixSparseTriplet loadMatrixMarketF​(java.io.Reader reader)
      Reads a stream in Matrix Market Coordinate format https://math.nist.gov/MatrixMarket/formats.html
      static DMatrixRMaj matlabToDDRM​(java.lang.String text)
      Converts a text string in matlab format into a DDRM matrix
      static FMatrixRMaj matlabToFDRM​(java.lang.String text)
      Converts a text string in matlab format into a DDRM matrix
      static void print​(java.io.PrintStream out, CMatrix mat, java.lang.String format)  
      static void print​(java.io.PrintStream out, DMatrix mat)  
      static void print​(java.io.PrintStream out, DMatrix mat, java.lang.String format)
      Prints the matrix out in a text format.
      static void print​(java.io.PrintStream out, DMatrix mat, java.lang.String format, int row0, int row1, int col0, int col1)  
      static void print​(java.io.PrintStream out, DMatrixSparseCSC m, java.lang.String format)
      Prints the matrix out in a text format.
      static void print​(java.io.PrintStream out, DMatrixSparseTriplet m, java.lang.String format)  
      static void print​(java.io.PrintStream out, FMatrix mat)  
      static void print​(java.io.PrintStream out, FMatrix mat, java.lang.String format)  
      static void print​(java.io.PrintStream out, FMatrix mat, java.lang.String format, int row0, int row1, int col0, int col1)  
      static void print​(java.io.PrintStream out, FMatrixSparseCSC m, java.lang.String format)  
      static void print​(java.io.PrintStream out, FMatrixSparseTriplet m, java.lang.String format)  
      static void print​(java.io.PrintStream out, Matrix mat)  
      static void print​(java.io.PrintStream out, ZMatrix mat, java.lang.String format)  
      static void printFancy​(java.io.PrintStream out, CMatrix mat, int length)  
      static void printFancy​(java.io.PrintStream out, DMatrix mat, int length)  
      static void printFancy​(java.io.PrintStream out, DMatrixSparseCSC m, int length)  
      static void printFancy​(java.io.PrintStream out, FMatrix mat, int length)  
      static void printFancy​(java.io.PrintStream out, ZMatrix mat, int length)  
      static void printJava​(java.io.PrintStream out, DMatrix mat, java.lang.String format)  
      static void printJava​(java.io.PrintStream out, FMatrix mat, java.lang.String format)  
      static void printMatlab​(java.io.PrintStream out, DMatrix mat)  
      static void printMatlab​(java.io.PrintStream out, FMatrix mat)  
      static void saveBin​(DMatrix A, java.lang.String fileName)
      Saves a matrix to disk using Java binary serialization.
      static void saveDenseCSV​(DMatrix A, java.lang.String fileName)
      Saves a matrix to disk using in a Column Space Value (CSV) format.
      static void saveMatrixMarketD​(DMatrixSparse matrix, java.lang.String floatFormat, java.io.Writer writer)
      Writes a stream using the Matrix Market Coordinate format.
      static void saveMatrixMarketF​(FMatrixSparse matrix, java.lang.String floatFormat, java.io.Writer writer)
      Writes a stream using the Matrix Market Coordinate format.
      static void saveSparseCSV​(DMatrixSparseTriplet A, java.lang.String fileName)
      Saves a matrix to disk using in a Column Space Value (CSV) format.
      static void saveSparseCSV​(FMatrixSparseTriplet A, java.lang.String fileName)
      Saves a matrix to disk using in a Column Space Value (CSV) format.

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • DEFAULT_FLOAT_FORMAT

        public static final java.lang.String DEFAULT_FLOAT_FORMAT
        Default printf float format
        See Also:
        Constant Field Values

      • DEFAULT_LENGTH

        public static final int DEFAULT_LENGTH
        Number of digits in pretty format
        See Also:
        Constant Field Values

      • MATLAB_FORMAT

        public static java.lang.String MATLAB_FORMAT
        Specified the printf format used when printing out in Matlab format

    • Constructor Detail

      • MatrixIO

        public MatrixIO()

    • Method Detail

      • matlabToDDRM

        public static DMatrixRMaj matlabToDDRM​(java.lang.String text)
        Converts a text string in matlab format into a DDRM matrix

      • matlabToFDRM

        public static FMatrixRMaj matlabToFDRM​(java.lang.String text)
        Converts a text string in matlab format into a DDRM matrix

      • saveMatrixMarketD

        public static void saveMatrixMarketD​(DMatrixSparse matrix,
                                     java.lang.String floatFormat,
                                     java.io.Writer writer)
        Writes a stream using the Matrix Market Coordinate format. https://math.nist.gov/MatrixMarket/formats.html
        Parameters:
        matrix - The matrix to be written
        floatFormat - The format used by printf. "%.4e" is suggested
        writer - The writer

      • saveMatrixMarketF

        public static void saveMatrixMarketF​(FMatrixSparse matrix,
                                     java.lang.String floatFormat,
                                     java.io.Writer writer)
        Writes a stream using the Matrix Market Coordinate format. https://math.nist.gov/MatrixMarket/formats.html
        Parameters:
        matrix - The matrix to be written
        floatFormat - The format used by printf. "%.4e" is suggested
        writer - The writer

      • loadMatrixMarketD

        public static DMatrixSparseTriplet loadMatrixMarketD​(java.io.Reader reader)
        Reads a stream in Matrix Market Coordinate format https://math.nist.gov/MatrixMarket/formats.html
        Parameters:
        reader - Input reader
        Returns:
        Matrix in triplet format

      • loadMatrixMarketF

        public static FMatrixSparseTriplet loadMatrixMarketF​(java.io.Reader reader)
        Reads a stream in Matrix Market Coordinate format https://math.nist.gov/MatrixMarket/formats.html
        Parameters:
        reader - Input reader
        Returns:
        Matrix in triplet format

      • loadMatrixMarketF

        public static FMatrixSparseTriplet loadMatrixMarketF​(java.io.InputStream streamIn)
        Reads a stream in Matrix Market Coordinate format https://math.nist.gov/MatrixMarket/formats.html
        Parameters:
        streamIn - Input stream
        Returns:
        Matrix in triplet format

      • saveBin

        public static void saveBin​(DMatrix A,
                           java.lang.String fileName)
                    throws java.io.IOException
        Saves a matrix to disk using Java binary serialization.
        Parameters:
        A - The matrix being saved.
        fileName - Name of the file its being saved at.
        Throws:
        java.io.IOException

      • loadBin

        public static <T extends DMatrix> T loadBin​(java.lang.String fileName)
                                     throws java.io.IOException
        Loads a DMatrix which has been saved to file using Java binary serialization.
        Parameters:
        fileName - The file being loaded.
        Returns:
        DMatrixRMaj
        Throws:
        java.io.IOException

      • saveDenseCSV

        public static void saveDenseCSV​(DMatrix A,
                                java.lang.String fileName)
                         throws java.io.IOException
        Saves a matrix to disk using in a Column Space Value (CSV) format. For a description of the format see loadCSV(String,boolean).
        Parameters:
        A - The matrix being saved.
        fileName - Name of the file its being saved at.
        Throws:
        java.io.IOException

      • saveSparseCSV

        public static void saveSparseCSV​(DMatrixSparseTriplet A,
                                 java.lang.String fileName)
                          throws java.io.IOException
        Saves a matrix to disk using in a Column Space Value (CSV) format. For a description of the format see loadCSV(String,boolean).
        Parameters:
        A - The matrix being saved.
        fileName - Name of the file its being saved at.
        Throws:
        java.io.IOException

      • saveSparseCSV

        public static void saveSparseCSV​(FMatrixSparseTriplet A,
                                 java.lang.String fileName)
                          throws java.io.IOException
        Saves a matrix to disk using in a Column Space Value (CSV) format. For a description of the format see loadCSV(String,boolean).
        Parameters:
        A - The matrix being saved.
        fileName - Name of the file its being saved at.
        Throws:
        java.io.IOException

      • loadCSV

        public static <T extends DMatrix> T loadCSV​(java.lang.String fileName,
                                            boolean doublePrecision)
                                     throws java.io.IOException
        Reads a matrix in which has been encoded using a Column Space Value (CSV) file format. The number of rows and columns are read in on the first line. Then each row is read in the subsequent lines. Works with dense and sparse matrices.
        Parameters:
        fileName - The file being loaded.
        Returns:
        DMatrix
        Throws:
        java.io.IOException

      • loadCSV

        public static DMatrixRMaj loadCSV​(java.lang.String fileName,
                                  int numRows,
                                  int numCols)
                           throws java.io.IOException
        Reads a matrix in which has been encoded using a Column Space Value (CSV) file format. For a description of the format see loadCSV(String,boolean).
        Parameters:
        fileName - The file being loaded.
        numRows - number of rows in the matrix.
        numCols - number of columns in the matrix.
        Returns:
        DMatrixRMaj
        Throws:
        java.io.IOException

      • printFancy

        public static void printFancy​(java.io.PrintStream out,
                              DMatrix mat,
                              int length)

      • printFancy

        public static void printFancy​(java.io.PrintStream out,
                              FMatrix mat,
                              int length)

      • printFancy

        public static void printFancy​(java.io.PrintStream out,
                              ZMatrix mat,
                              int length)

      • printFancy

        public static void printFancy​(java.io.PrintStream out,
                              CMatrix mat,
                              int length)

      • printFancy

        public static void printFancy​(java.io.PrintStream out,
                              DMatrixSparseCSC m,
                              int length)

      • print

        public static void print​(java.io.PrintStream out,
                         Matrix mat)

      • print

        public static void print​(java.io.PrintStream out,
                         DMatrix mat)

      • print

        public static void print​(java.io.PrintStream out,
                         DMatrix mat,
                         java.lang.String format)
        Prints the matrix out in a text format. The format is specified using notation from String.format(String, Object...). Unless the format is set to 'matlab' then it will print it out in a format that's understood by Matlab. 'java' will print a java 2D array.
        Parameters:
        out - Output stream
        mat - Matrix to be printed
        format - printf style or 'matlab'

      • printMatlab

        public static void printMatlab​(java.io.PrintStream out,
                               DMatrix mat)

      • printMatlab

        public static void printMatlab​(java.io.PrintStream out,
                               FMatrix mat)

      • print

        public static void print​(java.io.PrintStream out,
                         DMatrixSparseCSC m,
                         java.lang.String format)
        Prints the matrix out in a text format. The format is specified using notation from String.format(String, Object...). Unless the format is set to 'matlab' then it will print it out in a format that's understood by Matlab.
        Parameters:
        out - Output stream
        m - Matrix to be printed
        format - printf style or 'matlab'

      • print

        public static void print​(java.io.PrintStream out,
                         FMatrixSparseCSC m,
                         java.lang.String format)

      • print

        public static void print​(java.io.PrintStream out,
                         DMatrixSparseTriplet m,
                         java.lang.String format)

      • print

        public static void print​(java.io.PrintStream out,
                         FMatrixSparseTriplet m,
                         java.lang.String format)

      • printJava

        public static void printJava​(java.io.PrintStream out,
                             DMatrix mat,
                             java.lang.String format)

      • print

        public static void print​(java.io.PrintStream out,
                         FMatrix mat)

      • print

        public static void print​(java.io.PrintStream out,
                         FMatrix mat,
                         java.lang.String format)

      • print

        public static void print​(java.io.PrintStream out,
                         DMatrix mat,
                         java.lang.String format,
                         int row0,
                         int row1,
                         int col0,
                         int col1)

      • printJava

        public static void printJava​(java.io.PrintStream out,
                             FMatrix mat,
                             java.lang.String format)

      • print

        public static void print​(java.io.PrintStream out,
                         FMatrix mat,
                         java.lang.String format,
                         int row0,
                         int row1,
                         int col0,
                         int col1)

      • print

        public static void print​(java.io.PrintStream out,
                         ZMatrix mat,
                         java.lang.String format)

      • print

        public static void print​(java.io.PrintStream out,
                         CMatrix mat,
                         java.lang.String format)