Package org.ejml.ops

Class MatrixIO

java.lang.Object

org.ejml.ops.MatrixIO

public class MatrixIO
extends Object

Provides simple to use routines for reading and writing matrices to and from files.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
MatrixIO()

Method Summary

Modifier and Type	Method	Description
static <T extends DMatrix> T	loadBin(String fileName)	Deprecated. This will be removed in the future due to how unsafe readObject() is.
static <T extends DMatrix> T	loadCSV(String fileName, boolean doublePrecision)	Reads a matrix in which has been encoded using a Column Space Value (CSV) file format.
static DMatrixRMaj	loadCSV(String fileName, int numRows, int numCols)	Reads a matrix in which has been encoded using a Column Space Value (CSV) file format.
static <T extends Matrix> T	loadMatlab(String fileName)	Loads a Matrix which has been saved to file using MATLAB's MAT-File Format (Level 5) serialization.
static <T extends Matrix> T	loadMatlab(String fileName, T output)	Loads a Matrix which has been saved to file using MATLAB's MAT-File Format (Level 5) serialization.
static DMatrixSparseTriplet	loadMatrixMarketD(Reader reader)	Reads a stream in Matrix Market Coordinate format https://math.nist.gov/MatrixMarket/formats.html
static FMatrixSparseTriplet	loadMatrixMarketF(InputStream streamIn)	Reads a stream in Matrix Market Coordinate format https://math.nist.gov/MatrixMarket/formats.html
static FMatrixSparseTriplet	loadMatrixMarketF(Reader reader)	Reads a stream in Matrix Market Coordinate format https://math.nist.gov/MatrixMarket/formats.html
static DMatrixRMaj	matlabToDDRM(String text)	Converts a text string in matlab format into a DDRM matrix
static FMatrixRMaj	matlabToFDRM(String text)	Converts a text string in matlab format into a DDRM matrix
static void	print(PrintStream out, CMatrix mat, String format)
static void	print(PrintStream out, DMatrix mat)
static void	print(PrintStream out, DMatrix mat, String format)	Prints the matrix out in a text format.
static void	print(PrintStream out, DMatrix mat, String format, int row0, int row1, int col0, int col1)
static void	print(PrintStream out, DMatrixSparseCSC m, String format)	Prints the matrix out in a text format.
static void	print(PrintStream out, DMatrixSparseTriplet m, String format)
static void	print(PrintStream out, FMatrix mat)
static void	print(PrintStream out, FMatrix mat, String format)
static void	print(PrintStream out, FMatrix mat, String format, int row0, int row1, int col0, int col1)
static void	print(PrintStream out, FMatrixSparseCSC m, String format)
static void	print(PrintStream out, FMatrixSparseTriplet m, String format)
static void	print(PrintStream out, Matrix mat)
static void	print(PrintStream out, ZMatrix mat, String format)
static void	printFancy(PrintStream out, CMatrix mat, int length)
static void	printFancy(PrintStream out, DMatrix mat, int length)
static void	printFancy(PrintStream out, DMatrixSparseCSC m, int length)
static void	printFancy(PrintStream out, FMatrix mat, int length)
static void	printFancy(PrintStream out, ZMatrix mat, int length)
static void	printJava(PrintStream out, DMatrix mat, String format)
static void	printJava(PrintStream out, FMatrix mat, String format)
static void	printMatlab(PrintStream out, DMatrix mat)
static void	printMatlab(PrintStream out, FMatrix mat)
static void	saveBin(DMatrix A, String fileName)	Saves a matrix to disk using Java binary serialization.
static void	saveDenseCSV(DMatrix A, String fileName)	Saves a matrix to disk using in a Column Space Value (CSV) format.
static void	saveMatlab(Matrix A, String fileName)	Saves a matrix to disk using MATLAB's MAT-File Format (Level 5) binary serialization.
static void	saveMatrixMarketD(DMatrixSparse matrix, String floatFormat, Writer writer)	Writes a stream using the Matrix Market Coordinate format.
static void	saveMatrixMarketF(FMatrixSparse matrix, String floatFormat, Writer writer)	Writes a stream using the Matrix Market Coordinate format.
static void	saveSparseCSV(DMatrixSparseTriplet A, String fileName)	Saves a matrix to disk using in a Column Space Value (CSV) format.
static void	saveSparseCSV(FMatrixSparseTriplet A, 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 Details

DEFAULT_FLOAT_FORMAT

public static final 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 String MATLAB_FORMAT

Specified the printf format used when printing out in Matlab format

Constructor Details

MatrixIO

public MatrixIO()

Method Details

matlabToDDRM

public static DMatrixRMaj matlabToDDRM(String text)

Converts a text string in matlab format into a DDRM matrix

matlabToFDRM

public static FMatrixRMaj matlabToFDRM(String text)

Converts a text string in matlab format into a DDRM matrix

saveMatrixMarketD

public static void saveMatrixMarketD(DMatrixSparse matrix,
String floatFormat,
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,
String floatFormat,
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(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(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(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

saveMatlab

public static void saveMatlab(Matrix A,
String fileName)
                       throws IOException

Saves a matrix to disk using MATLAB's MAT-File Format (Level 5) binary serialization. Notes: * The matrix gets stored as a single root level entry named 'ejmlMatrix' * FMatrixSparseCSC get stored as sparse double matrices See MAT File Library matfile_format.pdf

Parameters:

A - The matrix being saved.

fileName - Name of the file its being saved at.

Throws:

IOException

loadMatlab

public static <T extends Matrix> T loadMatlab(String fileName)
                                       throws IOException

Loads a Matrix which has been saved to file using MATLAB's MAT-File Format (Level 5) serialization.

Parameters:

fileName - The file being loaded. It is expected to contain a root level entry named 'ejmlMatrix'.

Returns:

Matrix A matrix of the type that best matches the serialized data

Throws:

IOException

loadMatlab

public static <T extends Matrix> T loadMatlab(String fileName,
@Nullable
T output)
                                       throws IOException

Loads a Matrix which has been saved to file using MATLAB's MAT-File Format (Level 5) serialization.

Parameters:

fileName - The file being loaded. It is expected to contain a root level entry named 'ejmlMatrix'.

output - Output Matrix. Automatically matched if null. Modified.

Returns:

Matrix

Throws:

IOException

saveBin

public static void saveBin(DMatrix A,
String fileName)
                    throws 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:

IOException

loadBin

@Deprecated
public static <T extends DMatrix> T loadBin(String fileName)
                                     throws IOException

Deprecated.

This will be removed in the future due to how unsafe readObject() is.

Loads a DMatrix which has been saved to file using Java binary serialization.

Parameters:

fileName - The file being loaded.

Returns:

DMatrixRMaj

Throws:

IOException

saveDenseCSV

public static void saveDenseCSV(DMatrix A,
String fileName)
                         throws 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:

IOException

saveSparseCSV

public static void saveSparseCSV(DMatrixSparseTriplet A,
String fileName)
                          throws 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:

IOException

saveSparseCSV

public static void saveSparseCSV(FMatrixSparseTriplet A,
String fileName)
                          throws 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:

IOException

loadCSV

public static <T extends DMatrix> T loadCSV(String fileName,
boolean doublePrecision)
                                     throws 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:

IOException

loadCSV

public static DMatrixRMaj loadCSV(String fileName,
int numRows,
int numCols)
                           throws 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:

IOException

printFancy

public static void printFancy(PrintStream out,
DMatrix mat,
int length)

printFancy

public static void printFancy(PrintStream out,
FMatrix mat,
int length)

printFancy

public static void printFancy(PrintStream out,
ZMatrix mat,
int length)

printFancy

public static void printFancy(PrintStream out,
CMatrix mat,
int length)

printFancy

public static void printFancy(PrintStream out,
DMatrixSparseCSC m,
int length)

print

public static void print(PrintStream out,
Matrix mat)

print

public static void print(PrintStream out,
DMatrix mat)

print

public static void print(PrintStream out,
DMatrix mat,
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(PrintStream out,
DMatrix mat)

printMatlab

public static void printMatlab(PrintStream out,
FMatrix mat)

print

public static void print(PrintStream out,
DMatrixSparseCSC m,
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(PrintStream out,
FMatrixSparseCSC m,
String format)

print

public static void print(PrintStream out,
DMatrixSparseTriplet m,
String format)

print

public static void print(PrintStream out,
FMatrixSparseTriplet m,
String format)

printJava

public static void printJava(PrintStream out,
DMatrix mat,
String format)

print

public static void print(PrintStream out,
FMatrix mat)

print

public static void print(PrintStream out,
FMatrix mat,
String format)

print

public static void print(PrintStream out,
DMatrix mat,
String format,
int row0,
int row1,
int col0,
int col1)

printJava

public static void printJava(PrintStream out,
FMatrix mat,
String format)

print

public static void print(PrintStream out,
FMatrix mat,
String format,
int row0,
int row1,
int col0,
int col1)

print

public static void print(PrintStream out,
ZMatrix mat,
String format)

print

public static void print(PrintStream out,
CMatrix mat,
String format)