mikera.matrixx.impl

Class BandedMatrix

java.lang.Object

mikera.arrayz.impl.AbstractArray<AVector>

mikera.matrixx.AMatrix

mikera.matrixx.impl.ABandedMatrix

mikera.matrixx.impl.BandedMatrix

All Implemented Interfaces:

Serializable, Cloneable, Iterable<AVector>, INDArray, IMatrix, IFastBands

public class BandedMatrix
extends ABandedMatrix

Sparse banded matrix implementation. Composed of a list of diagonal bands.

Author:

Mike

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
void	addAt(int i, int j, double d) Adds a value at a specific position in the matrix, mutating the matrix Does not perform bounds checking - this in an unsafe operation
int	columnCount() Gets the number of columns in this matrix (dimension 1)
static BandedMatrix	create(AMatrix m)
static BandedMatrix	create(int rowCount, int columnCount, int minBand, int maxBand)
BandedMatrix	exactClone() Creates a deep clone of an array, using the same class implementation as the original array
double	get(int i, int j) Returns the double value at the specified position in a 2D matrix
AVector	getBand(int band) Gets a specific band of the matrix, as a view vector.
BandedMatrix	getTranspose() Returns the transpose of this array.
boolean	isView() Return true if this array is considered as a view type.
int	lowerBandwidthLimit() A limit on the lower bandwidth of the banded matrix.
int	rowCount() Gets the number of rows in this matrix (dimension 0)
void	set(int i, int j, double value) Sets a value at a given position in a mutable 2D array
void	transform(AVector source, AVector dest) Transforms a source vector into a destination vector, using matrix multiplication (inner product).
void	transform(Vector source, Vector dest)
double	unsafeGet(int i, int j) 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.
void	unsafeSet(int i, int j, 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.
int	upperBandwidthLimit() A limit on the upper bandwidth of the banded matrix.
void	validate() Validates the internal data structure of the INDArray.
static BandedMatrix	wrap(int rowCount, int columnCount, int minBand, int maxBand, AVector... bands)

Methods inherited from class mikera.matrixx.impl.ABandedMatrix

addToArray, copyRowTo, density, diagonalProduct, elementSquaredSum, elementSum, fill, getRowView, isFullyMutable, isLowerTriangular, isMutable, isSparse, isSymmetric, isUpperTriangular, isZero, lowerBandwidth, multiply, nonZeroCount, toDoubleArray, toMatrix, toMatrixTranspose, trace, upperBandwidth

Methods inherited from class mikera.matrixx.AMatrix

abs, add, add, add, add, add2, addCopy, addCopy, addCopy, addCopy, addCopy, addInnerProduct, addInnerProduct, addInnerProduct, addMultiple, addMultiple, addMultiple, addOuterProduct, addOuterProduct, addRowMultiple, applyOp, applyOp, applyOp, applyOp, applyOp, applyOp, applyOpCopy, asDoubleArray, asElementList, asVector, bandIndex, bandLength, bandLength, bandPosition, bandStartColumn, bandStartRow, broadcast, broadcastCloneLike, broadcastCopyLike, broadcastLike, broadcastLike, checkColumn, checkColumnCount, checkDimension, checkIndex, checkRow, checkRowCount, checkSameShape, checkSameShape, checkShape, checkSquare, clamp, clone, composeWith, copy, copyColumnTo, dense, denseClone, determinant, dimensionality, divide, divide, divide, divide, elementCount, elementIterator, elementsEqual, ensureMutable, epsilonEquals, epsilonEquals, epsilonEquals, epsilonEquals, equals, equals, equals, equalsArray, equalsByRows, equalsTranspose, exp, get, get, get, getBandWrapped, getColumn, getColumnClone, getColumns, getColumnView, getElements, getLeadingDiagonal, getLongShape, getRow, getRowClone, getRows, getShape, getShape, getShapeClone, getSlices, getSlices, getSliceViews, 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, 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, setColumn, setElements, setElements, setRow, signum, slice, slice, sliceCount, sparse, sparseClone, sqrt, square, sub, sub, sub, subArray, subMatrix, swapColumns, swapRows, toAffineTransform, toArray, toDoubleBuffer, toMutableMatrix, toNestedDoubleArrays, toSliceArray, toString, toStringFull, toVector, transformInPlace, transformInPlace, transposeInnerProduct, transposeInnerProduct, transposeInPlace

Methods inherited from class mikera.arrayz.impl.AbstractArray

absCopy, add, addAt, addInnerProduct, addPower, addPower, broadcastLike, checkMutable, componentCount, divideCopy, elementAbsPowSum, elementMax, elementMin, elementPowSum, elementProduct, equals, equalsArray, get, get, get, get, get, getComponent, getComponents, getElements, getElements, getElements, isDense, join, multiplyCopy, negateCopy, reciprocalCopy, scale, scaleCopy, setElements, setInnerProduct, setMultiple, setMultiple, signumCopy, sliceValue, squareCopy, sub, sub, subCopy, withComponents

Methods inherited from class java.lang.Object

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

Methods inherited from interface mikera.arrayz.INDArray

absCopy, addAt, addPower, addPower, broadcastLike, checkMutable, componentCount, divideCopy, elementAbsPowSum, elementMax, elementMin, elementPowSum, elementProduct, equalsArray, get, get, get, get, get, getComponent, getComponents, getElements, getElements, getElements, isDense, join, multiplyCopy, negateCopy, reciprocalCopy, scale, scaleCopy, setElements, setInnerProduct, setMultiple, setMultiple, signumCopy, sliceValue, squareCopy, sub, subCopy, withComponents

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

create

public static BandedMatrix create(AMatrix m)

create

public static BandedMatrix create(int rowCount,
                                  int columnCount,
                                  int minBand,
                                  int maxBand)

wrap

public static BandedMatrix wrap(int rowCount,
                                int columnCount,
                                int minBand,
                                int maxBand,
                                AVector... bands)

upperBandwidthLimit

public 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).

Specified by:

upperBandwidthLimit in class ABandedMatrix

Returns:

lowerBandwidthLimit

public 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).

Specified by:

lowerBandwidthLimit in class ABandedMatrix

Returns:

getTranspose

public BandedMatrix getTranspose()

Description copied from interface: INDArray

Returns the transpose of this array. A transpose of an array is equivalent to reversing the order of dimensions. May or may not return a view depending on the array type.

Specified by:

getTranspose in interface INDArray

Specified by:

getTranspose in interface IMatrix

Overrides:

getTranspose in class AMatrix

Returns:

the transpose of this matrix

getBand

public 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

Specified by:

getBand in class ABandedMatrix

Returns:

rowCount

public int rowCount()

Description copied from interface: IMatrix

Gets the number of rows in this matrix (dimension 0)

Returns:

columnCount

public int columnCount()

Description copied from interface: IMatrix

Gets the number of columns in this matrix (dimension 1)

Returns:

isView

public boolean isView()

Description copied from interface: INDArray

Return true if this array is considered as a view type. This indicates (but does not guarantee): a) Data is *likely* to be shared with other arrays, so mutation of one may affect others b) It is *unlikely* to be in the most efficient general purpose format isView is intended to be used as for heuristics. It should *not* be used where the outcome might affect correctness.

Specified by:

isView in interface INDArray

Overrides:

isView in class AMatrix

get

public double get(int i,
                  int j)

Description copied from interface: INDArray

Returns the double value at the specified position in a 2D matrix

Specified by:

get in interface INDArray

Specified by:

get in interface IMatrix

Specified by:

get in class AMatrix

set

public void set(int i,
                int j,
                double value)

Description copied from interface: INDArray

Sets a value at a given position in a mutable 2D array

Specified by:

set in interface INDArray

Specified by:

set in interface IMatrix

Specified by:

set in class AMatrix

unsafeGet

public double unsafeGet(int i,
                        int j)

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:

unsafeSet

public void unsafeSet(int i,
                      int j,
                      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

addAt

public void addAt(int i,
                  int j,
                  double d)

Description copied from interface: IMatrix

Adds a value at a specific position in the matrix, mutating the matrix Does not perform bounds checking - this in an unsafe operation

Specified by:

addAt in interface IMatrix

Overrides:

addAt in class AMatrix

exactClone

public BandedMatrix exactClone()

Description copied from interface: INDArray

Creates a deep clone of an array, using the same class implementation as the original array

Specified by:

exactClone in interface INDArray

Specified by:

exactClone in class AMatrix

Returns:

A clone of the original array

transform

public void transform(AVector source,
                      AVector dest)

Description copied from interface: IMatrix

Transforms a source vector into a destination vector, using matrix multiplication (inner product). The destination vector is overwritten.

Specified by:

transform in interface IMatrix

Overrides:

transform in class AMatrix

transform

public void transform(Vector source,
                      Vector dest)

Overrides:

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