org.openimaj.math.matrix

Class ReadWriteableMatrix

java.lang.Object

Jama.Matrix

org.openimaj.math.matrix.ReadWriteableMatrix

All Implemented Interfaces:

Serializable, Cloneable, Readable, ReadableASCII, ReadableBinary, ReadWriteable, Writeable, WriteableASCII, WriteableBinary

Direct Known Subclasses:

SimilarityMatrix

public class ReadWriteableMatrix
extends Jama.Matrix
implements ReadWriteable

A wrapper around a JAMA Matrix that is read-writeable by OpenIMAJ IOUtils.

Author:

Jonathon Hare (jsh2@ecs.soton.ac.uk)

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ReadWriteableMatrix() Construct a new matrix of zero size.
	ReadWriteableMatrix(double[][] data) Construct a matrix using the provided 2-D double array.
	ReadWriteableMatrix(int rows, int cols) Construct a new matrix of the given size
	ReadWriteableMatrix(Jama.Matrix data) Construct a matrix using the provided matrix.

Method Summary

Modifier and Type	Method and Description
String	asciiHeader() Header for ascii input.
byte[]	binaryHeader() Header for binary input.
void	readASCII(Scanner in) Read internal state from in.
void	readBinary(DataInput in) Read internal state from in.
protected void	setData(int m, int n, double[][] data)
void	writeASCII(PrintWriter out) Write the content of this as ascii to out.
void	writeBinary(DataOutput out) Write the content of this as binary to out.

Methods inherited from class Jama.Matrix

arrayLeftDivide, arrayLeftDivideEquals, arrayRightDivide, arrayRightDivideEquals, arrayTimes, arrayTimesEquals, chol, clone, cond, constructWithCopy, copy, det, eig, get, getArray, getArrayCopy, getColumnDimension, getColumnPackedCopy, getMatrix, getMatrix, getMatrix, getMatrix, getRowDimension, getRowPackedCopy, identity, inverse, lu, minus, minusEquals, norm1, norm2, normF, normInf, plus, plusEquals, print, print, print, print, qr, random, rank, read, set, setMatrix, setMatrix, setMatrix, setMatrix, solve, solveTranspose, svd, times, times, timesEquals, trace, transpose, uminus

Methods inherited from class java.lang.Object

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

Constructor Detail

ReadWriteableMatrix

protected ReadWriteableMatrix()

Construct a new matrix of zero size. Only for IOUtils use.

ReadWriteableMatrix

public ReadWriteableMatrix(double[][] data)

Construct a matrix using the provided 2-D double array. The array is assigned internally and is not copied.

Parameters:

data - the data

ReadWriteableMatrix

public ReadWriteableMatrix(int rows,
                           int cols)

Construct a new matrix of the given size

Parameters:

rows - Number of rows

cols - Number of columns

ReadWriteableMatrix

public ReadWriteableMatrix(Jama.Matrix data)

Construct a matrix using the provided matrix. The matrix data is assigned internally and is not copied.

Parameters:

data - the data

Method Detail

readASCII

public void readASCII(Scanner in)
               throws IOException

Description copied from interface: ReadableASCII

Read internal state from in.

Specified by:

readASCII in interface ReadableASCII

Parameters:

in - source to read from.

Throws:

IOException - an error reading input

asciiHeader

public String asciiHeader()

Description copied from interface: ReadableASCII

Header for ascii input. Will be automatically read by IOUtils when using readASCII().

Specified by:

asciiHeader in interface ReadableASCII

Specified by:

asciiHeader in interface WriteableASCII

Returns:

header

readBinary

public void readBinary(DataInput in)
                throws IOException

Description copied from interface: ReadableBinary

Read internal state from in.

Specified by:

readBinary in interface ReadableBinary

Parameters:

in - source to read from.

Throws:

IOException - an error reading input

setData

protected void setData(int m,
                       int n,
                       double[][] data)

binaryHeader

public byte[] binaryHeader()

Description copied from interface: ReadableBinary

Header for binary input. Will be automatically read by IOUtils when using readBinary().

Specified by:

binaryHeader in interface ReadableBinary

Specified by:

binaryHeader in interface WriteableBinary

Returns:

header

writeASCII

public void writeASCII(PrintWriter out)
                throws IOException

Description copied from interface: WriteableASCII

Write the content of this as ascii to out.

Specified by:

writeASCII in interface WriteableASCII

Parameters:

out - sink to write to

Throws:

IOException - an error writing to out

writeBinary

public void writeBinary(DataOutput out)
                 throws IOException

Description copied from interface: WriteableBinary

Write the content of this as binary to out.

Specified by:

writeBinary in interface WriteableBinary

Parameters:

out - sink to write to

Throws:

IOException - an error writing to out