mikera.matrixx.impl

Class IdentityMatrix

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

All Implemented Interfaces:

Serializable, Cloneable, Iterable<AVector>, INDArray, ISparse, IMatrix, IFastColumns, IFastRows

public class IdentityMatrix
extends ADiagonalMatrix
implements IFastRows, IFastColumns

Specialised identity matrix class. Immutable.

Author:

Mike

See Also:

Serialized Form

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)
static IdentityMatrix	create(int i)
double	determinant() Calculates the determinant of the matrix.
double	elementMax() Returns the maximum element value in this array.
double	elementMin() Returns the maximum element value in this array.
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.
ADiagonalMatrix	innerProduct(ADiagonalMatrix a)
AMatrix	innerProduct(AMatrix a)
Vector	innerProduct(AVector v)
Matrix	innerProduct(Matrix a)
AMatrix	inverse()
boolean	isBoolean() Returns true if the array is boolean (contains only 0.0 or 1.0 values)
boolean	isIdentity()
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)
void	transform(AVector source, AVector dest)
Vector	transform(Vector source)
void	transformInPlace(AArrayVector 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)

Methods inherited from class mikera.matrixx.impl.ADiagonalMatrix

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

Methods inherited from class mikera.matrixx.impl.ASingleBandMatrix

isZero

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, cloneColumn, cloneRow, compose, composeWith, copyTo, dimensionality, divide, divide, elementCount, elementDiv, elementIterator, elementMul, ensureMutable, epsilonEquals, epsilonEquals, epsilonEquals, equals, equals, equals, equals, equalsTranspose, exp, get, get, get, getBandWrapped, getElements, getLongShape, getShape, getShape, getShapeClone, getSlices, getSlices, getSliceViews, getTransposeCopy, hashCode, hasOrthonormalColumns, hasOrthonormalRows, immutable, innerProduct, innerProduct, innerProduct, inputDimensions, isElementConstrained, isHermitian, isInvertible, isPositiveDefinite, isSameShape, isSameShape, isView, iterator, join, log, mul, multiply, multiply, multiplyRow, mutable, negate, outerProduct, outputDimensions, pow, reciprocal, replaceColumn, replaceRow, reshape, reshape, rotateView, scaleAdd, set, set, set, set, set, set, setColumn, setElements, setElements, setRow, signum, slice, slice, sliceCount, sqrt, square, sub, sub, sub, sub, sub, subArray, subMatrix, swapColumns, swapRows, toAffineTransform, toArray, toDoubleArray, toDoubleBuffer, toMutableMatrix, toString, toVector, transposeInnerProduct, unsafeSet

Methods inherited from class mikera.arrayz.impl.AbstractArray

scale, sparse

Methods inherited from class java.lang.Object

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

Methods inherited from interface mikera.matrixx.IMatrix

columnCount, isInvertible, isSquare, rowCount

Methods inherited from interface mikera.arrayz.INDArray

abs, add, add, applyOp, applyOp, asDoubleArray, asElementList, asVector, broadcast, broadcastCloneLike, broadcastLike, clamp, clone, copyTo, dimensionality, divide, divide, elementCount, elementIterator, elementSquaredSum, ensureMutable, epsilonEquals, epsilonEquals, equals, exp, fill, get, get, get, getElements, getLongShape, getShape, getShape, getShapeClone, getSlices, getSlices, getSliceViews, getTranspose, getTransposeCopy, immutable, innerProduct, isElementConstrained, isFullyMutable, isSameShape, isView, isZero, join, log, multiply, multiply, mutable, negate, outerProduct, pow, reciprocal, reshape, rotateView, scale, scaleAdd, set, set, set, set, set, setElements, setElements, signum, slice, slice, sliceCount, sparse, sqrt, square, sub, sub, subArray, toArray, toDoubleArray, toDoubleBuffer, toVector, validate

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)

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

Specified by:

getColumn in interface IFastColumns

Specified by:

getColumn in interface IFastRows

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)

Specified by:

transform in interface IMatrix

Overrides:

transform in class AMatrix

transform

public Vector transform(AVector source)

Specified by:

transform in interface IMatrix

Overrides:

transform in class AMatrix

transform

public Vector transform(Vector source)

Overrides:

transform in class AMatrix

transformInPlace

public void transformInPlace(AVector v)

Specified by:

transformInPlace in interface IMatrix

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

Specified by:

getLeadingDiagonal in class ADiagonalMatrix

Returns:

isIdentity

public boolean isIdentity()

Overrides:

isIdentity in class ADiagonalMatrix

isOrthogonal

public boolean isOrthogonal()

Overrides:

isOrthogonal in class AMatrix

inverse

public AMatrix inverse()

Specified by:

inverse in interface IMatrix

Overrides:

inverse in class AMatrix

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 ASingleBandMatrix

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:

elementMin

public double elementMin()

Description copied from interface: INDArray

Returns the maximum element value in this array.

Specified by:

elementMin in interface INDArray

Overrides:

elementMin in class ADiagonalMatrix

Returns:

elementMax

public double elementMax()

Description copied from interface: INDArray

Returns the maximum element value in this array.

Specified by:

elementMax in interface INDArray

Overrides:

elementMax in class ADiagonalMatrix

Returns:

trace

public double trace()

Overrides:

trace in class ABandedMatrix

innerProduct

public ADiagonalMatrix innerProduct(ADiagonalMatrix a)

Overrides:

innerProduct in class ADiagonalMatrix

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 ADiagonalMatrix

Returns: