edu.ucla.sspace.matrix

Class MatrixFile

java.lang.Object

edu.ucla.sspace.matrix.MatrixFile

All Implemented Interfaces:

Iterable<MatrixEntry>

public class MatrixFile
extends Object
implements Iterable<MatrixEntry>

An abstraction of a matrix that is stored on disk. This class provides convenient accessors to the contents of the data and allows other classes that operate on matrices to more easily handle matrix files as parameters and return arguments.

Constructor Summary

Constructors

Constructor and Description
MatrixFile(File matrixFile, MatrixIO.Format format) Constucts a MatrixFile from the provided File and format.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object o)
File	getFile() Returns file containing the matrix data
MatrixIO.Format	getFormat() Returns the format of the matrix
int	hashCode()
Iterator<MatrixEntry>	iterator() Returns an iterator over all the entries in the matrix.
Matrix	load() Loads the matrix from disk and returns a copy of its data.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

MatrixFile

public MatrixFile(File matrixFile,
          MatrixIO.Format format)

Constucts a MatrixFile from the provided File and format.

Method Detail

equals

public boolean equals(Object o)

Overrides:

equals in class Object

getFile

public File getFile()

Returns file containing the matrix data

getFormat

public MatrixIO.Format getFormat()

Returns the format of the matrix

hashCode

public int hashCode()

Overrides:

hashCode in class Object

iterator

public Iterator<MatrixEntry> iterator()

Returns an iterator over all the entries in the matrix. The order in which entries are returned is format-specific; no guarantee is provided about the ordering.

Specified by:

iterator in interface Iterable<MatrixEntry>

load

public Matrix load()

Loads the matrix from disk and returns a copy of its data. Note that a new Matrix is created each time this is called.

toString

public String toString()

Overrides:

toString in class Object