mikera.matrixx.impl

Class ASparseRCMatrix

java.lang.Object

mikera.arrayz.impl.AbstractArray<AVector>

mikera.matrixx.AMatrix

mikera.matrixx.impl.ARectangularMatrix

mikera.matrixx.impl.ASparseRCMatrix

All Implemented Interfaces:

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

Direct Known Subclasses:

SparseColumnMatrix, SparseRowMatrix

public abstract class ASparseRCMatrix
extends ARectangularMatrix

Abstract base class for matrices that store sparse rows or columns.

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
void	abs() Replaces all elements of this array with their absolute values, according to Math.abs(double)
void	applyOp(Op op) Applies a unary operator to all elements of the array (in-place)
abstract 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 selected row of this matrix to a double array
Matrix	dense() Coerces this INDArray to a dense format, without changing its element values.
double	elementMax() Returns the maximum element value in this array.
double	elementMin() Returns the maximum element value in this array.
double	elementSquaredSum() Returns the squared sum of all elements in this matrix
double	elementSum() Returns the sum of all elements in this matrix
void	exp() Computes the function e^x (in-place) for all array elements
void	fill(double value) Fills this array with a single double value.
AVector	getColumnClone(int column) Returns a column of the matrix as a new cloned, mutable vector The cloned column may be modified without affecting the original matrix.
abstract AVector	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
AVector	getRowClone(int row) Returns a row of the matrix as a new cloned, mutable vector.
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	isSparse() Returns true if the array is in a sparse format
boolean	isZero() Returns true if the matrix is the zero matrix (all components zero)
void	log() Computes the natural logarithm (in-place) for all array elements
long	nonZeroCount() Returns the number of non-zero elements in the array.
void	pow(double exponent) Raises all elements of the array to a specified power in place
void	reciprocal() Replaces all elements in the array with their reciprocal
void	setSparse(double value) Sets the non-sparse elements of this array to the specified value May throw an exception if non-sparse elements are not mutable
AMatrix	sparse() Coerces this INDArray to a sparse format, without changing its element values.
void	sqrt() Computes the square root of all elements in the array
void	square() Squares all elements of the array in place
double[]	toDoubleArray() Copies the elements of this array to a new double[] array.
AVector	unsafeGetVector(int i) Gets a vector from the internal data array The vector may be null (indicating a zero row or column)
void	validate() Validates the internal data structure of the INDArray.

Methods inherited from class mikera.matrixx.impl.ARectangularMatrix

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

Methods inherited from class mikera.matrixx.AMatrix

add, add, add, add, add2, addAt, addCopy, addCopy, addCopy, addCopy, addCopy, addInnerProduct, addInnerProduct, addInnerProduct, addMultiple, addMultiple, addMultiple, addOuterProduct, addOuterProduct, addOuterProductSparse, addOuterProductSparse, addRowMultiple, addSparse, addSparse, addToArray, applyOp, applyOp, applyOp, applyOp, applyOp, applyOpCopy, asDoubleArray, asElementList, asVector, bandIndex, bandPosition, bandStartColumn, bandStartRow, broadcast, broadcastCloneLike, broadcastCopyLike, broadcastLike, broadcastLike, clamp, clone, composeWith, copy, denseClone, determinant, diagonalProduct, dimensionality, divide, divide, divide, divide, divideCopy, elementIterator, elementsEqual, ensureMutable, epsilonEquals, epsilonEquals, epsilonEquals, equals, equals, equals, equalsArray, equalsTranspose, exactClone, get, get, get, get, get, getBand, getBandWrapped, getColumn, getColumns, getColumnView, getElements, getLeadingDiagonal, getLongShape, getRow, getRows, getRowView, getSlices, getSlices, getSliceViews, getTranspose, getTransposeCopy, getTransposeView, hashCode, hasOrthonormalColumns, hasOrthonormalRows, hasUncountable, immutable, innerProduct, innerProduct, innerProduct, innerProduct, innerProduct, innerProduct, inputDimensions, inverse, isBoolean, isDiagonal, isElementConstrained, isHermitian, isIdentity, isInvertible, isLowerTriangular, isOrthogonal, isOrthogonal, isPositiveDefinite, isRectangularDiagonal, isSymmetric, isUpperTriangular, isView, iterator, join, lowerBandwidth, lowerBandwidthLimit, mul, multiply, multiply, multiply, multiply, multiplyCopy, multiplyRow, mutable, negate, outerProduct, outputDimensions, rank, 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, sparseClone, sub, sub, sub, subArray, subCopy, subMatrix, swapColumns, swapRows, toAffineTransform, toDoubleBuffer, toMatrix, toMatrixTranspose, toMutableMatrix, toNestedDoubleArrays, toSliceArray, toString, toStringFull, toVector, trace, transform, transform, transformInPlace, transformInPlace, transposeInnerProduct, transposeInnerProduct, transposeInPlace, unsafeGet, unsafeSet, upperBandwidth, upperBandwidthLimit

Methods inherited from class mikera.arrayz.impl.AbstractArray

absCopy, absDiff, absDiffCopy, add, addApplyOp, addAt, addCopy, addInnerProduct, addInnerProduct, addMultipleSparse, addPower, addPower, addSparse, broadcastLike, compareTo, density, divideCopy, elementAbsPowSum, elementMaxAbs, elementPowSum, elementProduct, epsilonEquals, equals, equalsArray, get, get, get, get, getComponents, getElements, getElements, getElements, isDense, join, multiplyCopy, negateCopy, reciprocalCopy, scale, scaleCopy, setElements, setInnerProduct, 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, join, multiplyCopy, negateCopy, reciprocalCopy, scale, scaleCopy, setElements, setInnerProduct, 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

unsafeGetVector

public AVector unsafeGetVector(int i)

Gets a vector from the internal data array The vector may be null (indicating a zero row or column)

isSparse

public 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 AbstractArray<AVector>

fill

public void fill(double value)

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

reciprocal

public void reciprocal()

Description copied from interface: INDArray

Replaces all elements in the array with their reciprocal

Specified by:

reciprocal in interface INDArray

Overrides:

reciprocal in class AMatrix

abs

public void abs()

Description copied from interface: INDArray

Replaces all elements of this array with their absolute values, according to Math.abs(double)

Specified by:

abs in interface INDArray

Overrides:

abs in class AMatrix

pow

public void pow(double exponent)

Description copied from interface: INDArray

Raises all elements of the array to a specified power in place

Specified by:

pow in interface INDArray

Overrides:

pow in class AMatrix

square

public void square()

Description copied from interface: INDArray

Squares all elements of the array in place

Specified by:

square in interface INDArray

Overrides:

square in class AMatrix

sqrt

public void sqrt()

Description copied from interface: INDArray

Computes the square root of all elements in the array

Specified by:

sqrt in interface INDArray

Overrides:

sqrt in class AMatrix

exp

public void exp()

Description copied from interface: INDArray

Computes the function e^x (in-place) for all array elements

Specified by:

exp in interface INDArray

Overrides:

exp in class AMatrix

log

public void log()

Description copied from interface: INDArray

Computes the natural logarithm (in-place) for all array elements

Specified by:

log in interface INDArray

Overrides:

log in class AMatrix

isMutable

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

isFullyMutable

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

isZero

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

getRowClone

public AVector getRowClone(int row)

Description copied from interface: IMatrix

Returns a row of the matrix as a new cloned, mutable vector. The cloned row may be modified without affecting the original matrix.

Specified by:

getRowClone in interface IMatrix

Overrides:

getRowClone in class AMatrix

getColumnClone

public AVector getColumnClone(int column)

Description copied from interface: IMatrix

Returns a column of the matrix as a new cloned, mutable vector The cloned column may be modified without affecting the original matrix.

Specified by:

getColumnClone in interface IMatrix

Overrides:

getColumnClone in class AMatrix

copyRowTo

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

Description copied from class: AMatrix

Copies the elements in a selected 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

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

elementSquaredSum

public double elementSquaredSum()

Description copied from class: AMatrix

Returns the squared sum of all elements in this matrix

Specified by:

elementSquaredSum in interface INDArray

Overrides:

elementSquaredSum 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>

applyOp

public void applyOp(Op op)

Description copied from interface: INDArray

Applies a unary operator to all elements of the array (in-place)

Specified by:

applyOp in interface INDArray

Overrides:

applyOp in class AMatrix

setSparse

public void setSparse(double value)

Description copied from interface: INDArray

Sets the non-sparse elements of this array to the specified value May throw an exception if non-sparse elements are not mutable

Specified by:

setSparse in interface INDArray

Overrides:

setSparse in class AbstractArray<AVector>

nonZeroCount

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

toDoubleArray

public double[] toDoubleArray()

Description copied from interface: INDArray

Copies the elements of this array to a new double[] array.

Specified by:

toDoubleArray in interface INDArray

Overrides:

toDoubleArray in class AMatrix

dense

public Matrix dense()

Description copied from interface: INDArray

Coerces this INDArray to a dense format, without changing its element values. May return the same INDArray if already dense. May also mutate the internal structure of the original NDArray, or create a view over parts of the original INDArray. You should take a defensive copy of the original NDArray if any of this concerns you. The returned dense array may not be fully mutable in all elements.

Specified by:

dense in interface INDArray

Overrides:

dense in class AMatrix

sparse

public AMatrix sparse()

Description copied from interface: INDArray

Coerces this INDArray to a sparse format, without changing its element values. May return the same INDArray if already sparse. May also mutate the internal structure of the original NDArray, or create a view over parts of the original INDArray. You should take a defensive copy of the original NDArray if any of this concerns you. The returned sparse array may not be fully mutable in all elements.

Specified by:

sparse in interface INDArray

Overrides:

sparse in class AMatrix

componentCount

public abstract 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:

getComponent

public abstract AVector 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:

validate

public void validate()

Description copied from interface: INDArray

Validates the internal data structure of the INDArray. Throws an exception on failure. Failure indicates a serious bug and/or data corruption.

Specified by:

validate in interface INDArray

Overrides:

validate in class AMatrix