mikera.matrixx.impl

Class IdentityMatrix

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.IdentityMatrix

All Implemented Interfaces:

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

public class IdentityMatrix
extends ADiagonalMatrix

Specialised identity matrix class. Immutable.

Author:

Mike

Field Summary

Fields inherited from class mikera.matrixx.impl.ADiagonalMatrix

dimensions

Method Summary

Methods

Modifier and Type	Method and Description
double	calculateElement(int i, AVector v) Calculates a single element of the output.
static IdentityMatrix	create(int i)
double	determinant() Calculates the determinant of the matrix.
double	elementSum() Returns the sum of all elements in the matrix
IdentityMatrix	exactClone() Returns an exact deep clone of an array (i.e.
double	get(int row, int column) Returns a specified element in the matrix
AxisVector	getColumn(int column) Returns a column of the matrix as a vector view
double	getDiagonalValue(int i)
AVector	getLeadingDiagonal() Returns a vector view of the leading diagonal values of the matrix
AxisVector	getRow(int row) Returns a row of the matrix as a vector view
IdentityMatrix	getTransposeView() Returns a transposed view of the array.
AMatrix	innerProduct(AMatrix a)
Vector	innerProduct(AVector v)
Matrix	innerProduct(Matrix a)
AMatrix	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	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)
boolean	isOrthogonal()
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()
Vector	transform(AVector source) Transforms a vector, returning a new transformed vector
void	transform(AVector source, AVector dest) Transforms the source vector, storing the result in the given destination vector
Vector	transform(Vector source) Transforms a vector, returning a new transformed vector
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)

Methods inherited from class mikera.matrixx.impl.ADiagonalMatrix

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

Methods inherited from class mikera.matrixx.impl.ABandedMatrix

elementSquaredSum, fill, 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, 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, exp, get, get, get, getBandWrapped, getElements, getLongShape, getMatrixComponent, getShape, getShape, getSlices, getSliceViews, getTransposeCopy, hashCode, hasOrthonormalColumns, hassOrthonormalRows, innerProduct, innerProduct, innerProduct, inputDimensions, isElementConstrained, isHermitian, isInvertible, 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, transposeInnerProduct, 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

Method Detail

create

public static IdentityMatrix create(int i)

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:

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

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

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:

getRow

public AxisVector getRow(int row)

Description copied from class: AMatrix

Returns a row of the matrix as a vector view

Overrides:

getRow in class ABandedMatrix

getColumn

public AxisVector getColumn(int column)

Description copied from class: AMatrix

Returns a column of the matrix as a vector view

Overrides:

getColumn in class AMatrix

getDiagonalValue

public double getDiagonalValue(int i)

Overrides:

getDiagonalValue in class ADiagonalMatrix

unsafeGetDiagonalValue

public double unsafeGetDiagonalValue(int i)

Overrides:

unsafeGetDiagonalValue in class ADiagonalMatrix

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

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

Specified by:

transform in interface ITransform

Overrides:

transform in class AMatrix

transform

public Vector transform(AVector source)

Description copied from class: ATransform

Transforms a vector, returning a new transformed vector

Overrides:

transform in class AMatrix

Returns:

transform

public Vector transform(Vector source)

Description copied from class: ATransform

Transforms a vector, returning a new transformed vector

Overrides:

transform in class AMatrix

Returns:

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

getLeadingDiagonal

public AVector getLeadingDiagonal()

Description copied from class: AMatrix

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

Overrides:

getLeadingDiagonal in class AMatrix

Returns:

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

isOrthogonal

public boolean isOrthogonal()

Overrides:

isOrthogonal in class AMatrix

inverse

public AMatrix inverse()

Description copied from class: ATransform

Return the inverse of this transformation if possible

Overrides:

inverse in class AMatrix

Returns:

determinant

public double determinant()

Description copied from class: AMatrix

Calculates the determinant of the matrix.

Overrides:

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

Returns:

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:

trace

public double trace()

Overrides:

trace in class AMatrix

innerProduct

public AMatrix innerProduct(AMatrix a)

Overrides:

innerProduct in class ADiagonalMatrix

innerProduct

public Matrix innerProduct(Matrix a)

Overrides:

innerProduct in class ADiagonalMatrix

innerProduct

public Vector innerProduct(AVector v)

Overrides:

innerProduct in class AMatrix

getTransposeView

public IdentityMatrix 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 ADiagonalMatrix

Returns:

exactClone

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