mikera.matrixx.impl

Class ABandedMatrix

java.lang.Object

mikera.arrayz.impl.AbstractArray<AVector>

mikera.matrixx.AMatrix

mikera.matrixx.impl.ABandedMatrix

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.lang.Comparable<INDArray>, java.lang.Iterable<AVector>, INDArray, IMatrix, IFastBands

Direct Known Subclasses:

ASingleBandMatrix, BandedMatrix

public abstract class ABandedMatrix
extends AMatrix
implements IFastBands

Abstract base class for banded matrices Banded matrix implementations are assumed to store their data efficiently in diagonal bands, so functions on banded matrices can be designed to exploit this fact. May be either square or rectangular

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ABandedMatrix()

Method Summary

Modifier and Type	Method and Description
void	addToArray(double[] data, int offset) Adds all the elements of this array to a double array at the specified offset, in row-major order
void	copyRowTo(int row, double[] dest, int destOffset) Copies the elements in a selected row of this matrix to a double array
double	density()
double	diagonalProduct() Computes the product of entries on the main diagonal of a matrix
double	elementSquaredSum() Returns the squared sum of all elements in this matrix
double	elementSum() Returns the sum of all elements in this matrix
void	fill(double value) Fills this array with a single double value.
abstract AVector	getBand(int band) Gets a specific band of the matrix, as a view vector.
AVector	getRowView(int row) Returns a row of the matrix as a vector view.
boolean	isFullyMutable() If this method returns true, the INDArray is guaranteed to be fully mutable in all positions i.e.
boolean	isLowerTriangular() Returns true if a matrix is lower triangular.
boolean	isMutable() Returns true if the INDArray is mutable (at least partially)
boolean	isSparse() Returns true if the array is in a sparse format
boolean	isSymmetric() Returns true if a matrix is symmetric
boolean	isUpperTriangular() Returns true if a matrix is upper triangular An upper triangular matrix is defined as having all elements equal to 0.0 where i > j
boolean	isZero() Returns true if the matrix is the zero matrix (all components zero)
int	lowerBandwidth() Computes the lower bandwidth of a matrix, i.e.
abstract int	lowerBandwidthLimit() A limit on the lower bandwidth of the banded matrix.
void	multiply(double value) Multiplies all elements of the array in place by a given double value
long	nonZeroCount() Returns the number of non-zero elements in the array.
void	setSparse(double value) Sets the non-sparse elements of this array to the specified value May throw an exception if non-sparse elements are not mutable
double[]	toDoubleArray() Copies the elements of this array to a new double[] array.
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.
double	trace() Computes the trace of a matrix, i.e.
int	upperBandwidth() Computes the upper bandwidth of a matrix, i.e.
abstract 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.AMatrix

abs, add, add, add, add, add2, addAt, addCopy, addCopy, addCopy, addCopy, addCopy, addInnerProduct, addInnerProduct, addInnerProduct, addMultiple, addMultiple, addMultiple, addOuterProduct, addOuterProduct, addOuterProductSparse, addOuterProductSparse, addRowMultiple, addSparse, addSparse, applyOp, applyOp, applyOp, applyOp, applyOp, applyOp, applyOpCopy, asDoubleArray, asElementList, asVector, bandIndex, bandLength, bandPosition, bandStartColumn, bandStartRow, broadcast, broadcastCloneLike, broadcastCopyLike, broadcastLike, broadcastLike, checkColumn, checkRow, checkSquare, clamp, clone, composeWith, copy, copyColumnTo, dense, denseClone, determinant, dimensionality, divide, divide, divide, divide, divideCopy, elementCount, elementIterator, elementsEqual, ensureMutable, epsilonEquals, epsilonEquals, epsilonEquals, equals, equals, equals, equalsArray, equalsTranspose, exactClone, exp, get, get, get, get, get, getBandWrapped, getColumn, getColumnClone, getColumns, getColumnView, getElement, getElements, getLeadingDiagonal, getLongShape, getRow, getRowClone, getRows, getShape, getShape, getShapeClone, getSlices, getSlices, getSliceViews, getTranspose, getTransposeCopy, getTransposeView, hashCode, hasOrthonormalColumns, hasOrthonormalRows, hasUncountable, immutable, innerProduct, innerProduct, innerProduct, innerProduct, innerProduct, innerProduct, inputDimensions, inverse, isBoolean, isDiagonal, isElementConstrained, isHermitian, isIdentity, isInvertible, isOrthogonal, isOrthogonal, isPositiveDefinite, isRectangularDiagonal, isSameShape, isSameShape, isSquare, isView, iterator, join, log, mul, multiply, multiply, multiply, multiplyCopy, multiplyRow, mutable, negate, outerProduct, outputDimensions, pow, rank, reciprocal, reduce, reduce, reduceSlices, reduceSlices, reorder, reorder, replaceColumn, replaceRow, reshape, reshape, rotateView, rowDotProduct, scaleAdd, scaleAdd, set, set, set, set, set, set, set, set, set, setApplyOp, setApplyOp, setColumn, setElements, setElements, setMultiple, setMultiple, setMultiple, setMultiple, setMultiple, setRow, setSparse, setSparse, signum, slice, slice, sliceCount, sparse, sparseClone, sqrt, square, sub, sub, sub, subArray, subCopy, subMatrix, swapColumns, swapRows, toAffineTransform, toDoubleBuffer, toMutableMatrix, toNestedDoubleArrays, toSliceArray, toString, toStringFull, toVector, transform, transform, transformInPlace, transformInPlace, transposeInnerProduct, transposeInnerProduct, transposeInPlace, unsafeGet, unsafeSet

Methods inherited from class mikera.arrayz.impl.AbstractArray

absCopy, absDiff, absDiffCopy, add, addApplyOp, addAt, addCopy, addInnerProduct, addInnerProduct, addMultipleSparse, addPower, addPower, addSparse, broadcastLike, compareTo, componentCount, divideCopy, elementAbsPowSum, elementMax, elementMaxAbs, elementMin, elementPowSum, elementProduct, epsilonEquals, equals, equalsArray, get, get, get, get, getComponent, getComponents, getElements, getElements, getElements, isDense, join, multiplyCopy, negateCopy, reciprocalCopy, scale, scaleCopy, setElements, setInnerProduct, signumCopy, sliceValue, squareCopy, sub, sub, subCopy, withComponents

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface mikera.matrixx.IMatrix

columnCount, rowCount

Methods inherited from interface mikera.arrayz.INDArray

absCopy, absDiff, absDiffCopy, addApplyOp, addAt, addInnerProduct, addMultipleSparse, addPower, addPower, addSparse, broadcastLike, componentCount, divideCopy, elementAbsPowSum, elementMax, elementMaxAbs, elementMin, elementPowSum, elementProduct, epsilonEquals, equalsArray, get, get, get, get, getComponent, getComponents, getElements, getElements, getElements, isDense, join, multiplyCopy, negateCopy, reciprocalCopy, scale, scaleCopy, setElements, setInnerProduct, signumCopy, sliceValue, squareCopy, sub, subCopy, withComponents

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

ABandedMatrix

public ABandedMatrix()

Method Detail

upperBandwidthLimit

public abstract 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. Implementation should be O(1).

Overrides:

upperBandwidthLimit in class AMatrix

Returns:

lowerBandwidthLimit

public abstract 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. Implementation should be O(1).

Overrides:

lowerBandwidthLimit in class AMatrix

Returns:

getBand

public abstract 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 interface IMatrix

Specified by:

getBand in interface IFastBands

Overrides:

getBand in class AMatrix

Returns:

upperBandwidth

public int upperBandwidth()

Description copied from class: AMatrix

Computes the upper bandwidth of a matrix, i.e. the number of bands above the leading diagonal that cover all non-zero values

Overrides:

upperBandwidth in class AMatrix

Returns:

lowerBandwidth

public int lowerBandwidth()

Description copied from class: AMatrix

Computes the lower bandwidth of a matrix, i.e. the number of bands below the leading diagonal that cover all non-zero values

Overrides:

lowerBandwidth in class AMatrix

Returns:

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

Overrides:

isMutable in class AMatrix

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

Specified by:

isFullyMutable in class AMatrix

isSymmetric

public boolean isSymmetric()

Description copied from class: AMatrix

Returns true if a matrix is symmetric

Specified by:

isSymmetric in interface IMatrix

Overrides:

isSymmetric in class AMatrix

Returns:

isUpperTriangular

public boolean isUpperTriangular()

Description copied from class: AMatrix

Returns true if a matrix is upper triangular An upper triangular matrix is defined as having all elements equal to 0.0 where i > j

Overrides:

isUpperTriangular in class AMatrix

isLowerTriangular

public boolean isLowerTriangular()

Description copied from class: AMatrix

Returns true if a matrix is lower triangular. A lower triangular matrix is defined as having all elements equal to 0.0 where i < j

Overrides:

isLowerTriangular in class AMatrix

getRowView

public AVector getRowView(int row)

Description copied from interface: IMatrix

Returns a row of the matrix as a vector view. May be used to modify the original matrix.

Specified by:

getRowView in interface IMatrix

Overrides:

getRowView in class AMatrix

copyRowTo

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

Description copied from class: AMatrix

Copies the elements in a selected row of this matrix to a double array

Overrides:

copyRowTo in class AMatrix

Parameters:

row - The index of the selected row

dest - Destination double[] array

destOffset - Offset into destination array

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 AMatrix

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 AMatrix

isSparse

public boolean isSparse()

Description copied from interface: INDArray

Returns true if the array is in a sparse format

Specified by:

isSparse in interface INDArray

Overrides:

isSparse in class AbstractArray<AVector>

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 AMatrix

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 AMatrix

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 AMatrix

Returns:

elementSquaredSum

public double elementSquaredSum()

Description copied from class: AMatrix

Returns the squared sum of all elements in this matrix

Specified by:

elementSquaredSum in interface INDArray

Overrides:

elementSquaredSum in class AMatrix

fill

public void fill(double value)

Description copied from interface: INDArray

Fills this array with a single double value. Requires the array to be mutable.

Specified by:

fill in interface INDArray

Overrides:

fill in class AMatrix

setSparse

public void setSparse(double value)

Description copied from interface: INDArray

Sets the non-sparse elements of this array to the specified value May throw an exception if non-sparse elements are not mutable

Specified by:

setSparse in interface INDArray

Overrides:

setSparse in class AbstractArray<AVector>

multiply

public void multiply(double value)

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 AMatrix

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 AMatrix

toMatrixTranspose

public 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 AMatrix

addToArray

public void addToArray(double[] data,
                       int offset)

Description copied from interface: INDArray

Adds all the elements of this array to a double array at the specified offset, in row-major order

Specified by:

addToArray in interface INDArray

Overrides:

addToArray in class AMatrix

toDoubleArray

public double[] toDoubleArray()

Description copied from interface: INDArray

Copies the elements of this array to a new double[] array.

Specified by:

toDoubleArray in interface INDArray

Overrides:

toDoubleArray in class AMatrix

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 AMatrix

density

public double density()

Overrides:

density in class AbstractArray<AVector>