mikera.matrixx

Class AMatrix

java.lang.Object

mikera.transformz.ATransform

mikera.transformz.AAffineTransform

mikera.transformz.ALinearTransform

mikera.matrixx.AMatrix

All Implemented Interfaces:

Cloneable, Iterable<AVector>, INDArray, IMatrix

Direct Known Subclasses:

ADiagonalMatrix, AVectorMatrix, ColumnMatrix, Matrix22, Matrix33, MatrixMN, PermutedMatrix, RowMatrix, SubsetMatrix, TransposedMatrix, ZeroMatrix

public abstract class AMatrix
extends ALinearTransform
implements IMatrix, Iterable<AVector>, INDArray

General abstract 2D matrix class. Implements generic version of most key matrix operations.

Author:

Mike

Constructor Summary

Constructors

Constructor and Description
AMatrix()

Method Summary

Methods

Modifier and Type	Method and Description
void	add(AMatrix m) Adds another matrix to this matrix.
void	addMultiple(AMatrix m, double factor)
AVector	asVector() Returns the matrix values as a single reference Vector in the form [row0 row1 row2....]
double	calculateElement(int i, AVector v) Calculates a single element of the output.
AMatrix	clone() Clones the transform, performing a deep copy where needed
AVector	cloneRow(int row)
abstract int	columnCount() Returns the number of columns in the matrix
AMatrix	compose(AMatrix a)
ATransform	compose(ATransform a) Composes this transformation with another transformation, returning a new combined transformation
void	composeWith(AMatrix a)
void	composeWith(ATransform a) Composes this transformation with a given transformation, mutating the transformation to represent the combined transform
AMatrix	copyOfMatrix() Returns a deep copy of the transformation matrix for this affine transform
AVector	copyOfTranslationVector() Returns a deep copy of the translation vector for this affine transform
double	determinant() Calculates the determinant of the matrix.
int	dimensionality()
double	elementSum() Returns the sum of all elements in the matrix
void	entrywiseMul(AMatrix m) Multiplies this matrix in-place by another in an entrywise manner (Hadamard product).
boolean	epsilonEquals(AMatrix a) Returns true if this matrix is approximately equal to a second matrix, up to a default tolerance level
boolean	equals(AAffineTransform a)
boolean	equals(AMatrix a)
boolean	equals(Object o)
double	get(int... indexes)
abstract double	get(int row, int column) Returns a specified element in the matrix
AVector	getColumn(int column) Returns a column of the matrix as a vector view
AVector	getLeadingDiagonal() Returns a new vector that contains the leading diagonal values of the matrix
AMatrix	getMatrixComponent()
AVector	getRow(int row) Returns a row of the matrix as a vector view
AMatrix	getTranspose() Returns a transposed version of this matrix.
int	hashCode()
int	inputDimensions() Returns the number of dimensions required for input vectors
AMatrix	inverse() Return the inverse of this transformation if possible
boolean	isFullyMutable()
boolean	isIdentity() Returns true if this transform is the identity function, i.e.
boolean	isInvertible() Returns true if this transform is invertible
boolean	isSquare() Returns true if the transform is square (same number of input and output dimensions)
boolean	isZeroMatrix() Returns true if the matrix is the zero matrix (all components zero)
Iterator<AVector>	iterator() Returns an iterator over rows in this Matrix
void	mul(AMatrix a) "Multiplies" this matrix by another, composing the transformation
int	outputDimensions() Returns the number of dimensions required for output vectors
INDArray	reshape(int... dimensions)
abstract int	rowCount() Returns the number of rows in the matrix
void	scale(double factor) Scales a matrix by a constant scalar factor.
void	set(AMatrix a)
abstract void	set(int row, int column, double value) Sets a specified element in the matrix
void	sub(AMatrix m) Subtracts another matrix from this one
void	swapColumns(int i, int j) Swaps two columns of the matrix in place
void	swapRows(int i, int j) Swaps two rows of the matrix in place
AAffineTransform	toAffineTransform()
AMatrix	toMutableMatrix() Creates a fully mutable deep copy of this matrix
String	toString()
AVector	toVector() Converts the matrix to a single flattened vector in row major order.
void	transform(AVector source, AVector dest) Transforms the source vector, storing the result in the given destination vector
void	transformInPlace(AVector v) Transforms a vector destructively.
void	transposeInPlace()

Methods inherited from class mikera.transformz.ALinearTransform

getTranslationComponent, isLinear

Methods inherited from class mikera.transformz.AAffineTransform

compose, transformNormal

Methods inherited from class mikera.transformz.ATransform

takeComponents, takeComponents, takeComponents, transform

Methods inherited from class java.lang.Object

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

Constructor Detail

AMatrix

public AMatrix()

Method Detail

rowCount

public abstract int rowCount()

Returns the number of rows in the matrix

Specified by:

rowCount in interface IMatrix

columnCount

public abstract int columnCount()

Returns the number of columns in the matrix

Specified by:

columnCount in interface IMatrix

get

public abstract double get(int row,
         int column)

Returns a specified element in the matrix

Specified by:

get in interface IMatrix

set

public abstract void set(int row,
       int column,
       double value)

Sets a specified element in the matrix

Specified by:

set in interface IMatrix

dimensionality

public int dimensionality()

Specified by:

dimensionality in interface INDArray

get

public double get(int... indexes)

Specified by:

get in interface INDArray

getLeadingDiagonal

public AVector getLeadingDiagonal()

Returns a new vector that contains the leading diagonal values of the matrix

Returns:

calculateElement

public double calculateElement(int i,
                      AVector v)

Description copied from class: ATransform

Calculates a single element of the output. Not necessarily faster than calculating full output, but can be in some circumstances.

Overrides:

calculateElement in class AAffineTransform

toAffineTransform

public AAffineTransform toAffineTransform()

Overrides:

toAffineTransform in class AAffineTransform

getMatrixComponent

public AMatrix getMatrixComponent()

Specified by:

getMatrixComponent in class AAffineTransform

isIdentity

public boolean isIdentity()

Description copied from class: ATransform

Returns true if this transform is the identity function, i.e. it maps all vectors to themselves

Overrides:

isIdentity in class AAffineTransform

isSquare

public boolean isSquare()

Description copied from class: ATransform

Returns true if the transform is square (same number of input and output dimensions)

Overrides:

isSquare in class ATransform

Returns:

inputDimensions

public int inputDimensions()

Description copied from class: ATransform

Returns the number of dimensions required for input vectors

Specified by:

inputDimensions in class ATransform

Returns:

outputDimensions

public int outputDimensions()

Description copied from class: ATransform

Returns the number of dimensions required for output vectors

Specified by:

outputDimensions in class ATransform

Returns:

transform

public void transform(AVector source,
             AVector dest)

Description copied from class: ATransform

Transforms the source vector, storing the result in the given destination vector

Overrides:

transform in class AAffineTransform

transformInPlace

public void transformInPlace(AVector v)

Description copied from class: ATransform

Transforms a vector destructively. Intended for fast non-allocating transforms

Overrides:

transformInPlace in class AAffineTransform

reshape

public INDArray reshape(int... dimensions)

Specified by:

reshape in interface INDArray

getRow

public AVector getRow(int row)

Returns a row of the matrix as a vector view

getColumn

public AVector getColumn(int column)

Returns a column of the matrix as a vector view

cloneRow

public AVector cloneRow(int row)

set

public void set(AMatrix a)

isFullyMutable

public boolean isFullyMutable()

clone

public AMatrix clone()

Description copied from class: ATransform

Clones the transform, performing a deep copy where needed

Overrides:

clone in class ATransform

determinant

public double determinant()

Calculates the determinant of the matrix.

toMutableMatrix

public AMatrix toMutableMatrix()

Creates a fully mutable deep copy of this matrix

Returns:

A new matrix

transposeInPlace

public void transposeInPlace()

getTranspose

public AMatrix getTranspose()

Returns a transposed version of this matrix. May or may not be a reference.

Returns:

add

public void add(AMatrix m)

Adds another matrix to this matrix. Matrices must be the same size.

Parameters:

m -

scale

public void scale(double factor)

Scales a matrix by a constant scalar factor.

Parameters:

m -

elementSum

public double elementSum()

Returns the sum of all elements in the matrix

Parameters:

m -

Returns:

sub

public void sub(AMatrix m)

Subtracts another matrix from this one

Parameters:

m -

entrywiseMul

public void entrywiseMul(AMatrix m)

Multiplies this matrix in-place by another in an entrywise manner (Hadamard product).

Parameters:

m -

mul

public void mul(AMatrix a)

"Multiplies" this matrix by another, composing the transformation

Parameters:

a -

composeWith

public void composeWith(ATransform a)

Description copied from class: ATransform

Composes this transformation with a given transformation, mutating the transformation to represent the combined transform

Overrides:

composeWith in class ATransform

composeWith

public void composeWith(AMatrix a)

copyOfMatrix

public AMatrix copyOfMatrix()

Description copied from class: AAffineTransform

Returns a deep copy of the transformation matrix for this affine transform

Overrides:

copyOfMatrix in class AAffineTransform

copyOfTranslationVector

public AVector copyOfTranslationVector()

Description copied from class: AAffineTransform

Returns a deep copy of the translation vector for this affine transform

Overrides:

copyOfTranslationVector in class AAffineTransform

addMultiple

public void addMultiple(AMatrix m,
               double factor)

iterator

public Iterator<AVector> iterator()

Returns an iterator over rows in this Matrix

Specified by:

iterator in interface Iterable<AVector>

equals

public boolean equals(Object o)

Overrides:

equals in class AAffineTransform

equals

public boolean equals(AMatrix a)

epsilonEquals

public boolean epsilonEquals(AMatrix a)

Returns true if this matrix is approximately equal to a second matrix, up to a default tolerance level

equals

public boolean equals(AAffineTransform a)

Overrides:

equals in class AAffineTransform

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class AAffineTransform

asVector

public AVector asVector()

Returns the matrix values as a single reference Vector in the form [row0 row1 row2....]

Specified by:

asVector in interface INDArray

Returns:

compose

public ATransform compose(ATransform a)

Description copied from class: ATransform

Composes this transformation with another transformation, returning a new combined transformation

Overrides:

compose in class AAffineTransform

compose

public AMatrix compose(AMatrix a)

inverse

public AMatrix inverse()

Description copied from class: ATransform

Return the inverse of this transformation if possible

Overrides:

inverse in class AAffineTransform

Returns:

isInvertible

public boolean isInvertible()

Description copied from class: ATransform

Returns true if this transform is invertible

Overrides:

isInvertible in class AAffineTransform

swapRows

public void swapRows(int i,
            int j)

Swaps two rows of the matrix in place

swapColumns

public void swapColumns(int i,
               int j)

Swaps two columns of the matrix in place

toVector

public AVector toVector()

Converts the matrix to a single flattened vector in row major order.

isZeroMatrix

public boolean isZeroMatrix()

Returns true if the matrix is the zero matrix (all components zero)