mikera.matrixx.impl

Class ADiagonalMatrix

java.lang.Object

mikera.transformz.ATransform

mikera.transformz.AAffineTransform

mikera.transformz.ALinearTransform

mikera.matrixx.AMatrix

mikera.matrixx.impl.ABandedMatrix

mikera.matrixx.impl.ADiagonalMatrix

All Implemented Interfaces:

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

Direct Known Subclasses:

DiagonalMatrix, IdentityMatrix, ScalarMatrix

public abstract class ADiagonalMatrix
extends ABandedMatrix
implements ISparse

Abstract base class for square diagonal matrices

Author:

Mike

Field Summary

Fields

Modifier and Type	Field and Description
protected int	dimensions

Constructor Summary

Constructors

Constructor and Description
ADiagonalMatrix(int dimensions)

Method Summary

Methods

Modifier and Type	Method and Description
double	calculateElement(int i, AVector v) Calculates a single element of the output.
int	columnCount() Returns the number of columns in the matrix
void	copyColumnTo(int col, double[] dest, int destOffset)
void	copyRowTo(int row, double[] dest, int destOffset)
double	density() Computes the density ratio of this sparse array (proportion of non-zero elements)
double	determinant() Calculates the determinant of the matrix.
int	dimensions() Returns the number of dimensions of this diagonal matrix
AVector	getBand(int band) Gets a specific band of the matrix, as a view vector.
double	getDiagonalValue(int i)
ADiagonalMatrix	getTranspose() Returns a transposed version of this matrix.
ADiagonalMatrix	getTransposeView() Returns a transposed view of the array.
AMatrix	innerProduct(ADiagonalMatrix a)
AMatrix	innerProduct(AMatrix a)
Matrix	innerProduct(Matrix a)
boolean	isBoolean() Returns true if the array is boolean (contains only 0.0 or 1.0 values)
boolean	isDiagonal() Returns true iff a matrix is a square diagonal matrix
boolean	isFullyMutable() Returns true if the INDArray is fully mutable in all positions i.e.
boolean	isIdentity() Returns true if this transform is known to be the identity function, i.e.
boolean	isLowerTriangular() Returns true if a matrix is lower triangular
abstract boolean	isMutable() Returns true if the INDArray is mutable (at least partially)
boolean	isRectangularDiagonal()
boolean	isSquare() Returns true if the transform is square (same number of input and output dimensions)
boolean	isSymmetric() Returns true if a matrix is symmetric
boolean	isUpperTriangular() Returns true if a matrix is upper triangular
int	lowerBandwidthLimit() A limit on the lower bandwidth of the banded matrix.
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
Matrix	toMatrix() Coerces the matrix to the standard mutable Matrix type in row major order.
Matrix	toMatrixTranspose() Coerces the transpose of a matrix to the standard mutable Matrix type in row major order.
void	transform(Vector source, Vector dest)
void	transformInPlace(AArrayVector v)
void	transformInPlace(AVector v) Transforms a vector destructively.
Matrix	transposeInnerProduct(Matrix s)
void	transposeInPlace()
double	unsafeGetDiagonalValue(int i)
int	upperBandwidthLimit() A limit on the upper bandwidth of the banded matrix.
void	validate() Validates the internal data structure of the INDArray.

Methods inherited from class mikera.matrixx.impl.ABandedMatrix

elementSquaredSum, elementSum, fill, getRow, lowerBandwidth, nonZeroCount, upperBandwidth

Methods inherited from class mikera.matrixx.AMatrix

abs, add, add, add, add, add, addAt, addMultiple, addRowMultiple, applyOp, applyOp, asDoubleArray, asElementList, asVector, bandIndex, bandLength, bandLength, bandPosition, broadcast, broadcastCloneLike, broadcastLike, broadcastLike, calculateElement, clamp, clone, cloneRow, compose, compose, composeWith, composeWith, copyOfMatrix, copyOfTranslationVector, copyTo, dimensionality, divide, divide, elementCount, elementDiv, elementIterator, elementMul, ensureMutable, epsilonEquals, epsilonEquals, epsilonEquals, equals, equals, equals, equals, exactClone, exp, get, get, get, get, getBandWrapped, getColumn, getElements, getLeadingDiagonal, getLongShape, getMatrixComponent, getShape, getShape, getSlices, getSliceViews, getTransposeCopy, hashCode, hasOrthonormalColumns, hassOrthonormalRows, innerProduct, innerProduct, innerProduct, innerProduct, inputDimensions, inverse, isElementConstrained, isHermitian, isInvertible, isOrthogonal, isPositiveDefinite, isSameShape, isSameShape, isView, isZero, iterator, log, mul, multiply, multiply, multiplyRow, negate, outerProduct, outputDimensions, pow, reciprocal, reshape, reshape, scale, scaleAdd, set, set, set, set, set, set, setColumn, setElements, setElements, setRow, signum, slice, slice, sliceCount, sqrt, square, sub, sub, sub, sub, sub, subMatrix, swapColumns, swapRows, toAffineTransform, toArray, toDoubleArray, toDoubleBuffer, toMutableMatrix, toString, toVector, trace, transform, transform, transform, transposeInnerProduct, unsafeGet, unsafeSet

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

Methods inherited from class java.lang.Object

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

Field Detail

dimensions

protected final int dimensions

Constructor Detail

ADiagonalMatrix

public ADiagonalMatrix(int dimensions)

Method Detail

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 AMatrix

Returns:

isSymmetric

public boolean isSymmetric()

Description copied from class: AMatrix

Returns true if a matrix is symmetric

Overrides:

isSymmetric in class ABandedMatrix

isDiagonal

public boolean isDiagonal()

Description copied from class: AMatrix

Returns true iff a matrix is a square diagonal matrix

Overrides:

isDiagonal in class AMatrix

isRectangularDiagonal

public boolean isRectangularDiagonal()

Overrides:

isRectangularDiagonal in class AMatrix

isUpperTriangular

public boolean isUpperTriangular()

Description copied from class: AMatrix

Returns true if a matrix is upper triangular

Overrides:

isUpperTriangular in class ABandedMatrix

isLowerTriangular

public boolean isLowerTriangular()

Description copied from class: AMatrix

Returns true if a matrix is lower triangular

Overrides:

isLowerTriangular in class ABandedMatrix

isMutable

public abstract 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:

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 ABandedMatrix

Returns:

upperBandwidthLimit

public final int upperBandwidthLimit()

Description copied from class: AMatrix

A limit on the upper bandwidth of the banded matrix. Actual upper bandwidth is guaranteed to be less than or equal to this value

Specified by:

upperBandwidthLimit in class ABandedMatrix

Returns:

lowerBandwidthLimit

public final int lowerBandwidthLimit()

Description copied from class: AMatrix

A limit on the lower bandwidth of the banded matrix. Actual lower bandwidth is guaranteed to be less than or equal to this value

Specified by:

lowerBandwidthLimit in class ABandedMatrix

Returns:

getBand

public AVector getBand(int band)

Description copied from class: AMatrix

Gets a specific band of the matrix, as a view vector. The band is truncated at the edges of the matrix, i.e. it does not wrap around the matrix.

Specified by:

getBand in class ABandedMatrix

Returns:

determinant

public double determinant()

Description copied from class: AMatrix

Calculates the determinant of the matrix.

Overrides:

determinant in class AMatrix

dimensions

public int dimensions()

Returns the number of dimensions of this diagonal matrix

Returns:

copyRowTo

public void copyRowTo(int row,
             double[] dest,
             int destOffset)

Overrides:

copyRowTo in class AMatrix

copyColumnTo

public void copyColumnTo(int col,
                double[] dest,
                int destOffset)

Overrides:

copyColumnTo in class AMatrix

innerProduct

public AMatrix innerProduct(ADiagonalMatrix a)

innerProduct

public AMatrix innerProduct(AMatrix a)

Overrides:

innerProduct in class AMatrix

innerProduct

public Matrix innerProduct(Matrix a)

Overrides:

innerProduct in class AMatrix

transposeInnerProduct

public Matrix transposeInnerProduct(Matrix s)

Overrides:

transposeInnerProduct in class AMatrix

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 AMatrix

transformInPlace

public void transformInPlace(AArrayVector v)

Overrides:

transformInPlace in class AMatrix

transform

public void transform(Vector source,
             Vector dest)

Overrides:

transform in class AMatrix

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

isIdentity

public boolean isIdentity()

Description copied from class: ATransform

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

Overrides:

isIdentity in class AMatrix

isBoolean

public boolean isBoolean()

Description copied from interface: INDArray

Returns true if the array is boolean (contains only 0.0 or 1.0 values)

Specified by:

isBoolean in interface INDArray

Overrides:

isBoolean in class AMatrix

transposeInPlace

public void transposeInPlace()

Overrides:

transposeInPlace 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

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

getDiagonalValue

public double getDiagonalValue(int i)

unsafeGetDiagonalValue

public double unsafeGetDiagonalValue(int i)

getTranspose

public ADiagonalMatrix getTranspose()

Description copied from class: AMatrix

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

Specified by:

getTranspose in interface INDArray

Overrides:

getTranspose in class AMatrix

Returns:

getTransposeView

public ADiagonalMatrix getTransposeView()

Description copied from interface: INDArray

Returns a transposed view of the array. May throw UnsupportedOperationException if the array does not support this capability

Specified by:

getTransposeView in interface INDArray

Overrides:

getTransposeView in class AMatrix

Returns:

density

public double density()

Description copied from interface: ISparse

Computes the density ratio of this sparse array (proportion of non-zero elements)

Specified by:

density in interface ISparse

Returns:

toMatrix

public Matrix toMatrix()

Description copied from class: AMatrix

Coerces the matrix to the standard mutable Matrix type in row major order. Performs a copy if necessary.

Overrides:

toMatrix in class ABandedMatrix

toMatrixTranspose

public final Matrix toMatrixTranspose()

Description copied from class: AMatrix

Coerces the transpose of a matrix to the standard mutable Matrix type in row major order. Performs a copy if necessary.

Overrides:

toMatrixTranspose in class ABandedMatrix

validate

public void validate()

Description copied from interface: INDArray

Validates the internal data structure of the INDArray. Throws an exception on failure. Failure indicates a serious bug and/or data corruption.

Specified by:

validate in interface INDArray

Overrides:

validate in class ABandedMatrix