mikera.matrixx.impl

Class DiagonalMatrix

java.lang.Object

mikera.transformz.ATransform

mikera.transformz.AAffineTransform

mikera.transformz.ALinearTransform

mikera.matrixx.AMatrix

mikera.matrixx.impl.ABandedMatrix

mikera.matrixx.impl.ADiagonalMatrix

mikera.matrixx.impl.DiagonalMatrix

All Implemented Interfaces:

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

public final class DiagonalMatrix
extends ADiagonalMatrix

Specialised diagonal matrix class Not fully mutable - only the diagonal values can be changed

Author:

Mike

Field Summary

Fields inherited from class mikera.matrixx.impl.ADiagonalMatrix

dimensions

Constructor Summary

Constructors

Constructor and Description
DiagonalMatrix(int dimensions)

Method Summary

Methods

Modifier and Type	Method and Description
double	calculateElement(int i, AVector v) Calculates a single element of the output.
double	calculateElement(int i, Vector v)
DiagonalMatrix	clone() Clones the transform, performing a deep copy where needed
static DiagonalMatrix	create(AVector v)
static DiagonalMatrix	create(double... values)
static DiagonalMatrix	createDimensions(int dims)
double	determinant() Calculates the determinant of the matrix.
double	elementSum() Returns the sum of all elements in the matrix
DiagonalMatrix	exactClone() Returns an exact deep clone of an array (i.e.
double	get(int row, int column) Returns a specified element in the matrix
double	getDiagonalValue(int i)
Vector	getLeadingDiagonal() Returns a vector view of the leading diagonal values of the matrix
DiagonalMatrix	innerProduct(ADiagonalMatrix a)
AMatrix	innerProduct(AMatrix a)
DiagonalMatrix	inverse() Return the inverse of this transformation if possible
boolean	isBoolean() Returns true if the array is boolean (contains only 0.0 or 1.0 values)
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	isMutable() Returns true if the INDArray is mutable (at least partially)
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.
void	set(int row, int column, double value) Sets a specified element in the matrix
double	trace()
void	transform(Vector source, Vector dest)
void	transformInPlace(AArrayVector v)
void	transformInPlace(AVector v) Transforms a vector destructively.
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)

Methods inherited from class mikera.matrixx.impl.ADiagonalMatrix

columnCount, copyColumnTo, copyRowTo, density, dimensions, getBand, getTranspose, getTransposeView, innerProduct, isDiagonal, isLowerTriangular, isRectangularDiagonal, isSquare, isSymmetric, isUpperTriangular, lowerBandwidthLimit, rowCount, toMatrix, toMatrixTranspose, transposeInnerProduct, transposeInPlace, upperBandwidthLimit

Methods inherited from class mikera.matrixx.impl.ABandedMatrix

elementSquaredSum, fill, getRow, lowerBandwidth, 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, clamp, cloneRow, compose, compose, composeWith, composeWith, copyOfMatrix, copyOfTranslationVector, copyTo, dimensionality, divide, divide, elementCount, elementDiv, elementIterator, elementMul, ensureMutable, epsilonEquals, epsilonEquals, epsilonEquals, equals, equals, equals, equals, exp, get, get, get, getBandWrapped, getColumn, getElements, getLongShape, getMatrixComponent, getShape, getShape, getSlices, getSliceViews, getTransposeCopy, hashCode, hasOrthonormalColumns, hassOrthonormalRows, innerProduct, innerProduct, innerProduct, innerProduct, inputDimensions, isElementConstrained, isHermitian, isInvertible, isOrthogonal, isPositiveDefinite, isSameShape, isSameShape, isView, isZero, iterator, log, mul, 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, transform, transform, transform, transposeInnerProduct

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

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)

wrap

public static DiagonalMatrix wrap(double[] data)

trace

public double trace()

Overrides:

trace 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 ABandedMatrix

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 ABandedMatrix

Returns:

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:

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 class: AMatrix

Sets a specified element in the matrix

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

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 ADiagonalMatrix

Returns:

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

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 ADiagonalMatrix

calculateElement

public double calculateElement(int i,
                      Vector v)

Overrides:

calculateElement in class AMatrix

transform

public void transform(Vector source,
             Vector dest)

Overrides:

transform in class ADiagonalMatrix

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 ADiagonalMatrix

transformInPlace

public void transformInPlace(AArrayVector v)

Overrides:

transformInPlace in class ADiagonalMatrix

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 ADiagonalMatrix

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

clone

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

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: ATransform

Return the inverse of this transformation if possible

Overrides:

inverse in class AMatrix

Returns:

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

Overrides:

getLeadingDiagonal in class AMatrix

Returns:

innerProduct

public AMatrix innerProduct(AMatrix a)

Overrides:

innerProduct in class ADiagonalMatrix

innerProduct

public DiagonalMatrix innerProduct(ADiagonalMatrix a)

Overrides:

innerProduct in class ADiagonalMatrix

exactClone

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

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