edu.ucla.sspace.matrix

Class MatlabSparseMatrixBuilder

java.lang.Object

edu.ucla.sspace.matrix.MatlabSparseMatrixBuilder

All Implemented Interfaces:

MatrixBuilder

public class MatlabSparseMatrixBuilder
extends Object
implements MatrixBuilder

A MatrixBuilder implementation for creating matrix files in the Matlab&cp; sparse matrix format.

This class is thread-safe.

Author:

David Jurgens

Constructor Summary

Constructors

Constructor and Description
MatlabSparseMatrixBuilder() Creates a builder for a matrix in the MATLAB_SPARSE format to be stored in a temporary file.
MatlabSparseMatrixBuilder(boolean transposeData) Creates a builder for a matrix in the MATLAB_SPARSE format to be stored in a temporary file.
MatlabSparseMatrixBuilder(File backingFile) Creates a builder for a matrix in the MATLAB_SPARSE format, which will be stored in the specified file.
MatlabSparseMatrixBuilder(File backingFile, boolean transposeData) Creates a builder for a matrix in the MATLAB_SPARSE format, which will be stored in the specified file.

Method Summary

Methods

Modifier and Type	Method and Description
int	addColumn(double[] column) Adds the column values to the underlying matrix, updating the dimensions as necessary and returning the index at which the column was added.
int	addColumn(SparseArray<? extends Number> column) Adds the double values in the array to the underlying matrix, updating the dimensions as necessary and returning the index at which the column was added.
int	addColumn(Vector col) Adds the vector values to the underlying matrix, updating the dimensions as necessary and returning the index at which the column was added.
void	finish() Indicates that no further data will be added to the matrix and any remaining matrix meta-data should be written and flushed to disk.
File	getFile() Returns the file containing the matrix data after all data has finished being written.
MatrixFile	getMatrixFile()
MatrixIO.Format	getMatrixFormat() Returns MATLAB_SPARSE.
boolean	isFinished() Returns true if no further data should be added to the matrix and the file containing the data is available for us.

Methods inherited from class java.lang.Object

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

Constructor Detail

MatlabSparseMatrixBuilder

public MatlabSparseMatrixBuilder()

Creates a builder for a matrix in the MATLAB_SPARSE format to be stored in a temporary file.

MatlabSparseMatrixBuilder

public MatlabSparseMatrixBuilder(boolean transposeData)

Creates a builder for a matrix in the MATLAB_SPARSE format to be stored in a temporary file.

Parameters:

transposeData - true if the input matrix columns should be tranposed in the backing matrix file

MatlabSparseMatrixBuilder

public MatlabSparseMatrixBuilder(File backingFile)

Creates a builder for a matrix in the MATLAB_SPARSE format, which will be stored in the specified file.

Parameters:

backingFile - the file to which the matrix should be written

MatlabSparseMatrixBuilder

public MatlabSparseMatrixBuilder(File backingFile,
                         boolean transposeData)

Creates a builder for a matrix in the MATLAB_SPARSE format, which will be stored in the specified file.

Parameters:

backingFile - the file to which the matrix should be written

transposeData - true if the input matrix columns should be tranposed in the backing matrix file

Method Detail

addColumn

public int addColumn(double[] column)

Adds the column values to the underlying matrix, updating the dimensions as necessary and returning the index at which the column was added.

Specified by:

addColumn in interface MatrixBuilder

Parameters:

column - the values of the column in the matrix.

Returns:

the index at which the column is present.

addColumn

public int addColumn(SparseArray<? extends Number> column)

Adds the double values in the array to the underlying matrix, updating the dimensions as necessary and returning the index at which the column was added.

Specified by:

addColumn in interface MatrixBuilder

Parameters:

column - the values of the column in the matrix.

Returns:

the index at which the column is present.

addColumn

public int addColumn(Vector col)

Adds the vector values to the underlying matrix, updating the dimensions as necessary and returning the index at which the column was added.

Specified by:

addColumn in interface MatrixBuilder

Parameters:

col - the values of the column in the matrix.

Returns:

the index at which the column is present.

finish

public void finish()

Indicates that no further data will be added to the matrix and any remaining matrix meta-data should be written and flushed to disk. Once this method has been called addColumn will thcolumn a IllegalStateException if called. Once this method has been called, any subsequent calls will have no effect and will not throw an exception.

Specified by:

finish in interface MatrixBuilder

getFile

public File getFile()

Returns the file containing the matrix data after all data has finished being written. The finish method must be called prior to accessing the underlying file to ensure that all necessary matrix meta-data has been written to disk.

Specified by:

getFile in interface MatrixBuilder

Returns:

the file containing the matrix data

getMatrixFormat

public MatrixIO.Format getMatrixFormat()

Returns MATLAB_SPARSE.

Specified by:

getMatrixFormat in interface MatrixBuilder

Returns:

the format of the matrix's data

getMatrixFile

public MatrixFile getMatrixFile()

Specified by:

getMatrixFile in interface MatrixBuilder

isFinished

public boolean isFinished()

Returns true if no further data should be added to the matrix and the file containing the data is available for us. This will only return true if finish has been called first.

Specified by:

isFinished in interface MatrixBuilder

Returns:

true if no further data should be added to the matrix