com.tagtraum.jipes.math

Class FullMatrix

java.lang.Object

com.tagtraum.jipes.math.AbstractMatrix

com.tagtraum.jipes.math.MutableAbstractMatrix

com.tagtraum.jipes.math.FullMatrix

All Implemented Interfaces:

Matrix, MutableMatrix, Cloneable

public class FullMatrix
extends MutableAbstractMatrix
implements MutableMatrix, Cloneable

Fully-backed full-float-precision Matrix.

Author:

Hendrik Schreiber

Field Summary

Fields inherited from class com.tagtraum.jipes.math.AbstractMatrix

buffer, columns, rows, zeroPadded

Constructor Summary

Constructors

Modifier	Constructor and Description
	FullMatrix(File csvFile, String charset, char separator, boolean ignoreFirstLine) Constructs fully backed matrix with values from a CSV file.
	FullMatrix(int rows, int columns) Creates a fully backed matrix with the given number of rows and columns.
	FullMatrix(int rows, int columns, boolean direct, boolean zeroPadded) Creates a fully backed matrix with the given number of rows and columns.
	FullMatrix(int rows, int columns, float[] values) Creates a fully backed matrix with the given number of rows and columns.
	FullMatrix(int rows, int columns, MatrixBackingBuffer buffer, boolean zeroPadded) Creates a fully backed matrix with the given number of rows and columns.
protected	FullMatrix(int rows, int columns, MatrixBackingBuffer buffer, boolean zeroPadded, boolean allocate)
	FullMatrix(Matrix matrix, MatrixBackingBuffer buffer, boolean zeroPadded) Creates a fully backed matrix, filled with the values from the given matrix.

Method Summary

Modifier and Type	Method and Description
protected void	allocate(MatrixBackingBuffer buffer) Calls MatrixBackingBuffer.allocate(int) on the used buffer.
Object	clone()

Methods inherited from class com.tagtraum.jipes.math.MutableAbstractMatrix

copy, copy, copy, copy, fill, set, set, setColumn, setRow

Methods inherited from class com.tagtraum.jipes.math.AbstractMatrix

add, checkBounds, columnSum, enlarge, equals, get, get, getColumn, getNumberOfColumns, getNumberOfRows, getRow, hadamardMultiply, hashCode, isInvalid, isValidXORZeroPadded, isZeroPadded, multiply, multiply, rowSum, subtract, sum, toIndex, toString, translate, transpose

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.tagtraum.jipes.math.MutableMatrix

copy, copy, copy, fill, set, setColumn, setRow

Methods inherited from interface com.tagtraum.jipes.math.Matrix

add, columnSum, enlarge, get, getColumn, getNumberOfColumns, getNumberOfRows, getRow, hadamardMultiply, isZeroPadded, multiply, multiply, rowSum, subtract, sum, translate, transpose

Constructor Detail

FullMatrix

public FullMatrix(File csvFile,
                  String charset,
                  char separator,
                  boolean ignoreFirstLine)
           throws IOException

Constructs fully backed matrix with values from a CSV file.

Parameters:

csvFile - file

charset - charset

separator - seperator between values, usually ','

ignoreFirstLine - whether the first line should be ignored (non-numerical headers)

Throws:

IOException

FullMatrix

public FullMatrix(int rows,
                  int columns,
                  float[] values)

Creates a fully backed matrix with the given number of rows and columns. Memory is allocated from the Java heap. The matrix is not zero-padded. Initial values are taken from the provided array, continuously row by row. The values are copied, not referenced.

Parameters:

rows - rows

columns - columns

values - initial values

See Also:

MutableMatrix.copy(float[])

FullMatrix

public FullMatrix(int rows,
                  int columns)

Creates a fully backed matrix with the given number of rows and columns. Memory is allocated from the Java heap. The matrix is not zero-padded.

Parameters:

rows - rows

columns - columns

FullMatrix

public FullMatrix(int rows,
                  int columns,
                  MatrixBackingBuffer buffer,
                  boolean zeroPadded)

Creates a fully backed matrix with the given number of rows and columns. Memory is allocated through the given backing buffer. The matrix may be zero-padded.

Parameters:

rows - rows

columns - columns

buffer - backing buffer

zeroPadded - shall the matrix be zero padded?

FullMatrix

public FullMatrix(Matrix matrix,
                  MatrixBackingBuffer buffer,
                  boolean zeroPadded)

Creates a fully backed matrix, filled with the values from the given matrix. Memory is allocated through the given backing buffer. The matrix may be zero-padded.

Parameters:

matrix - matrix to copy

buffer - backing buffer

zeroPadded - shall the matrix be zero padded?

FullMatrix

public FullMatrix(int rows,
                  int columns,
                  boolean direct,
                  boolean zeroPadded)

Creates a fully backed matrix with the given number of rows and columns. Memory is allocated through a FloatBackingBuffer, either on the heap or natively. The matrix may be zero-padded.

Parameters:

rows - rows

columns - columns

direct - shall the memory be allocated directly?

zeroPadded - shall the matrix be zero padded?

FullMatrix

protected FullMatrix(int rows,
                     int columns,
                     MatrixBackingBuffer buffer,
                     boolean zeroPadded,
                     boolean allocate)

Method Detail

allocate

protected void allocate(MatrixBackingBuffer buffer)

Description copied from class: MutableAbstractMatrix

Calls MatrixBackingBuffer.allocate(int) on the used buffer.

Specified by:

allocate in class MutableAbstractMatrix

Parameters:

buffer - buffer

clone

public Object clone()
             throws CloneNotSupportedException

Overrides:

clone in class Object

Throws:

CloneNotSupportedException