mikera.matrixx.impl

Class ABlockMatrix

java.lang.Object

mikera.arrayz.impl.AbstractArray<AVector>

mikera.matrixx.AMatrix

mikera.matrixx.impl.ARectangularMatrix

mikera.matrixx.impl.ABlockMatrix

All Implemented Interfaces:

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

Direct Known Subclasses:

BlockDiagonalMatrix, QuadtreeMatrix

public abstract class ABlockMatrix
extends ARectangularMatrix

Abstract base class for a large matrix constructed out of regular subMatrix blocks

Author:

Mike

See Also:

Serialized Form

Field Summary

Fields inherited from class mikera.matrixx.impl.ARectangularMatrix

cols, rows

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ABlockMatrix(int rows, int cols)

Method Summary

Modifier and Type	Method and Description
abstract int	columnBlockCount()
int	componentCount() Returns the number of components of this array.
void	copyColumnTo(int j, double[] dest, int destOffset) Copies the elements in a selected row of this matrix to a double array
void	copyRowTo(int i, double[] dest, int destOffset) Copies the elements in a slected row of this matrix to a double array
abstract AMatrix	getBlock(int rowBlock, int colBlock)
abstract int	getBlockColumnCount(int colBlock)
abstract int	getBlockColumnStart(int colBlock)
abstract int	getBlockRowCount(int rowBlock)
abstract int	getBlockRowStart(int rowBlock)
abstract int	getColumnBlockIndex(int col)
AVector	getColumnView(int col) Returns a column of the matrix as a vector view.
AMatrix	getComponent(int k) Gets a component from the array at the specified index Will throw an error if components are not supported, or if the component is out of bounds as defined by 0 <= k
abstract int	getRowBlockIndex(int row)
AVector	getRowView(int row) Returns a row of the matrix as a vector view.
boolean	isBoolean() Returns true if the array is boolean (contains only 0.0 or 1.0 values)
boolean	isZero() Returns true if the matrix is the zero matrix (all components zero)
abstract int	rowBlockCount()
protected static int	sumColumnCounts(AMatrix... mats)
protected static int	sumRowCounts(AMatrix... mats)

Methods inherited from class mikera.matrixx.impl.ARectangularMatrix

bandLength, checkColumn, checkIndex, checkRow, checkSameShape, checkSameShape, checkSquare, columnCount, elementCount, getShape, getShape, getShapeClone, isSameShape, isSameShape, isSameShape, isSquare, rowCount

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, addToArray, applyOp, applyOp, applyOp, applyOp, applyOp, applyOp, applyOpCopy, asDoubleArray, asElementList, asVector, bandIndex, bandLength, bandPosition, bandStartColumn, bandStartRow, broadcast, broadcastCloneLike, broadcastCopyLike, broadcastLike, broadcastLike, checkColumnCount, checkDimension, checkRowCount, checkShape, clamp, clone, composeWith, copy, dense, denseClone, determinant, diagonalProduct, dimensionality, divide, divide, divide, divide, elementIterator, elementsEqual, elementSquaredSum, elementSum, ensureMutable, epsilonEquals, epsilonEquals, epsilonEquals, epsilonEquals, equals, equals, equals, equalsArray, equalsByRows, equalsTranspose, exactClone, exp, fill, get, get, get, get, getBand, getBandWrapped, getColumn, getColumnClone, getColumns, getElements, getLeadingDiagonal, getLongShape, getRow, getRowClone, getRows, getSlices, getSlices, getSliceViews, getTranspose, getTransposeCopy, getTransposeView, hashCode, hasOrthonormalColumns, hasOrthonormalRows, hasUncountable, immutable, innerProduct, innerProduct, innerProduct, innerProduct, innerProduct, innerProduct, inputDimensions, inverse, isDiagonal, isElementConstrained, isFullyMutable, isHermitian, isIdentity, isInvertible, isLowerTriangular, isMutable, isOrthogonal, isOrthogonal, isPositiveDefinite, isRectangularDiagonal, isSymmetric, isUpperTriangular, isView, iterator, join, log, lowerBandwidth, lowerBandwidthLimit, mul, multiply, multiply, multiply, multiply, multiplyCopy, multiplyRow, mutable, negate, nonZeroCount, 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, setColumn, setElements, setElements, setRow, signum, slice, slice, sliceCount, sparse, sparseClone, sqrt, square, sub, sub, sub, subArray, subMatrix, swapColumns, swapRows, toAffineTransform, toArray, toDoubleArray, toDoubleBuffer, toMatrix, toMatrixTranspose, toMutableMatrix, toNestedDoubleArrays, toSliceArray, toString, toStringFull, toVector, trace, transform, transform, transformInPlace, transformInPlace, transposeInnerProduct, transposeInnerProduct, transposeInPlace, unsafeGet, unsafeSet, upperBandwidth, upperBandwidthLimit, validate

Methods inherited from class mikera.arrayz.impl.AbstractArray

absCopy, add, addAt, addInnerProduct, addPower, addPower, broadcastLike, checkMutable, density, divideCopy, elementAbsPowSum, elementMax, elementMin, elementPowSum, elementProduct, equals, equalsArray, get, get, get, get, get, getComponents, getElements, getElements, getElements, isDense, isSparse, 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, divideCopy, elementAbsPowSum, elementMax, elementMin, elementPowSum, elementProduct, equalsArray, get, get, get, get, get, getComponents, getElements, getElements, getElements, isDense, isSparse, 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

ABlockMatrix

protected ABlockMatrix(int rows,
                       int cols)

Method Detail

getBlock

public abstract AMatrix getBlock(int rowBlock,
                                 int colBlock)

getBlockColumnCount

public abstract int getBlockColumnCount(int colBlock)

getBlockRowCount

public abstract int getBlockRowCount(int rowBlock)

getBlockColumnStart

public abstract int getBlockColumnStart(int colBlock)

getBlockRowStart

public abstract int getBlockRowStart(int rowBlock)

getColumnBlockIndex

public abstract int getColumnBlockIndex(int col)

getRowBlockIndex

public abstract int getRowBlockIndex(int row)

columnBlockCount

public abstract int columnBlockCount()

rowBlockCount

public abstract int rowBlockCount()

componentCount

public int componentCount()

Description copied from interface: INDArray

Returns the number of components of this array. May return 0 if components are not supported

Specified by:

componentCount in interface INDArray

Overrides:

componentCount in class AbstractArray<AVector>

Returns:

copyRowTo

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

Description copied from class: AMatrix

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

Overrides:

copyRowTo in class AMatrix

Parameters:

i - The index of the selected row

dest - Destination double[] array

destOffset - Offset into destination array

copyColumnTo

public void copyColumnTo(int j,
                         double[] dest,
                         int destOffset)

Description copied from class: AMatrix

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

Overrides:

copyColumnTo in class AMatrix

dest - Destination double[] array

getComponent

public AMatrix getComponent(int k)

Description copied from interface: INDArray

Gets a component from the array at the specified index Will throw an error if components are not supported, or if the component is out of bounds as defined by 0 <= k

Specified by:

getComponent in interface INDArray

Overrides:

getComponent in class AbstractArray<AVector>

Returns:

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

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

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 AMatrix

getColumnView

public AVector getColumnView(int col)

Description copied from interface: IMatrix

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

Specified by:

getColumnView in interface IMatrix

Overrides:

getColumnView in class AMatrix

sumRowCounts

protected static int sumRowCounts(AMatrix... mats)

sumColumnCounts

protected static int sumColumnCounts(AMatrix... mats)