mikera.matrixx.impl

Class DiagonalMatrix

java.lang.Object

mikera.arrayz.impl.AbstractArray<AVector>

mikera.matrixx.AMatrix

mikera.matrixx.impl.ABandedMatrix

mikera.matrixx.impl.ASingleBandMatrix

mikera.matrixx.impl.ADiagonalMatrix

mikera.matrixx.impl.DiagonalMatrix

All Implemented Interfaces:

Serializable, Cloneable, Iterable<AVector>, INDArray, ISparse, IMatrix, IFastBands

public final class DiagonalMatrix
extends ADiagonalMatrix

Specialised diagonal matrix class, with dense double[] array storage for the leading diagonal only. Not fully mutable - only the diagonal values can be changed

Author:

Mike

See Also:

Serialized Form

Field Summary

Fields inherited from class mikera.matrixx.impl.ADiagonalMatrix

dimensions

Constructor Summary

Constructors

Constructor and Description
DiagonalMatrix(int dimensions)

Method Summary

Modifier and Type	Method and Description
AMatrix	clone() Returns a clone of the array data, as a new array which will be fully mutable and may be of a different class to the original.
static DiagonalMatrix	create(AMatrix m)
static DiagonalMatrix	create(AVector v)
static DiagonalMatrix	create(double... values)
static DiagonalMatrix	createDimensions(int dims)
double	determinant() Calculates the determinant of the matrix.
double	diagonalProduct() Computes the product of entries on the main diagonal of a matrix
double	elementSum() Returns the sum of all elements in this matrix
DiagonalMatrix	exactClone() Creates a deep clone of an array, using the same class implementation as the original array
double	get(int row, int column) Returns the double value at the specified position in a 2D matrix
double	getDiagonalValue(int i)
Vector	getLeadingDiagonal() Returns a vector view of the leading diagonal values of the matrix
AMatrix	innerProduct(ADiagonalMatrix a) Computes the inner product of this matrix with another diagonal matrix of the same shape.
AMatrix	innerProduct(AMatrix a) Computes the inner product of this matrix with another.
DiagonalMatrix	inverse() Computes the inverse of a matrix.
boolean	isBoolean() Returns true if the array is boolean (contains only 0.0 or 1.0 values)
boolean	isFullyMutable() If this method returns true, the INDArray is guaranteed to be fully mutable in all positions i.e.
boolean	isIdentity() Checks if this is an identity matrix (i.e.
boolean	isMutable() Returns true if the INDArray is mutable (at least partially)
boolean	isZero() Returns true if the matrix is the zero matrix (all components zero)
void	multiply(double factor) Multiplies all elements of the array in place by a given double value
DiagonalMatrix	multiplyCopy(double factor) Returns a copy of the array with all elements multiplied by a single constant value
long	nonZeroCount() Returns the number of non-zero elements in the array.
double	rowDotProduct(int i, AVector v) Returns the dot product of a specific row with a vector.
void	set(int row, int column, double value) Sets a value at a given position in a mutable 2D array
double	trace() Computes the trace of a matrix, i.e.
void	transform(Vector source, Vector dest)
void	transformInPlace(ADenseArrayVector v)
void	transformInPlace(AVector v)
double	unsafeGet(int row, int column) Gets an element in the matrix in an unsafe fashion, without performing bound checks The result is undefined if the row and column are out of bounds.
double	unsafeGetDiagonalValue(int i)
void	unsafeSet(int row, int column, double value) Sets an element value in the matrix in an unsafe fashion, without performing bound checks The result is undefined if the row and column are out of bounds.
void	validate() Validates the internal data structure of the INDArray.
static DiagonalMatrix	wrap(double[] data)
static DiagonalMatrix	wrap(Vector data)

Methods inherited from class mikera.matrixx.impl.ADiagonalMatrix

addCopy, addToArray, checkIndex, checkSameShape, checkSameShape, checkSquare, columnCount, copyColumnTo, copyRowTo, density, dimensions, elementAbsPowSum, elementMax, elementMin, elementPowSum, elementSquaredSum, equalsTranspose, getBand, getColumn, getNonZeroBand, getRow, getTranspose, getTransposeView, hasUncountable, isDiagonal, isLowerTriangular, isRectangularDiagonal, isSameShape, isSameShape, isSquare, isSymmetric, isUpperTriangular, lowerBandwidthLimit, nonZeroBand, rank, rowCount, toDoubleArray, toMatrix, toMatrixTranspose, transposeInnerProduct, transposeInPlace, upperBandwidthLimit

Methods inherited from class mikera.matrixx.impl.ASingleBandMatrix

isSparse, subMatrix

Methods inherited from class mikera.matrixx.impl.ABandedMatrix

fill, getRowView, lowerBandwidth, upperBandwidth

Methods inherited from class mikera.matrixx.AMatrix

abs, add, add, add, add, add2, addAt, addCopy, addCopy, addCopy, addCopy, addInnerProduct, addInnerProduct, addInnerProduct, addMultiple, addMultiple, addMultiple, addOuterProduct, addOuterProduct, addRowMultiple, applyOp, applyOp, applyOp, applyOp, applyOp, applyOp, applyOpCopy, asDoubleArray, asElementList, asVector, bandIndex, bandLength, bandLength, bandPosition, bandStartColumn, bandStartRow, broadcast, broadcastCloneLike, broadcastCopyLike, broadcastLike, broadcastLike, checkColumn, checkColumnCount, checkDimension, checkRow, checkRowCount, checkShape, clamp, composeWith, copy, dense, denseClone, dimensionality, divide, divide, divide, divide, elementCount, elementIterator, elementsEqual, ensureMutable, epsilonEquals, epsilonEquals, epsilonEquals, epsilonEquals, equals, equals, equals, equalsArray, equalsByRows, exp, get, get, get, getBandWrapped, getColumnClone, getColumns, getColumnView, getElements, getLongShape, getRowClone, getRows, getShape, getShape, getShapeClone, getSlices, getSlices, getSliceViews, getTransposeCopy, hashCode, hasOrthonormalColumns, hasOrthonormalRows, immutable, innerProduct, innerProduct, innerProduct, innerProduct, innerProduct, inputDimensions, isElementConstrained, isHermitian, isInvertible, isOrthogonal, isOrthogonal, isPositiveDefinite, isSameShape, isView, iterator, join, log, mul, multiply, multiply, multiply, multiplyRow, mutable, negate, outerProduct, outputDimensions, pow, reciprocal, reduce, reduce, reduceSlices, reduceSlices, reorder, reorder, replaceColumn, replaceRow, reshape, reshape, rotateView, scaleAdd, scaleAdd, set, set, set, set, set, set, set, set, setColumn, setElements, setElements, setRow, signum, slice, slice, sliceCount, sparse, sparseClone, sqrt, square, sub, sub, sub, subArray, swapColumns, swapRows, toAffineTransform, toArray, toDoubleBuffer, toMutableMatrix, toNestedDoubleArrays, toSliceArray, toString, toStringFull, toVector, transform, transposeInnerProduct

Methods inherited from class mikera.arrayz.impl.AbstractArray

absCopy, add, addAt, addInnerProduct, addPower, addPower, broadcastLike, checkMutable, componentCount, divideCopy, elementProduct, equals, equalsArray, get, get, get, get, get, getComponent, getComponents, getElements, getElements, getElements, isDense, join, multiplyCopy, negateCopy, reciprocalCopy, scale, scaleCopy, setElements, setInnerProduct, setMultiple, setMultiple, signumCopy, sliceValue, squareCopy, sub, sub, subCopy, withComponents

Methods inherited from class java.lang.Object

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

Methods inherited from interface mikera.arrayz.INDArray

absCopy, addAt, addPower, addPower, broadcastLike, checkMutable, componentCount, divideCopy, elementProduct, equalsArray, get, get, get, get, get, getComponent, getComponents, getElements, getElements, getElements, isDense, join, multiplyCopy, negateCopy, reciprocalCopy, scale, scaleCopy, setElements, setInnerProduct, setMultiple, setMultiple, signumCopy, sliceValue, squareCopy, sub, subCopy, withComponents

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

DiagonalMatrix

public DiagonalMatrix(int dimensions)

Method Detail

createDimensions

public static DiagonalMatrix createDimensions(int dims)

create

public static DiagonalMatrix create(double... values)

create

public static DiagonalMatrix create(AVector v)

create

public static DiagonalMatrix create(AMatrix m)

wrap

public static DiagonalMatrix wrap(double[] data)

wrap

public static DiagonalMatrix wrap(Vector data)

trace

public double trace()

Description copied from interface: IMatrix

Computes the trace of a matrix, i.e. the sum of all elements on the leading diagonal

Specified by:

trace in interface IMatrix

Overrides:

trace in class ADiagonalMatrix

Returns:

diagonalProduct

public double diagonalProduct()

Description copied from class: AMatrix

Computes the product of entries on the main diagonal of a matrix

Specified by:

diagonalProduct in interface IMatrix

Overrides:

diagonalProduct in class ADiagonalMatrix

Returns:

elementSum

public double elementSum()

Description copied from class: AMatrix

Returns the sum of all elements in this matrix

Specified by:

elementSum in interface INDArray

Overrides:

elementSum in class ADiagonalMatrix

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 ADiagonalMatrix

get

public double get(int row,
                  int column)

Description copied from interface: INDArray

Returns the double value at the specified position in a 2D matrix

Specified by:

get in interface INDArray

Specified by:

get in interface IMatrix

Specified by:

get in class AMatrix

unsafeGet

public double unsafeGet(int row,
                        int column)

Description copied from class: AMatrix

Gets an element in the matrix in an unsafe fashion, without performing bound checks The result is undefined if the row and column are out of bounds.

Overrides:

unsafeGet in class AMatrix

Returns:

set

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

Description copied from interface: INDArray

Sets a value at a given position in a mutable 2D array

Specified by:

set in interface INDArray

Specified by:

set in interface IMatrix

Overrides:

set in class ADiagonalMatrix

unsafeSet

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

Description copied from class: AMatrix

Sets an element value in the matrix in an unsafe fashion, without performing bound checks The result is undefined if the row and column are out of bounds.

Overrides:

unsafeSet in class AMatrix

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

Specified by:

isMutable in class ADiagonalMatrix

isFullyMutable

public boolean isFullyMutable()

Description copied from interface: INDArray

If this method returns true, the INDArray is guaranteed to be 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 ADiagonalMatrix

multiply

public void multiply(double factor)

Description copied from interface: INDArray

Multiplies all elements of the array in place by a given double value

Specified by:

multiply in interface INDArray

Overrides:

multiply in class ABandedMatrix

multiplyCopy

public DiagonalMatrix multiplyCopy(double factor)

Description copied from interface: INDArray

Returns a copy of the array with all elements multiplied by a single constant value

Specified by:

multiplyCopy in interface INDArray

Overrides:

multiplyCopy in class AMatrix

Parameters:

factor - A scalar factor

Returns:

A new array, with all element values scaled by the given factor

rowDotProduct

public double rowDotProduct(int i,
                            AVector v)

Description copied from class: AMatrix

Returns the dot product of a specific row with a vector. Unsafe operation: performs no bounds checking

Overrides:

rowDotProduct in class ADiagonalMatrix

Returns:

transform

public void transform(Vector source,
                      Vector dest)

Overrides:

transform in class ADiagonalMatrix

transformInPlace

public void transformInPlace(AVector v)

Specified by:

transformInPlace in interface IMatrix

Overrides:

transformInPlace in class ADiagonalMatrix

transformInPlace

public void transformInPlace(ADenseArrayVector v)

Overrides:

transformInPlace in class ADiagonalMatrix

isIdentity

public boolean isIdentity()

Description copied from interface: IMatrix

Checks if this is an identity matrix (i.e. 1.0 in leading diagonal, 0.0 elsewhere)

Specified by:

isIdentity in interface IMatrix

Overrides:

isIdentity in class ADiagonalMatrix

Returns:

true if this matrix is a square identity matrix, false otherwise.

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 ADiagonalMatrix

isZero

public boolean isZero()

Description copied from class: AMatrix

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

Specified by:

isZero in interface INDArray

Overrides:

isZero in class ADiagonalMatrix

clone

public AMatrix clone()

Description copied from interface: INDArray

Returns a clone of the array data, as a new array which will be fully mutable and may be of a different class to the original. Clone should attempt to return the most efficient possible array type. Clone should preserve sparsity property where possible, but this is not guaranteed.

Specified by:

clone in interface INDArray

Overrides:

clone in class ADiagonalMatrix

determinant

public double determinant()

Description copied from class: AMatrix

Calculates the determinant of the matrix.

Overrides:

determinant in class ADiagonalMatrix

inverse

public DiagonalMatrix inverse()

Description copied from class: AMatrix

Computes the inverse of a matrix. Returns null if the matrix is singular. Throws an Exception is the matrix is not square

Specified by:

inverse in interface IMatrix

Overrides:

inverse in class AMatrix

Returns:

A matrix which is the inverse of this matrix, or null if the inverse does not exist.

getDiagonalValue

public double getDiagonalValue(int i)

Overrides:

getDiagonalValue in class ADiagonalMatrix

unsafeGetDiagonalValue

public double unsafeGetDiagonalValue(int i)

Overrides:

unsafeGetDiagonalValue in class ADiagonalMatrix

getLeadingDiagonal

public Vector getLeadingDiagonal()

Description copied from class: AMatrix

Returns a vector view of the leading diagonal values of the matrix

Specified by:

getLeadingDiagonal in class ADiagonalMatrix

Returns:

innerProduct

public AMatrix innerProduct(AMatrix a)

Description copied from interface: IMatrix

Computes the inner product of this matrix with another. Equivalent to matrix x matrix multiplication

Specified by:

innerProduct in interface IMatrix

Overrides:

innerProduct in class ADiagonalMatrix

Returns:

innerProduct

public AMatrix innerProduct(ADiagonalMatrix a)

Description copied from class: ADiagonalMatrix

Computes the inner product of this matrix with another diagonal matrix of the same shape. The result will be a diagnonal matrix of the same shape.

Overrides:

innerProduct in class ADiagonalMatrix

Returns:

exactClone

public DiagonalMatrix exactClone()

Description copied from interface: INDArray

Creates a deep clone of an array, using the same class implementation as the original array

Specified by:

exactClone in interface INDArray

Specified by:

exactClone in class ADiagonalMatrix

Returns:

A clone of the original array

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 ADiagonalMatrix