mikera.matrixx.impl

Class BlockDiagonalMatrix

java.lang.Object

mikera.transformz.ATransform

mikera.transformz.AAffineTransform

mikera.transformz.ALinearTransform

mikera.matrixx.AMatrix

mikera.matrixx.impl.ABlockMatrix

mikera.matrixx.impl.BlockDiagonalMatrix

All Implemented Interfaces:

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

public class BlockDiagonalMatrix
extends ABlockMatrix
implements ISparse

Class representing a square, block diagonal matrix. Each block on the main diagonal must be a square matrix, but need not itself be diagonal.

Author:

Mike

Method Summary

Methods

Modifier and Type	Method and Description
int	columnBlockCount()
int	columnCount() Returns the number of columns in the matrix
void	copyColumnTo(int col, double[] dest, int destOffset)
void	copyRowTo(int row, double[] dest, int destOffset)
static BlockDiagonalMatrix	create(AMatrix... blocks)
double	density() Computes the density ratio of this sparse array (proportion of non-zero elements)
AMatrix	exactClone() Returns an exact deep clone of an array (i.e.
double	get(int row, int column) Returns a specified element in the matrix
AMatrix	getBlock(int rowBlock, int colBlock)
int	getBlockColumnCount(int colBlock)
int	getBlockRowCount(int rowBlock)
int	getColumnBlockIndex(int col)
int	getRowBlockIndex(int row)
boolean	isFullyMutable() If this method returns true, the INDArray is guaranteed to be fully mutable in all positions i.e.
boolean	isMutable() Returns true if the INDArray is mutable (at least partially)
int	rowBlockCount()
int	rowCount() Returns the number of rows in the matrix
void	set(int row, int column, double value) Sets a specified element in the matrix

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, compose, compose, composeWith, composeWith, copyOfMatrix, copyOfTranslationVector, copyTo, determinant, dimensionality, divide, divide, elementCount, elementDiv, elementIterator, elementMul, elementSquaredSum, elementSum, ensureMutable, epsilonEquals, epsilonEquals, epsilonEquals, equals, equals, equals, equals, exp, fill, get, get, get, getBand, getBandWrapped, getColumn, getElements, getLeadingDiagonal, getLongShape, getMatrixComponent, getRow, getShape, getShape, getShapeClone, getSlices, getSlices, getSliceViews, getTranspose, getTransposeCopy, getTransposeView, hashCode, hasOrthonormalColumns, hassOrthonormalRows, immutable, innerProduct, innerProduct, innerProduct, innerProduct, innerProduct, innerProduct, inputDimensions, inverse, isBoolean, isDiagonal, isElementConstrained, isHermitian, isIdentity, isInvertible, isLowerTriangular, isOrthogonal, isPositiveDefinite, isRectangularDiagonal, isSameShape, isSameShape, isSquare, isSymmetric, isUpperTriangular, isView, isZero, iterator, join, log, lowerBandwidth, lowerBandwidthLimit, mul, multiply, multiply, multiplyRow, mutable, negate, nonZeroCount, outerProduct, outputDimensions, pow, reciprocal, reshape, reshape, rotateView, scale, scaleAdd, set, set, set, set, set, set, setColumn, setElements, setElements, setRow, signum, slice, slice, sliceCount, sqrt, square, sub, sub, sub, sub, sub, subArray, subMatrix, swapColumns, swapRows, toAffineTransform, toArray, toDoubleArray, toDoubleBuffer, toMatrix, toMatrixTranspose, toMutableMatrix, toString, toVector, trace, transform, transform, transform, transform, transformInPlace, transformInPlace, transposeInnerProduct, transposeInnerProduct, transposeInPlace, unsafeGet, unsafeSet, upperBandwidth, upperBandwidthLimit, validate

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

Method Detail

create

public static BlockDiagonalMatrix create(AMatrix... blocks)

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

Overrides:

isFullyMutable 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

Returns:

getBlock

public AMatrix getBlock(int rowBlock,
               int colBlock)

Specified by:

getBlock in class ABlockMatrix

getBlockColumnCount

public int getBlockColumnCount(int colBlock)

Specified by:

getBlockColumnCount in class ABlockMatrix

getBlockRowCount

public int getBlockRowCount(int rowBlock)

Specified by:

getBlockRowCount in class ABlockMatrix

getColumnBlockIndex

public int getColumnBlockIndex(int col)

Specified by:

getColumnBlockIndex in class ABlockMatrix

getRowBlockIndex

public int getRowBlockIndex(int row)

Specified by:

getRowBlockIndex in class ABlockMatrix

rowCount

public int rowCount()

Description copied from class: AMatrix

Returns the number of rows in the matrix

Specified by:

rowCount in interface IMatrix

Specified by:

rowCount in class AMatrix

columnCount

public int columnCount()

Description copied from class: AMatrix

Returns the number of columns in the matrix

Specified by:

columnCount in interface IMatrix

Specified by:

columnCount in class AMatrix

get

public double get(int row,
         int column)

Description copied from class: AMatrix

Returns a specified element in the matrix

Specified by:

get in interface INDArray

Specified by:

get in interface IMatrix

Specified by:

get in class AMatrix

Returns:

set

public void set(int row,
       int column,
       double value)

Description copied from class: AMatrix

Sets a specified element in the matrix

Specified by:

set in interface INDArray

Specified by:

set in interface IMatrix

Specified by:

set in class AMatrix

exactClone

public AMatrix exactClone()

Description copied from interface: INDArray

Returns an exact deep clone of an array (i.e. of the same class as the original).

Specified by:

exactClone in interface INDArray

Specified by:

exactClone in class AMatrix

Returns:

columnBlockCount

public int columnBlockCount()

Specified by:

columnBlockCount in class ABlockMatrix

rowBlockCount

public int rowBlockCount()

Specified by:

rowBlockCount in class ABlockMatrix

copyColumnTo

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

Overrides:

copyColumnTo in class AMatrix

copyRowTo

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

Overrides:

copyRowTo in class AMatrix

density

public double density()

Description copied from interface: ISparse

Computes the density ratio of this sparse array (proportion of non-zero elements)

Specified by:

density in interface ISparse

Returns: