mikera.matrixx.impl

Class AStridedMatrix

java.lang.Object

mikera.arrayz.impl.AbstractArray<AVector>

mikera.matrixx.AMatrix

mikera.matrixx.impl.ARectangularMatrix

mikera.matrixx.impl.AArrayMatrix

mikera.matrixx.impl.AStridedMatrix

All Implemented Interfaces:

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

Direct Known Subclasses:

ADenseArrayMatrix, BaseStridedMatrix, DenseColumnMatrix, StridedRowMatrix

public abstract class AStridedMatrix
extends AArrayMatrix
implements IStridedArray

Abstract base class for arbitrary strided matrices

Author:

Mike

See Also:

Serialized Form

Field Summary

Fields inherited from class mikera.matrixx.impl.AArrayMatrix

data

Fields inherited from class mikera.matrixx.impl.ARectangularMatrix

cols, rows

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AStridedMatrix(double[] data, int rows, int cols)

Method Summary

Modifier and Type	Method and Description
void	add(AMatrix m) Adds another matrix to this matrix.
void	add(AVector v) Adds a vector to every row of this matrix.
void	addToArray(double[] dest, int destOffset) Adds all the elements of this array to a double array, in row-major order
void	applyOp(Op op) Applies a unary operator to all elements of the array (in-place)
Matrix	applyOpCopy(Op op) Applies a unary operator to all elements of the array (creating a new array)
double[]	asDoubleArray() Returns the underlying double array representing the densely packed elements of this array Returns null if there is no such array
Matrix	clone() Returns a clone of the array data, as a new array which will be fully mutable and may be of a different class to the original.
abstract int	columnStride() Gets the column stride for this strided matrix.
abstract void	copyColumnTo(int col, double[] dest, int destOffset) Copies the elements in a selected row of this matrix to a double array
abstract void	copyRowTo(int row, double[] dest, int destOffset) Copies the elements in a slected row of this matrix to a double array
double	diagonalProduct() Computes the product of entries on the main diagonal of a matrix
Iterator<Double>	elementIterator() Returns an iterator over all elements in this array, in row-major order
abstract int	getArrayOffset() Gets the data array offset for the first element of this strided array
AStridedVector	getBand(int i) Gets a specific band of the matrix, as a view vector.
AStridedVector	getColumn(int i) Returns a column of the matrix.
AStridedVector	getColumnView(int i) Returns a column of the matrix as a vector view.
AStridedVector	getRow(int i) Returns a row of the matrix.
AStridedVector	getRowView(int i) Returns a row of the matrix as a vector view.
int	getStride(int dimension) Gets the stide for a specific dimension in this strided array.
int[]	getStrides() Gets the strides for each dimension of this strided array.
AStridedMatrix	getTranspose() Returns the transpose of this array.
AStridedMatrix	getTransposeView() Returns a transposed view of the array.
boolean	isPackedArray() Returns true if the data array is fully packed by this matrix in row-major order
boolean	isZero() Returns true if the matrix is the zero matrix (all components zero)
double	reduce(Op2 op, double init) Reduces over all elements of the array in row-major order.
double	rowDotProduct(int i, AVector a) Returns the dot product of a specific row with a vector.
abstract int	rowStride() Gets the row stride for this strided matrix.
AStridedMatrix	subMatrix(int rowStart, int rowCount, int colStart, int colCount) Gets a rectangular submatrix view of part of a matrix
double	trace() Computes the trace of a matrix, i.e.

Methods inherited from class mikera.matrixx.impl.AArrayMatrix

get, getArray, getTransposeCopy, index, set, unsafeGet, unsafeSet

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, add2, addAt, addCopy, addCopy, addCopy, addCopy, addCopy, addInnerProduct, addInnerProduct, addInnerProduct, addMultiple, addMultiple, addMultiple, addOuterProduct, addOuterProduct, addRowMultiple, applyOp, applyOp, applyOp, applyOp, applyOp, asElementList, asVector, bandIndex, bandLength, bandPosition, bandStartColumn, bandStartRow, broadcast, broadcastCloneLike, broadcastCopyLike, broadcastLike, broadcastLike, checkColumnCount, checkDimension, checkRowCount, checkShape, clamp, composeWith, copy, dense, denseClone, determinant, dimensionality, divide, divide, divide, divide, elementsEqual, elementSquaredSum, elementSum, ensureMutable, epsilonEquals, epsilonEquals, epsilonEquals, epsilonEquals, equals, equals, equals, equalsArray, equalsByRows, equalsTranspose, exactClone, exp, fill, get, get, get, getBandWrapped, getColumnClone, getColumns, getElements, getLeadingDiagonal, getLongShape, getRowClone, getRows, getSlices, getSlices, getSliceViews, hashCode, hasOrthonormalColumns, hasOrthonormalRows, hasUncountable, immutable, innerProduct, innerProduct, innerProduct, innerProduct, innerProduct, innerProduct, inputDimensions, inverse, isBoolean, 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, reduceSlices, reduceSlices, reorder, reorder, replaceColumn, replaceRow, reshape, reshape, rotateView, 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, swapColumns, swapRows, toAffineTransform, toArray, toDoubleArray, toDoubleBuffer, toMatrix, toMatrixTranspose, toMutableMatrix, toNestedDoubleArrays, toSliceArray, toString, toStringFull, toVector, transform, transform, transformInPlace, transformInPlace, transposeInnerProduct, transposeInnerProduct, transposeInPlace, upperBandwidth, upperBandwidthLimit, validate

Methods inherited from class mikera.arrayz.impl.AbstractArray

absCopy, add, addAt, addInnerProduct, addPower, addPower, broadcastLike, checkMutable, componentCount, density, divideCopy, elementAbsPowSum, elementMax, elementMin, elementPowSum, elementProduct, equals, equalsArray, get, get, get, get, get, getComponent, 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.impl.IStridedArray

getArray

Methods inherited from interface mikera.arrayz.INDArray

abs, absCopy, add, add, addAt, addCopy, addCopy, addInnerProduct, addMultiple, addOuterProduct, addPower, addPower, applyOp, applyOp, applyOp, asElementList, asVector, broadcast, broadcastCloneLike, broadcastCopyLike, broadcastLike, broadcastLike, broadcastLike, checkMutable, clamp, componentCount, copy, dense, denseClone, dimensionality, divide, divide, divideCopy, elementAbsPowSum, elementCount, elementMax, elementMin, elementPowSum, elementProduct, elementsEqual, elementSquaredSum, elementSum, ensureMutable, epsilonEquals, epsilonEquals, equals, equalsArray, equalsArray, exactClone, exp, fill, get, get, get, get, get, get, get, get, get, getComponent, getComponents, getElements, getElements, getElements, getElements, getLongShape, getShape, getShape, getShapeClone, getSlices, getSlices, getSliceViews, getTransposeCopy, hasUncountable, immutable, innerProduct, innerProduct, innerProduct, innerProduct, isBoolean, isDense, isElementConstrained, isFullyMutable, isMutable, isSameShape, isSparse, isView, join, join, log, multiply, multiply, multiplyCopy, multiplyCopy, mutable, negate, negateCopy, nonZeroCount, outerProduct, pow, reciprocal, reciprocalCopy, reduce, reduceSlices, reduceSlices, reorder, reorder, reshape, rotateView, scale, scaleAdd, scaleAdd, scaleCopy, set, set, set, set, set, set, set, setElements, setElements, setElements, setInnerProduct, setMultiple, setMultiple, signum, signumCopy, slice, slice, sliceCount, sliceValue, sparse, sparseClone, sqrt, square, squareCopy, sub, sub, subArray, subCopy, toArray, toDoubleArray, toDoubleBuffer, toSliceArray, toVector, validate, withComponents

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

AStridedMatrix

protected AStridedMatrix(double[] data,
                         int rows,
                         int cols)

Method Detail

getArrayOffset

public abstract int getArrayOffset()

Description copied from interface: IStridedArray

Gets the data array offset for the first element of this strided array

Specified by:

getArrayOffset in interface IStridedArray

Returns:

rowStride

public abstract int rowStride()

Gets the row stride for this strided matrix. Each row has this offset in the underlying data array vs. the previous row. May be positive, zero or negative.

columnStride

public abstract int columnStride()

Gets the column stride for this strided matrix. Each column has this offset in the underlying data array vs. the previous column. May be positive, zero or negative.

subMatrix

public AStridedMatrix subMatrix(int rowStart,
                                int rowCount,
                                int colStart,
                                int colCount)

Description copied from interface: IMatrix

Gets a rectangular submatrix view of part of a matrix

Specified by:

subMatrix in interface IMatrix

Overrides:

subMatrix in class AMatrix

getRow

public AStridedVector getRow(int i)

Description copied from interface: IMatrix

Returns a row of the matrix. May or may not be a view, depending on matrix type. Intended for the fastest possible read access of the row. This often means a view, but might not be (e.g. getRow on a Matrix33 returns a Vector3).

Specified by:

getRow in interface IMatrix

Overrides:

getRow in class AMatrix

getColumn

public AStridedVector getColumn(int i)

Description copied from interface: IMatrix

Returns a column of the matrix. May or may not be a view, depending on matrix type. Intended for the fastest possible read access of the column. This often means a view, but might not be (e.g. getColumn on a Matrix33 returns a Vector3).

Specified by:

getColumn in interface IMatrix

Overrides:

getColumn in class AMatrix

getRowView

public AStridedVector getRowView(int i)

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

getColumnView

public final AStridedVector getColumnView(int i)

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

diagonalProduct

public double diagonalProduct()

Description copied from class: AMatrix

Computes the product of entries on the main diagonal of a matrix

Specified by:

diagonalProduct in interface IMatrix

Overrides:

diagonalProduct in class AMatrix

Returns:

trace

public double trace()

Description copied from interface: IMatrix

Computes the trace of a matrix, i.e. the sum of all elements on the leading diagonal

Specified by:

trace in interface IMatrix

Overrides:

trace in class AMatrix

Returns:

getBand

public AStridedVector getBand(int i)

Description copied from class: AMatrix

Gets a specific band of the matrix, as a view vector. The band is truncated at the edges of the matrix, i.e. it does not wrap around the matrix.

Specified by:

getBand in interface IMatrix

Overrides:

getBand in class AMatrix

Returns:

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

addToArray

public void addToArray(double[] dest,
                       int destOffset)

Description copied from interface: INDArray

Adds all the elements of this array to a double array, in row-major order

Specified by:

addToArray in interface INDArray

Overrides:

addToArray in class AMatrix

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

applyOpCopy

public final Matrix applyOpCopy(Op op)

Description copied from interface: INDArray

Applies a unary operator to all elements of the array (creating a new array)

Specified by:

applyOpCopy in interface INDArray

Overrides:

applyOpCopy in class AMatrix

reduce

public double reduce(Op2 op,
                     double init)

Description copied from interface: INDArray

Reduces over all elements of the array in row-major order. Applies the operator to the initial/previous result at each step. Returns the final result.

Specified by:

reduce in interface INDArray

Overrides:

reduce in class AMatrix

rowDotProduct

public double rowDotProduct(int i,
                            AVector a)

Description copied from class: AMatrix

Returns the dot product of a specific row with a vector. Unsafe operation: performs no bounds checking

Overrides:

rowDotProduct in class AMatrix

Returns:

add

public void add(AMatrix m)

Description copied from class: AMatrix

Adds another matrix to this matrix. Matrices must be the same size.

Overrides:

add in class AMatrix

copyRowTo

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

Parameters:

row - The index of the selected row

dest - Destination double[] array

destOffset - Offset into destination array

copyColumnTo

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

dest - Destination double[] array

getStrides

public int[] getStrides()

Description copied from interface: IStridedArray

Gets the strides for each dimension of this strided array. The returned array should not be modified

Specified by:

getStrides in interface IStridedArray

Returns:

getStride

public int getStride(int dimension)

Description copied from interface: IStridedArray

Gets the stide for a specific dimension in this strided array.

Specified by:

getStride in interface IStridedArray

Returns:

elementIterator

public Iterator<Double> elementIterator()

Description copied from interface: INDArray

Returns an iterator over all elements in this array, in row-major order

Specified by:

elementIterator in interface INDArray

Overrides:

elementIterator in class AMatrix

getTranspose

public AStridedMatrix getTranspose()

Description copied from interface: INDArray

Returns the transpose of this array. A transpose of an array is equivalent to reversing the order of dimensions. May or may not return a view depending on the array type.

Specified by:

getTranspose in interface INDArray

Specified by:

getTranspose in interface IMatrix

Overrides:

getTranspose in class AMatrix

Returns:

the transpose of this matrix

getTransposeView

public AStridedMatrix getTransposeView()

Description copied from interface: INDArray

Returns a transposed view of the array. May throw UnsupportedOperationException if the array type does not support this capability

Specified by:

getTransposeView in interface INDArray

Specified by:

getTransposeView in interface IMatrix

Overrides:

getTransposeView in class AMatrix

Returns:

the transpose of this matrix, as a view

isPackedArray

public boolean isPackedArray()

Description copied from class: AArrayMatrix

Returns true if the data array is fully packed by this matrix in row-major order

Specified by:

isPackedArray in interface IStridedArray

Specified by:

isPackedArray in class AArrayMatrix

Returns:

asDoubleArray

public double[] asDoubleArray()

Description copied from interface: INDArray

Returns the underlying double array representing the densely packed elements of this array Returns null if there is no such array

Specified by:

asDoubleArray in interface INDArray

Overrides:

asDoubleArray 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

clone

public final Matrix clone()

Description copied from interface: INDArray

Returns a clone of the array data, as a new array which will be fully mutable and may be of a different class to the original. Clone should attempt to return the most efficient possible array type. Clone should preserve sparsity property where possible, but this is not guaranteed.

Specified by:

clone in interface INDArray

Overrides:

clone in class AMatrix