mikera.matrixx.impl

Class QuadtreeMatrix

java.lang.Object

mikera.arrayz.impl.AbstractArray<AVector>

mikera.matrixx.AMatrix

mikera.matrixx.impl.ARectangularMatrix

mikera.matrixx.impl.ABlockMatrix

mikera.matrixx.impl.QuadtreeMatrix

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.lang.Comparable<INDArray>, java.lang.Iterable<AVector>, INDArray, ISparse, IMatrix

public class QuadtreeMatrix
extends ABlockMatrix
implements ISparse

A matrix implemented as a quadtree of submatrices. Useful for large matrices with heirarchical structure where large regions are either fully sparse or of a specialised subtype (e.g. a diagonal matrix).

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
void	add(AVector v) Adds a vector to every row of this matrix.
void	add(double v) Adds a double value to all elements in this array.
void	addAt(int row, int column, double value) Adds a value at a specific position in the matrix, mutating the matrix Does not perform bounds checking - this in an unsafe operation
int	columnBlockCount()
void	copyColumnTo(int col, double[] data, int offset) Copies the elements in a selected row of this matrix to a double array
void	copyRowTo(int row, double[] data, int offset) Copies the elements in a selected row of this matrix to a double array
static QuadtreeMatrix	create(AMatrix c00, AMatrix c01, AMatrix c10, AMatrix c11)
double	density() Computes the density ratio of this sparse array (proportion of non-zero elements)
double	elementMax() Returns the maximum element value in this array.
double	elementMin() Returns the maximum element value in this array.
double	elementSum() Returns the sum of all elements in this matrix
AMatrix	exactClone() Creates a deep clone of an array, using the same class implementation as the original array
void	fill(double v) Fills this array with a single double value.
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)
AVector	getColumnView(int col) Returns a column of the matrix as a vector view.
int	getRowBlockIndex(int row)
AVector	getRowView(int row) Returns a row of the matrix as a vector view.
boolean	isDiagonal() Returns true iff this matrix is a square diagonal matrix
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)
boolean	isZero() Returns true if the matrix is the zero matrix (all components zero)
long	nonZeroCount() Returns the number of non-zero elements in the array.
int	rowBlockCount()
void	set(int row, int column, double value) Sets a value at a given position in a mutable 2D array
double	unsafeGet(int row, int column) 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 row, int column, 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.
static QuadtreeMatrix	wrap(AMatrix c00, AMatrix c01, AMatrix c10, AMatrix c11)

Methods inherited from class mikera.matrixx.impl.ABlockMatrix

componentCount, getComponent, isBoolean

Methods inherited from class mikera.matrixx.impl.ARectangularMatrix

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

Methods inherited from class mikera.matrixx.AMatrix

abs, add, add, add2, addCopy, addCopy, addCopy, addCopy, addCopy, addInnerProduct, addInnerProduct, addInnerProduct, addMultiple, addMultiple, addMultiple, addOuterProduct, addOuterProduct, addOuterProductSparse, addOuterProductSparse, addRowMultiple, addSparse, addSparse, addToArray, applyOp, applyOp, applyOp, applyOp, applyOp, applyOp, applyOpCopy, asDoubleArray, asElementList, asVector, bandIndex, bandPosition, bandStartColumn, bandStartRow, broadcast, broadcastCloneLike, broadcastCopyLike, broadcastLike, broadcastLike, clamp, clone, composeWith, copy, dense, denseClone, determinant, diagonalProduct, dimensionality, divide, divide, divide, divide, divideCopy, elementIterator, elementsEqual, elementSquaredSum, ensureMutable, epsilonEquals, epsilonEquals, epsilonEquals, equals, equals, equals, equalsArray, equalsTranspose, exp, 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, 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, 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, setApplyOp, setApplyOp, setColumn, setElements, setElements, setMultiple, setMultiple, setMultiple, setMultiple, setMultiple, setRow, setSparse, setSparse, signum, slice, slice, sliceCount, sparse, sparseClone, sqrt, square, sub, sub, sub, subArray, subCopy, subMatrix, swapColumns, swapRows, toAffineTransform, toDoubleArray, toDoubleBuffer, toMatrix, toMatrixTranspose, toMutableMatrix, toNestedDoubleArrays, toSliceArray, toString, toStringFull, toVector, trace, transform, transform, transformInPlace, transformInPlace, transposeInnerProduct, transposeInnerProduct, transposeInPlace, upperBandwidth, upperBandwidthLimit, validate

Methods inherited from class mikera.arrayz.impl.AbstractArray

absCopy, absDiff, absDiffCopy, add, addApplyOp, addAt, addCopy, addInnerProduct, addInnerProduct, addMultipleSparse, addPower, addPower, addSparse, broadcastLike, compareTo, divideCopy, elementAbsPowSum, elementMaxAbs, elementPowSum, elementProduct, epsilonEquals, equals, equalsArray, get, get, get, get, getComponents, getElements, getElements, getElements, isDense, isSparse, join, multiplyCopy, negateCopy, reciprocalCopy, scale, scaleCopy, setElements, setInnerProduct, setSparse, signumCopy, sliceValue, squareCopy, sub, sub, subCopy, withComponents

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface mikera.arrayz.INDArray

absCopy, absDiff, absDiffCopy, addApplyOp, addAt, addInnerProduct, addMultipleSparse, addPower, addPower, addSparse, broadcastLike, divideCopy, elementAbsPowSum, elementMaxAbs, elementPowSum, elementProduct, epsilonEquals, equalsArray, get, get, get, get, getComponents, getElements, getElements, getElements, isDense, isSparse, join, multiplyCopy, negateCopy, reciprocalCopy, scale, scaleCopy, setElements, setInnerProduct, setSparse, signumCopy, sliceValue, squareCopy, sub, subCopy, withComponents

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

wrap

public static QuadtreeMatrix wrap(AMatrix c00,
                                  AMatrix c01,
                                  AMatrix c10,
                                  AMatrix c11)

create

public static QuadtreeMatrix create(AMatrix c00,
                                    AMatrix c01,
                                    AMatrix c10,
                                    AMatrix c11)

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

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 ABlockMatrix

isDiagonal

public boolean isDiagonal()

Description copied from interface: IMatrix

Returns true iff this matrix is a square diagonal matrix

Specified by:

isDiagonal in interface IMatrix

Overrides:

isDiagonal in class AMatrix

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

Overrides:

set in class ARectangularMatrix

unsafeGet

public double unsafeGet(int row,
                        int column)

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

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

copyRowTo

public void copyRowTo(int row,
                      double[] data,
                      int offset)

Description copied from class: AMatrix

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

Overrides:

copyRowTo in class ABlockMatrix

Parameters:

row - The index of the selected row

data - Destination double[] array

offset - Offset into destination array

copyColumnTo

public void copyColumnTo(int col,
                         double[] data,
                         int offset)

Description copied from class: AMatrix

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

Overrides:

copyColumnTo in class ABlockMatrix

data - Destination double[] array

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 AMatrix

elementSum

public double elementSum()

Description copied from class: AMatrix

Returns the sum of all elements in this matrix

Specified by:

elementSum in interface INDArray

Overrides:

elementSum in class AMatrix

elementMin

public double elementMin()

Description copied from interface: INDArray

Returns the maximum element value in this array. Throws an error if there are no elements.

Specified by:

elementMin in interface INDArray

Overrides:

elementMin in class AbstractArray<AVector>

elementMax

public double elementMax()

Description copied from interface: INDArray

Returns the maximum element value in this array. Throws an error if there are no elements.

Specified by:

elementMax in interface INDArray

Overrides:

elementMax in class AbstractArray<AVector>

fill

public void fill(double v)

Description copied from interface: INDArray

Fills this array with a single double value. Requires the array to be mutable.

Specified by:

fill in interface INDArray

Overrides:

fill in class AMatrix

add

public void add(double v)

Description copied from interface: INDArray

Adds a double value to all elements in this array. Implementations may optimize the case of 0.0

Specified by:

add in interface INDArray

Overrides:

add in class AMatrix

add

public void add(AVector v)

Description copied from class: AMatrix

Adds a vector to every row of this matrix.

Overrides:

add in class AMatrix

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 ABlockMatrix

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 ABlockMatrix

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

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:

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

columnBlockCount

public int columnBlockCount()

Specified by:

columnBlockCount in class ABlockMatrix

rowBlockCount

public int rowBlockCount()

Specified by:

rowBlockCount in class ABlockMatrix