mikera.matrixx.impl

Class ABandedMatrix

java.lang.Object

mikera.transformz.ATransform

mikera.transformz.AAffineTransform

mikera.transformz.ALinearTransform

mikera.matrixx.AMatrix

mikera.matrixx.impl.ABandedMatrix

All Implemented Interfaces:

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

Direct Known Subclasses:

ADiagonalMatrix, BandedMatrix

public abstract class ABandedMatrix
extends AMatrix

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

Author:

Mike

Constructor Summary

Constructors

Constructor and Description
ABandedMatrix()

Method Summary

Methods

Modifier and Type	Method and Description
double	elementSquaredSum() Returns the squared sum of all elements in the matrix
double	elementSum() Returns the sum of all elements in the matrix
void	fill(double value) Fills the array with asingle double value
abstract AVector	getBand(int band) Gets a specific band of the matrix, as a view vector.
AVector	getRow(int row) Returns a row of the matrix as a vector view
boolean	isFullyMutable() Returns true if the INDArray is fully mutable in all positions i.e.
boolean	isLowerTriangular() Returns true if a matrix is lower triangular
boolean	isSymmetric() Returns true if a matrix is symmetric
boolean	isUpperTriangular() Returns true if a matrix is upper triangular
int	lowerBandwidth() Computes the lower bandwidth of a matrix
abstract int	lowerBandwidthLimit() A limit on the lower bandwidth of the banded matrix.
long	nonZeroCount() Returns the number of non-zero elements in the 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.
int	upperBandwidth() Computes the upper bandwidth of a matrix
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, add, addAt, addMultiple, addRowMultiple, applyOp, applyOp, asDoubleArray, asElementList, asVector, bandIndex, bandLength, bandLength, bandPosition, broadcast, broadcastCloneLike, broadcastLike, broadcastLike, calculateElement, calculateElement, clamp, clone, cloneRow, columnCount, compose, compose, composeWith, composeWith, copyColumnTo, copyOfMatrix, copyOfTranslationVector, copyRowTo, copyTo, determinant, dimensionality, divide, divide, elementCount, elementDiv, elementIterator, elementMul, ensureMutable, epsilonEquals, epsilonEquals, epsilonEquals, equals, equals, equals, equals, exactClone, exp, get, get, get, get, getBandWrapped, getColumn, getElements, getLeadingDiagonal, getLongShape, getMatrixComponent, getShape, getShape, getSlices, getSliceViews, getTranspose, getTransposeCopy, getTransposeView, hashCode, hasOrthonormalColumns, hassOrthonormalRows, innerProduct, innerProduct, innerProduct, innerProduct, innerProduct, innerProduct, inputDimensions, inverse, isBoolean, isDiagonal, isElementConstrained, isHermitian, isIdentity, isInvertible, isMutable, isOrthogonal, isPositiveDefinite, isRectangularDiagonal, isSameShape, isSameShape, isSquare, isView, isZero, iterator, log, mul, multiply, multiply, multiplyRow, negate, outerProduct, outputDimensions, pow, reciprocal, reshape, reshape, rowCount, scale, scaleAdd, set, 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, trace, transform, transform, transform, transform, transformInPlace, transformInPlace, transposeInnerProduct, transposeInnerProduct, transposeInPlace, unsafeGet, 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

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

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

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.

Overrides:

getBand in class AMatrix

Returns:

upperBandwidth

public int upperBandwidth()

Description copied from class: AMatrix

Computes the upper bandwidth of a matrix

Overrides:

upperBandwidth in class AMatrix

Returns:

lowerBandwidth

public int lowerBandwidth()

Description copied from class: AMatrix

Computes the lower bandwidth of a matrix

Overrides:

lowerBandwidth in class AMatrix

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 AMatrix

Returns:

isSymmetric

public boolean isSymmetric()

Description copied from class: AMatrix

Returns true if a matrix is symmetric

Overrides:

isSymmetric in class AMatrix

isUpperTriangular

public boolean isUpperTriangular()

Description copied from class: AMatrix

Returns true if a matrix is upper triangular

Overrides:

isUpperTriangular in class AMatrix

isLowerTriangular

public boolean isLowerTriangular()

Description copied from class: AMatrix

Returns true if a matrix is lower triangular

Overrides:

isLowerTriangular in class AMatrix

getRow

public AVector getRow(int row)

Description copied from class: AMatrix

Returns a row of the matrix as a vector view

Overrides:

getRow in class AMatrix

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

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 AMatrix

Returns:

elementSquaredSum

public double elementSquaredSum()

Description copied from class: AMatrix

Returns the squared sum of all elements in the matrix

Specified by:

elementSquaredSum in interface INDArray

Overrides:

elementSquaredSum in class AMatrix

Returns:

fill

public void fill(double value)

Description copied from interface: INDArray

Fills the array with asingle double value

Specified by:

fill in interface INDArray

Overrides:

fill 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

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