mikera.matrixx.impl

Class ZeroMatrix

java.lang.Object

mikera.transformz.ATransform

mikera.transformz.AAffineTransform

mikera.transformz.ALinearTransform

mikera.matrixx.AMatrix

mikera.matrixx.impl.ZeroMatrix

All Implemented Interfaces:

Cloneable, Iterable<AVector>, INDArray, IMatrix, ITransform

public final class ZeroMatrix
extends AMatrix

Lightweight immutable zero matrix class

Method Summary

Methods

Modifier and Type	Method and Description
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
int	columnCount() Returns the number of columns in the matrix
AMatrix	compose(ATransform t) Composes this transformation with another transformation, returning a new combined transformation
void	composeWith(AMatrix t)
void	composeWith(ATransform t) Composes this transformation with a given transformation, mutating the transformation to represent the combined transform
static ZeroMatrix	create(int rows, int columns)
double	determinant() Calculates the determinant of the matrix.
void	elementMul(AMatrix m) Multiplies this matrix in-place by another in an entrywise manner (Hadamard product).
double	elementSum() Returns the sum of all elements in the matrix
boolean	equals(AMatrix m)
ZeroMatrix	exactClone() Returns an exact deep clone of an array (i.e.
double	get(int row, int column) Returns a specified element in the matrix
AVector	getLeadingDiagonal() Returns a new vector that contains the leading diagonal values of the matrix
ZeroMatrix	getTranspose() Returns a transposed version of this matrix.
int	hashCode()
AMatrix	innerProduct(AMatrix m)
int	inputDimensions() Returns the number of dimensions required for input vectors
boolean	isDiagonal() Returns true if a matrix is diagonal
boolean	isFullyMutable() Returns true if the INDArray is fully mutable in all positions i.e.
boolean	isInvertible() Returns true if this transform is invertible
boolean	isLowerTriangular() Returns true if a matrix is lower triangular
boolean	isMutable() Returns true if the INDArray is mutable (at least partially)
boolean	isSymmetric() Returns true if a matrix is symmetric
boolean	isUpperTriangular() Returns true if a matrix is upper triangular
boolean	isZeroMatrix() Returns true if the matrix is the zero matrix (all components zero)
void	multiply(double factor) Multiplies all elements of the array by a given double value
long	nonZeroCount() Returns the number of non-zero elements in the array.
int	outputDimensions() Returns the number of dimensions required for output vectors
int	rowCount() Returns the number of rows in the matrix
void	set(int row, int column, double value) Sets a specified element in the matrix
double	trace()
void	transform(AVector input, AVector output) Transforms the source vector, storing the result in the given destination vector

Methods inherited from class mikera.matrixx.AMatrix

add, add, add, add, addAt, addMultiple, addRowMultiple, applyOp, applyOp, broadcast, cloneRow, compose, copyOfMatrix, copyOfTranslationVector, copyTo, dimensionality, elementCount, elementSquaredSum, epsilonEquals, equals, equals, equals, get, get, get, getColumn, getElements, getLongShape, getMatrixComponent, getRow, getShape, getShape, getSlices, getSliceViews, innerProduct, innerProduct, innerProduct, inverse, isElementConstrained, isHermitian, isIdentity, isPositiveDefinite, isSquare, isView, iterator, mul, multiply, multiplyRow, negate, outerProduct, reshape, scale, scaleAdd, set, set, set, set, set, set, setElements, setElements, slice, slice, sliceCount, sub, sub, sub, sub, swapColumns, swapRows, toAffineTransform, toDoubleBuffer, toMutableMatrix, toString, toVector, transformInPlace, transformInPlace, transposeInPlace, validate

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

Method Detail

isFullyMutable

public boolean isFullyMutable()

Description copied from interface: INDArray

Returns true if the INDArray is fully mutable in all positions i.e. every position can store any valid double value

Specified by:

isFullyMutable in interface INDArray

Overrides:

isFullyMutable in class AMatrix

Returns:

isMutable

public boolean isMutable()

Description copied from interface: INDArray

Returns true if the INDArray is mutable (at least partially)

Specified by:

isMutable in interface INDArray

Overrides:

isMutable in class AMatrix

Returns:

inputDimensions

public int inputDimensions()

Description copied from class: ATransform

Returns the number of dimensions required for input vectors

Specified by:

inputDimensions in interface ITransform

Overrides:

inputDimensions in class AMatrix

Returns:

isSymmetric

public boolean isSymmetric()

Description copied from class: AMatrix

Returns true if a matrix is symmetric

Overrides:

isSymmetric in class AMatrix

isDiagonal

public boolean isDiagonal()

Description copied from class: AMatrix

Returns true if a matrix is diagonal

Overrides:

isDiagonal in class AMatrix

isUpperTriangular

public boolean isUpperTriangular()

Description copied from class: AMatrix

Returns true if a matrix is upper triangular

Overrides:

isUpperTriangular in class AMatrix

isLowerTriangular

public boolean isLowerTriangular()

Description copied from class: AMatrix

Returns true if a matrix is lower triangular

Overrides:

isLowerTriangular in class AMatrix

multiply

public void multiply(double factor)

Description copied from interface: INDArray

Multiplies all elements of the array by a given double value

Specified by:

multiply in interface INDArray

Overrides:

multiply in class AMatrix

outputDimensions

public int outputDimensions()

Description copied from class: ATransform

Returns the number of dimensions required for output vectors

Specified by:

outputDimensions in interface ITransform

Overrides:

outputDimensions in class AMatrix

Returns:

rowCount

public int rowCount()

Description copied from class: AMatrix

Returns the number of rows in the matrix

Specified by:

rowCount in interface IMatrix

Specified by:

rowCount in class AMatrix

columnCount

public int columnCount()

Description copied from class: AMatrix

Returns the number of columns in the matrix

Specified by:

columnCount in interface IMatrix

Specified by:

columnCount in class AMatrix

determinant

public double determinant()

Description copied from class: AMatrix

Calculates the determinant of the matrix.

Overrides:

determinant in class AMatrix

trace

public double trace()

Overrides:

trace in class AMatrix

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 AMatrix

get

public double get(int row,
         int column)

Description copied from class: AMatrix

Returns a specified element in the matrix

Specified by:

get in interface INDArray

Specified by:

get in interface IMatrix

Specified by:

get in class AMatrix

Returns:

set

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

Description copied from class: AMatrix

Sets a specified element in the matrix

Specified by:

set in interface INDArray

Specified by:

set in interface IMatrix

Specified by:

set in class AMatrix

clone

public AMatrix clone()

Description copied from class: ATransform

Clones the transform, performing a deep copy where needed

Specified by:

clone in interface INDArray

Overrides:

clone in class AMatrix

Returns:

isZeroMatrix

public boolean isZeroMatrix()

Description copied from class: AMatrix

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

Overrides:

isZeroMatrix in class AMatrix

elementSum

public double elementSum()

Description copied from class: AMatrix

Returns the sum of all elements in the matrix

Specified by:

elementSum in interface INDArray

Overrides:

elementSum in class AMatrix

Returns:

nonZeroCount

public long nonZeroCount()

Description copied from interface: INDArray

Returns the number of non-zero elements in the array.

Specified by:

nonZeroCount in interface INDArray

Overrides:

nonZeroCount in class AMatrix

Returns:

hashCode

public int hashCode()

Overrides:

hashCode in class AMatrix

transform

public void transform(AVector input,
             AVector output)

Description copied from class: ATransform

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

Specified by:

transform in interface ITransform

Overrides:

transform in class AMatrix

isInvertible

public boolean isInvertible()

Description copied from class: ATransform

Returns true if this transform is invertible

Overrides:

isInvertible in class AMatrix

asVector

public AVector asVector()

Description copied from class: AMatrix

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

Specified by:

asVector in interface INDArray

Overrides:

asVector in class AMatrix

Returns:

compose

public AMatrix compose(ATransform t)

Description copied from class: ATransform

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

Overrides:

compose in class AMatrix

innerProduct

public AMatrix innerProduct(AMatrix m)

Overrides:

innerProduct in class AMatrix

composeWith

public void composeWith(ATransform t)

Description copied from class: ATransform

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

Overrides:

composeWith in class AMatrix

composeWith

public void composeWith(AMatrix t)

Overrides:

composeWith in class AMatrix

elementMul

public void elementMul(AMatrix m)

Description copied from class: AMatrix

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

Overrides:

elementMul in class AMatrix

equals

public boolean equals(AMatrix m)

Overrides:

equals in class AMatrix

getTranspose

public ZeroMatrix getTranspose()

Description copied from class: AMatrix

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

Overrides:

getTranspose in class AMatrix

Returns:

create

public static ZeroMatrix create(int rows,
                int columns)

getLeadingDiagonal

public AVector getLeadingDiagonal()

Description copied from class: AMatrix

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

Overrides:

getLeadingDiagonal in class AMatrix

Returns:

exactClone

public ZeroMatrix exactClone()

Description copied from interface: INDArray

Returns an exact deep clone of an array (i.e. of the same class as the original).

Specified by:

exactClone in interface INDArray

Specified by:

exactClone in class AMatrix

Returns: