com.tagtraum.jipes.math

Class SymmetricMatrix

java.lang.Object

com.tagtraum.jipes.math.AbstractMatrix

com.tagtraum.jipes.math.MutableAbstractMatrix

com.tagtraum.jipes.math.SymmetricMatrix

All Implemented Interfaces:

Matrix, MutableMatrix

Direct Known Subclasses:

SymmetricBandMatrix

public class SymmetricMatrix
extends MutableAbstractMatrix
implements MutableMatrix

Matrix for data that is mirrored along the diagonal. Any data set in one half of the matrix is automatically set in the other half without doubling memory consumption.

Author:

Hendrik Schreiber

Field Summary

Fields

Modifier and Type	Field and Description
protected int	offset

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

buffer, columns, rows, zeroPadded

Constructor Summary

Constructors

Modifier	Constructor and Description
	SymmetricMatrix(int length) Creates a square, symmetric matrix with the given number of rows and columns.
	SymmetricMatrix(int length, boolean direct, boolean zeroPadded) Creates a square, symmetric matrix with the given number of rows and columns.
	SymmetricMatrix(int offset, int length, boolean direct, boolean zeroPadded) Creates a square, symmetric matrix with the given number of rows and columns.
	SymmetricMatrix(int offset, int length, MatrixBackingBuffer buffer, boolean zeroPadded) Creates a square, symmetric matrix with the given number of rows and columns.
protected	SymmetricMatrix(int offset, int length, MatrixBackingBuffer buffer, boolean zeroPadded, boolean allocate)
	SymmetricMatrix(int length, MatrixBackingBuffer buffer, boolean zeroPadded) Creates a square, symmetric matrix with the given number of rows and columns.
	SymmetricMatrix(Matrix matrix, MatrixBackingBuffer buffer, boolean zeroPadded) Creates a square, symmetric matrix with the data 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.
float	get(int row, int column) Gets the value from row and column.
protected boolean	isInvalid(int row, int column)
void	set(int row, int column, float value) Sets the given value.
protected int	toIndex(int row, int column)
String	toString()

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

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

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

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

Methods inherited from class java.lang.Object

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

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

copy, copy, copy, fill, setColumn, setRow

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

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

Field Detail

offset

protected int offset

Constructor Detail

SymmetricMatrix

public SymmetricMatrix(int length)

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

Parameters:

length - rows == columns (square)

SymmetricMatrix

public SymmetricMatrix(int length,
                       MatrixBackingBuffer buffer,
                       boolean zeroPadded)

Creates a square, symmetric matrix with the given number of rows and columns. Memory is allocated using the given backing buffer. The matrix may be zero-padded.

Parameters:

buffer - backing buffer

length - rows == columns (square)

zeroPadded - zero padded?

SymmetricMatrix

public SymmetricMatrix(int offset,
                       int length,
                       MatrixBackingBuffer buffer,
                       boolean zeroPadded)

Creates a square, symmetric matrix with the given number of rows and columns. Memory is allocated using the given backing buffer. The matrix may be zero-padded.

Parameters:

buffer - backing buffer

length - rows == columns (square)

offset - columns < this offset cannot be stored

zeroPadded - zero padded?

SymmetricMatrix

public SymmetricMatrix(int offset,
                       int length,
                       boolean direct,
                       boolean zeroPadded)

Creates a square, symmetric matrix with the given number of rows and columns. Memory is allocated using a FloatBackingBuffer. The matrix may be zero-padded.

Parameters:

length - rows == columns (square)

offset - columns < this offset cannot be stored

direct - allocate the backing buffer directly/natively or on the Java heap

zeroPadded - zero padded?

SymmetricMatrix

public SymmetricMatrix(int length,
                       boolean direct,
                       boolean zeroPadded)

Creates a square, symmetric matrix with the given number of rows and columns. Memory is allocated using a FloatBackingBuffer. The matrix may be zero-padded.

Parameters:

length - rows == columns (square)

direct - allocate the backing buffer directly/natively or on the Java heap

zeroPadded - zero padded?

SymmetricMatrix

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

Creates a square, symmetric matrix with the data from the given matrix. Memory is allocated using a FloatBackingBuffer. The matrix may be zero-padded.

Parameters:

matrix - matrix

buffer - backing buffer

zeroPadded - zero padded?

SymmetricMatrix

protected SymmetricMatrix(int offset,
                          int length,
                          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

get

public float get(int row,
                 int column)

Description copied from interface: Matrix

Gets the value from row and column. If the matrix supports zero-padding, this method may return 0f for undefined rows or columns.

Specified by:

get in interface Matrix

Overrides:

get in class AbstractMatrix

Parameters:

row - row

column - column

Returns:

value

set

public void set(int row,
                int column,
                float value)

Description copied from interface: MutableMatrix

Sets the given value.

Specified by:

set in interface MutableMatrix

Overrides:

set in class MutableAbstractMatrix

Parameters:

row - row

column - column

value - value

isInvalid

protected boolean isInvalid(int row,
                            int column)

Overrides:

isInvalid in class AbstractMatrix

toIndex

protected int toIndex(int row,
                      int column)

Overrides:

toIndex in class AbstractMatrix

toString

public String toString()

Overrides:

toString in class AbstractMatrix