mikera.matrixx.impl

Class StridedMatrix

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.StridedMatrix

All Implemented Interfaces:

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

public final class StridedMatrix
extends AStridedMatrix

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

Methods

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....]
Matrix	clone() Returns a clone of the array, as a new array which will be fully mutable and may be of a different class to the original.
int	columnStride()
void	copyColumnTo(int col, double[] dest, int destOffset)
void	copyRowTo(int row, double[] dest, int destOffset)
static StridedMatrix	create(AMatrix m)
static StridedMatrix	create(int rowCount, int columnCount)
AMatrix	exactClone() Returns an exact deep clone of an array (i.e.
double	get(int row, int column) Returns a specified element in the matrix
int	getArrayOffset()
AStridedVector	getColumn(int i) Returns a column of the matrix as a vector view
void	getElements(double[] dest, int destOffset) Gets all elements of the array, copying them into a double array
AStridedVector	getRow(int i) Returns a row of the matrix as a vector view
AMatrix	getTranspose() Returns a transposed version of this matrix.
AMatrix	getTransposeView() Returns a transposed view of the array.
protected int	index(int row, int col) Computes the index into the data array for a given position in the 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
int	rowStride()
void	set(int row, int column, double value) Sets a specified element in the matrix
AStridedMatrix	subMatrix(int rowStart, int rowCount, int colStart, int colCount)
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.
void	validate() Validates the internal data structure of the INDArray.
static StridedMatrix	wrap(double[] data, int rows, int columns, int offset, int rowStride, int columnStride)
static StridedMatrix	wrap(Matrix m)

Methods inherited from class mikera.matrixx.impl.AStridedMatrix

asDoubleArray, getStride, getStrides

Methods inherited from class mikera.matrixx.impl.AArrayMatrix

getArray

Methods inherited from class mikera.matrixx.impl.ARectangularMatrix

columnCount, elementCount, getShape, getShape, getShapeClone, rowCount

Methods inherited from class mikera.matrixx.AMatrix

abs, add, add, add, add, add, addAt, addMultiple, addRowMultiple, applyOp, asElementList, bandIndex, bandLength, bandLength, bandPosition, broadcast, broadcastCloneLike, broadcastLike, broadcastLike, calculateElement, calculateElement, clamp, cloneColumn, cloneRow, compose, composeWith, copyTo, determinant, dimensionality, divide, divide, elementDiv, elementIterator, elementMul, elementSquaredSum, elementSum, ensureMutable, epsilonEquals, epsilonEquals, epsilonEquals, equals, equals, equals, equals, equalsTranspose, exp, fill, get, get, get, getBand, getBandWrapped, getLeadingDiagonal, getLongShape, getSlices, getSlices, getSliceViews, getTransposeCopy, hashCode, hasOrthonormalColumns, hasOrthonormalRows, immutable, innerProduct, innerProduct, innerProduct, innerProduct, innerProduct, innerProduct, inputDimensions, inverse, isBoolean, isDiagonal, isElementConstrained, isHermitian, isIdentity, isInvertible, isLowerTriangular, isOrthogonal, isPositiveDefinite, isRectangularDiagonal, isSameShape, isSameShape, isSquare, isSymmetric, isUpperTriangular, isView, isZero, iterator, join, log, lowerBandwidth, lowerBandwidthLimit, mul, multiply, multiply, multiplyRow, mutable, negate, nonZeroCount, outerProduct, outputDimensions, pow, reciprocal, replaceColumn, replaceRow, reshape, reshape, rotateView, scaleAdd, set, set, set, set, set, set, setColumn, setElements, setElements, setRow, signum, slice, slice, sliceCount, sqrt, square, sub, sub, sub, sub, sub, subArray, swapColumns, swapRows, toAffineTransform, toArray, toDoubleArray, toDoubleBuffer, toMatrix, toMatrixTranspose, toMutableMatrix, toString, toVector, trace, transform, transform, transform, transform, transformInPlace, transformInPlace, transposeInnerProduct, transposeInnerProduct, transposeInPlace, upperBandwidth, upperBandwidthLimit

Methods inherited from class mikera.arrayz.impl.AbstractArray

density, elementMax, elementMin, scale, sparse

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface mikera.arrayz.impl.IStridedArray

getArray, getShape

Methods inherited from interface mikera.arrayz.INDArray

abs, add, add, applyOp, asElementList, broadcast, broadcastCloneLike, broadcastLike, clamp, copyTo, dimensionality, divide, divide, elementCount, elementIterator, elementMax, elementMin, elementSquaredSum, elementSum, ensureMutable, epsilonEquals, epsilonEquals, equals, exp, fill, get, get, get, getLongShape, getShape, getShapeClone, getSlices, getSlices, getSliceViews, getTransposeCopy, immutable, innerProduct, isBoolean, isElementConstrained, isSameShape, isView, isZero, join, log, multiply, multiply, mutable, negate, nonZeroCount, outerProduct, pow, reciprocal, reshape, rotateView, scale, scaleAdd, set, set, set, set, set, setElements, setElements, signum, slice, slice, sliceCount, sparse, sqrt, square, sub, sub, subArray, toArray, toDoubleArray, toDoubleBuffer, toVector

Method Detail

create

public static StridedMatrix create(int rowCount,
                   int columnCount)

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

Returns:

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

Returns:

getRow

public AStridedVector getRow(int i)

Description copied from class: AMatrix

Returns a row of the matrix as a vector view

Overrides:

getRow in class AStridedMatrix

getColumn

public AStridedVector getColumn(int i)

Description copied from class: AMatrix

Returns a column of the matrix as a vector view

Overrides:

getColumn in class AStridedMatrix

copyRowTo

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

Overrides:

copyRowTo in class AStridedMatrix

copyColumnTo

public void copyColumnTo(int col,
                double[] dest,
                int destOffset)

Overrides:

copyColumnTo in class AStridedMatrix

rowStride

public int rowStride()

Specified by:

rowStride in class AStridedMatrix

columnStride

public int columnStride()

Specified by:

columnStride in class AStridedMatrix

getArrayOffset

public int getArrayOffset()

Specified by:

getArrayOffset in interface IStridedArray

Specified by:

getArrayOffset in class AStridedMatrix

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

subMatrix

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

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 AMatrix

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

Specified by:

getElements in interface INDArray

Overrides:

getElements in class AMatrix

getTranspose

public AMatrix getTranspose()

Description copied from class: AMatrix

Returns a transposed version of this matrix. May or may not be a view.

Specified by:

getTranspose in interface INDArray

Overrides:

getTranspose in class AMatrix

Returns:

getTransposeView

public AMatrix getTransposeView()

Description copied from interface: INDArray

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

Specified by:

getTransposeView in interface INDArray

Overrides:

getTransposeView in class AStridedMatrix

Returns:

get

public double get(int row,
         int column)

Description copied from class: AMatrix

Returns a specified element in the matrix

Specified by:

get in interface INDArray

Specified by:

get in interface IMatrix

Overrides:

get in class AArrayMatrix

Returns:

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 AArrayMatrix

Returns:

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

Returns:

set

public void set(int row,
       int column,
       double value)

Description copied from class: AMatrix

Sets a specified element in the matrix

Specified by:

set in interface INDArray

Specified by:

set in interface IMatrix

Overrides:

set in class AArrayMatrix

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 AArrayMatrix

exactClone

public AMatrix exactClone()

Description copied from interface: INDArray

Returns an exact deep clone of an array (i.e. of the same class as the original).

Specified by:

exactClone in interface INDArray

Specified by:

exactClone in class AMatrix

Returns:

create

public static StridedMatrix create(AMatrix m)

wrap

public static StridedMatrix wrap(Matrix m)

wrap

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

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

index

protected final int index(int row,
        int col)

Description copied from class: AArrayMatrix

Computes the index into the data array for a given position in the matrix

Specified by:

index in class AArrayMatrix

Returns:

clone

public Matrix clone()

Description copied from interface: INDArray

Returns a clone of the array, 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.

Specified by:

clone in interface INDArray

Overrides:

clone in class AMatrix

Returns: