mikera.matrixx.impl

Class ASingleBandMatrix

java.lang.Object

mikera.arrayz.impl.AbstractArray<AVector>

mikera.matrixx.AMatrix

mikera.matrixx.impl.ABandedMatrix

mikera.matrixx.impl.ASingleBandMatrix

All Implemented Interfaces:

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

Direct Known Subclasses:

ADiagonalMatrix

public abstract class ASingleBandMatrix
extends ABandedMatrix
implements ISparse

Abstract base class to represent sparse matrices with a single non-zero band Unlike ADiagonalMatrix, this matrix need not be square, and may have non-zero values on an arbitrary diagonal.

Author:

Mike

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ASingleBandMatrix()

Method Summary

Modifier and Type	Method and Description
double	elementAbsPowSum(double p) Returns the sum of the absolute values of all the elements raised to a specified power
double	elementPowSum(double p) Returns the sum of all the elements raised to a specified power
AVector	getBand(int band) Gets a specific band of the matrix, as a view vector.
abstract AVector	getNonZeroBand() Gets the non-zero band from the matrix
boolean	hasUncountable() Checks to see if any element in the matrix is NaN of Infinite.
boolean	isIdentity() Checks if this is an identity matrix (i.e.
boolean	isSparse() Returns true if the array is in a sparse format
boolean	isSymmetric() Returns true if a matrix is symmetric
boolean	isZero() Returns true if the matrix is the zero matrix (all components zero)
abstract int	nonZeroBand() Specifies which band of the matrix is nonzero
long	nonZeroCount() Returns the number of non-zero elements in the array.
int	rank() Calculate the rank of a matrix.
AMatrix	subMatrix(int rowStart, int rows, int colStart, int cols) Gets a rectangular submatrix view of part of a matrix

Methods inherited from class mikera.matrixx.impl.ABandedMatrix

addToArray, copyRowTo, density, diagonalProduct, elementSquaredSum, elementSum, fill, getRowView, isFullyMutable, isLowerTriangular, isMutable, isUpperTriangular, lowerBandwidth, lowerBandwidthLimit, multiply, toDoubleArray, toMatrix, toMatrixTranspose, trace, upperBandwidth, upperBandwidthLimit, validate

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, 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, exactClone, exp, get, get, get, get, getBandWrapped, getColumn, getColumnClone, getColumns, getColumnView, getElements, getLeadingDiagonal, getLongShape, getRow, getRowClone, getRows, getShape, getShape, getShapeClone, getSlices, getSlices, getSliceViews, getTranspose, getTransposeCopy, getTransposeView, hashCode, hasOrthonormalColumns, hasOrthonormalRows, immutable, innerProduct, innerProduct, innerProduct, innerProduct, innerProduct, innerProduct, inputDimensions, inverse, isBoolean, isDiagonal, isElementConstrained, isHermitian, isInvertible, isOrthogonal, isOrthogonal, isPositiveDefinite, isRectangularDiagonal, isSameShape, isSameShape, isSquare, isView, iterator, join, log, mul, multiply, multiply, multiply, multiplyCopy, multiplyRow, mutable, negate, outerProduct, outputDimensions, pow, reciprocal, reduce, reduce, reduceSlices, reduceSlices, reorder, reorder, replaceColumn, replaceRow, reshape, reshape, rotateView, rowDotProduct, scaleAdd, scaleAdd, set, set, set, set, set, set, set, set, set, setColumn, setElements, setElements, setRow, signum, slice, slice, sliceCount, sparse, sparseClone, sqrt, square, sub, sub, sub, subArray, swapColumns, swapRows, toAffineTransform, toArray, 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, add, addAt, addInnerProduct, addPower, addPower, broadcastLike, checkMutable, componentCount, divideCopy, elementMax, elementMin, 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.ISparse

density

Methods inherited from interface mikera.matrixx.IMatrix

columnCount, rowCount

Methods inherited from interface mikera.arrayz.INDArray

absCopy, addAt, addPower, addPower, broadcastLike, checkMutable, componentCount, divideCopy, elementMax, elementMin, 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

Constructor Detail

ASingleBandMatrix

public ASingleBandMatrix()

Method Detail

nonZeroBand

public abstract int nonZeroBand()

Specifies which band of the matrix is nonzero

Returns:

getNonZeroBand

public abstract AVector getNonZeroBand()

Gets the non-zero band from the matrix

Returns:

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 ABandedMatrix

Returns:

subMatrix

public AMatrix subMatrix(int rowStart,
                         int rows,
                         int colStart,
                         int cols)

Description copied from interface: IMatrix

Gets a rectangular submatrix view of part of a matrix

Specified by:

subMatrix in interface IMatrix

Overrides:

subMatrix in class AMatrix

isIdentity

public boolean isIdentity()

Description copied from interface: IMatrix

Checks if this is an identity matrix (i.e. 1.0 in leading diagonal, 0.0 elsewhere)

Specified by:

isIdentity in interface IMatrix

Overrides:

isIdentity in class AMatrix

Returns:

true if this matrix is a square identity matrix, false otherwise.

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 ABandedMatrix

isSparse

public final 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 ABandedMatrix

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

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:

hasUncountable

public boolean hasUncountable()

Description copied from class: AMatrix

Checks to see if any element in the matrix is NaN of Infinite.

Specified by:

hasUncountable in interface INDArray

Overrides:

hasUncountable in class AMatrix

Returns:

True if any element in the matrix is NaN of Infinite.

rank

public int rank()

Description copied from class: AMatrix

Calculate the rank of a matrix. This is equivalent to the maximum number of linearly independent rows or columns.

Overrides:

rank in class AMatrix

elementPowSum

public double elementPowSum(double p)

Returns the sum of all the elements raised to a specified power

Specified by:

elementPowSum in interface INDArray

Overrides:

elementPowSum in class AbstractArray<AVector>

Returns:

elementAbsPowSum

public double elementAbsPowSum(double p)

Returns the sum of the absolute values of all the elements raised to a specified power

Specified by:

elementAbsPowSum in interface INDArray

Overrides:

elementAbsPowSum in class AbstractArray<AVector>

Returns: