mikera.matrixx.impl

Class BlockDiagonalMatrix

java.lang.Object

mikera.arrayz.impl.AbstractArray<AVector>

mikera.matrixx.AMatrix

mikera.matrixx.impl.ARectangularMatrix

mikera.matrixx.impl.ABlockMatrix

mikera.matrixx.impl.BlockDiagonalMatrix

All Implemented Interfaces:

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

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

See Also:

Serialized Form

Field Summary

Fields inherited from class mikera.matrixx.impl.ARectangularMatrix

cols, rows

Method Summary

Modifier and Type	Method and Description
int	columnBlockCount()
void	copyColumnTo(int col, double[] dest, int destOffset) Copies the elements in a selected row of this matrix to a double array
void	copyRowTo(int row, double[] dest, int destOffset) Copies the elements in a slected row of this matrix to a double array
static BlockDiagonalMatrix	create(AMatrix... blocks)
double	density() Computes the density ratio of this sparse array (proportion of non-zero elements)
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
AMatrix	exactClone() Creates a deep clone of an array, using the same class implementation as the original array
double	get(int row, int column) Returns the double value at the specified position in a 2D matrix
AMatrix	getBlock(int rowBlock, int colBlock)
int	getBlockColumnCount(int colBlock)
int	getBlockColumnStart(int colBlock)
int	getBlockRowCount(int rowBlock)
int	getBlockRowStart(int rowBlock)
int	getColumnBlockIndex(int col)
int	getRowBlockIndex(int row)
boolean	hasUncountable() Checks to see if any element in the matrix is NaN of Infinite.
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()
void	set(int row, int column, double value) Sets a value at a given position in a mutable 2D array

Methods inherited from class mikera.matrixx.impl.ABlockMatrix

componentCount, getColumnView, getComponent, getRowView, isBoolean, isZero, sumColumnCounts, sumRowCounts

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, exp, fill, get, get, get, getBand, getBandWrapped, getColumn, getColumnClone, getColumns, getElements, getLeadingDiagonal, getLongShape, getRow, getRowClone, getRows, getSlices, getSlices, getSliceViews, getTranspose, getTransposeCopy, getTransposeView, hashCode, hasOrthonormalColumns, hasOrthonormalRows, immutable, innerProduct, innerProduct, innerProduct, innerProduct, innerProduct, innerProduct, inputDimensions, inverse, isDiagonal, isElementConstrained, isHermitian, isIdentity, isInvertible, isLowerTriangular, 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, 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, divideCopy, elementMax, elementMin, 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, elementMax, elementMin, 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

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

Specified by:

isFullyMutable in class AMatrix

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

getBlock

public AMatrix getBlock(int rowBlock,
                        int colBlock)

Specified by:

getBlock in class ABlockMatrix

getBlockColumnStart

public int getBlockColumnStart(int colBlock)

Specified by:

getBlockColumnStart in class ABlockMatrix

getBlockRowStart

public int getBlockRowStart(int rowBlock)

Specified by:

getBlockRowStart 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

get

public double get(int row,
                  int column)

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 row,
                int column,
                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

exactClone

public AMatrix 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

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)

Description copied from class: AMatrix

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

Overrides:

copyColumnTo in class ABlockMatrix

dest - Destination double[] array

copyRowTo

public void copyRowTo(int row,
                      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 ABlockMatrix

Parameters:

row - The index of the selected row

dest - Destination double[] array

destOffset - Offset into destination array

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

Overrides:

density in class AbstractArray<AVector>

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.

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: