mikera.matrixx.impl

Class StridedRowMatrix

java.lang.Object

mikera.arrayz.impl.AbstractArray<AVector>

mikera.matrixx.AMatrix

mikera.matrixx.impl.ARectangularMatrix

mikera.matrixx.impl.AArrayMatrix

mikera.matrixx.impl.AStridedMatrix

mikera.matrixx.impl.StridedRowMatrix

All Implemented Interfaces:

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

public final class StridedRowMatrix
extends AStridedMatrix

A strided matrix implementation with a column stride of 1 Provides a fast, mutable subMatrix view for the dense Matrix class

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

Method Summary

Modifier and Type	Method and Description
void	applyOp(Op op) Applies a unary operator to all elements of the array (in-place)
AVector	asVector() Returns the matrix values as a single reference Vector in the form [row0 row1 row2....]
int	columnStride() Gets the column stride for this strided matrix.
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
boolean	equals(AMatrix a) Returns true if this matrix is exactly equal to another matrix
boolean	equalsArray(double[] data, int offset) Returns true if the elements in this array exactly match the elements in the given array, in row-major order
AMatrix	exactClone() Creates a deep clone of an array, using the same class implementation as the original array
double	get(int i, int j) Returns the double value at the specified position in a 2D matrix
int	getArrayOffset() Gets the data array offset for the first element of this strided array
AStridedVector	getColumn(int i) Returns a column of the matrix.
void	getElements(double[] dest, int destOffset) Gets all elements of the array, copying them into a double array at the specified offset
AStridedVector	getRow(int i) Returns a row of the matrix.
AStridedMatrix	getTranspose() Returns the transpose of this array.
AStridedMatrix	getTransposeView() Returns a transposed view of the array.
protected int	index(int i, int j) Computes the index into the underlying data array for a given position in this array-backed 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	isPackedArray() Returns true if the data array is fully packed by this matrix in row-major order
double	rowDotProduct(int row, AVector v) Returns the dot product of a specific row with a vector.
int	rowStride() Gets the row stride for this strided matrix.
void	set(int i, int j, double value) Sets a value at a given position in a mutable 2D array
void	setRow(int row, AVector v) Sets a row in a matrix to the value specified by the given vector
AStridedMatrix	subMatrix(int rowStart, int rowCount, int colStart, int colCount) Gets a rectangular submatrix view of part of a matrix
double	unsafeGet(int i, int j) 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 i, int j, 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.
void	validate() Validates the internal data structure of the INDArray.
static StridedRowMatrix	wrap(AStridedMatrix m)
static StridedRowMatrix	wrap(double[] data, int rows, int columns, int offset, int rowStride)

Methods inherited from class mikera.matrixx.impl.AStridedMatrix

add, add, addToArray, applyOpCopy, asDoubleArray, clone, diagonalProduct, elementIterator, getBand, getColumnView, getRowView, getStride, getStrides, isZero, reduce, trace

Methods inherited from class mikera.matrixx.impl.AArrayMatrix

getArray, getTransposeCopy

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, 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, equalsByRows, equalsTranspose, exp, fill, get, get, get, getBandWrapped, getColumnClone, getColumns, getLeadingDiagonal, getLongShape, getRowClone, getRows, getSlices, getSlices, getSliceViews, 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, 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, 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

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, 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, exp, fill, get, get, get, get, get, get, get, get, getComponent, getComponents, getElements, getElements, getElements, getLongShape, getShape, getShape, getShapeClone, getSlices, getSlices, getSliceViews, getTransposeCopy, hasUncountable, immutable, innerProduct, innerProduct, innerProduct, innerProduct, isBoolean, isDense, isElementConstrained, 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, 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, withComponents

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

get

public final double get(int i,
                        int j)

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

Overrides:

get in class AArrayMatrix

set

public final void set(int i,
                      int j,
                      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 AArrayMatrix

unsafeGet

public final double unsafeGet(int i,
                              int j)

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 AArrayMatrix

Returns:

unsafeSet

public final void unsafeSet(int i,
                            int j,
                            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 AArrayMatrix

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

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 AStridedMatrix

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 AStridedMatrix

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

Specified by:

copyRowTo in class AStridedMatrix

Parameters:

row - The index of the selected row

dest - Destination double[] array

destOffset - Offset into destination array

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

Specified by:

copyColumnTo in class AStridedMatrix

dest - Destination double[] array

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

Overrides:

isPackedArray in class AStridedMatrix

Returns:

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 AStridedMatrix

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 AStridedMatrix

getElements

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

Description copied from interface: INDArray

Gets all elements of the array, copying them into a double array at the specified offset

Specified by:

getElements in interface INDArray

Overrides:

getElements in class AMatrix

rowDotProduct

public double rowDotProduct(int row,
                            AVector v)

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 AStridedMatrix

Returns:

setRow

public void setRow(int row,
                   AVector v)

Description copied from class: AMatrix

Sets a row in a matrix to the value specified by the given vector

Overrides:

setRow 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 AStridedMatrix

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 AStridedMatrix

Returns:

the transpose of this matrix, as a view

asVector

public AVector asVector()

Description copied from class: AMatrix

Returns the matrix values as a single reference Vector in the form [row0 row1 row2....]

Specified by:

asVector in interface INDArray

Overrides:

asVector 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

wrap

public static StridedRowMatrix wrap(AStridedMatrix m)

wrap

public static StridedRowMatrix wrap(double[] data,
                                    int rows,
                                    int columns,
                                    int offset,
                                    int rowStride)

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

equals

public boolean equals(AMatrix a)

Description copied from class: AMatrix

Returns true if this matrix is exactly equal to another matrix

Overrides:

equals in class AMatrix

equalsArray

public boolean equalsArray(double[] data,
                           int offset)

Description copied from interface: INDArray

Returns true if the elements in this array exactly match the elements in the given array, in row-major order

Specified by:

equalsArray in interface INDArray

Overrides:

equalsArray in class AMatrix

Parameters:

data - Array of double element values to check for equality

offset - Offset into the data array

Returns:

getArrayOffset

public 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

Specified by:

getArrayOffset in class AStridedMatrix

Returns:

rowStride

public int rowStride()

Description copied from class: AStridedMatrix

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.

Specified by:

rowStride in class AStridedMatrix

columnStride

public int columnStride()

Description copied from class: AStridedMatrix

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.

Specified by:

columnStride in class AStridedMatrix

index

protected int index(int i,
                    int j)

Description copied from class: AArrayMatrix

Computes the index into the underlying data array for a given position in this array-backed matrix

Specified by:

index in class AArrayMatrix

Returns: