mikera.matrixx.impl

Class ADenseArrayMatrix

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

All Implemented Interfaces:

Serializable, Cloneable, Iterable<AVector>, IDense, IDenseArray, IStridedArray, INDArray, IMatrix, IFastRows

Direct Known Subclasses:

Matrix

public abstract class ADenseArrayMatrix
extends AStridedMatrix
implements IFastRows, IDenseArray

Abstract base class for matrices wrapping a dense (rows*cols) subset of a double[] array

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	ADenseArrayMatrix(double[] data, int rows, int cols)

Method Summary

Modifier and Type	Method and Description
void	add(ADenseArrayMatrix a, ADenseArrayMatrix b)
void	add(AMatrix a) Adds another matrix to this matrix.
void	add(AVector v) Adds a vector to every row of this matrix.
void	addOuterProduct(AVector a, AVector b) Adds the outer product of two vectors to this matrix
void	addToArray(double[] data, int offset) Adds all the elements of this array to a double array, in row-major order
ADenseArrayVector	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	copyRowTo(int row, double[] dest, int destOffset) Copies the elements in a slected row of this matrix to a double array
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
boolean	equals(AMatrix a) Returns true if this matrix is exactly equal to another matrix
boolean	equals(INDArray a) Checks if two arrays are equal exactly in terms of both value and shape
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
abstract 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.
ADenseArrayVector	getRow(int i) Returns a row of the matrix.
protected int	index(int row, int col) Computes the index into the underlying data array for a given position in this array-backed matrix
boolean	isLowerTriangular() Returns true if a matrix is lower triangular.
boolean	isPackedArray() Returns true if the data array is fully packed by this matrix in row-major order
boolean	isUpperTriangular() Returns true if a matrix is upper triangular An upper triangular matrix is defined as having all elements equal to 0.0 where i > j
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.
int	rowStride() Gets the row stride for this strided matrix.
void	set(AMatrix m) Sets this matrix with the element values from another matrix.
void	set(AVector v) Sets every row of this matrix with the element values from a vector.
void	setElements(double[] values, int offset) Sets all elements in an array using the given double values
void	setElements(int pos, double[] values, int offset, int length) Sets elements in an array using the given double values.
void	setRow(int i, AVector row) Sets a row in a matrix to the value specified by the given vector
void	transform(AVector source, AVector dest) Transforms a source vector into a destination vector, using matrix multiplication (inner product).
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.

Methods inherited from class mikera.matrixx.impl.AStridedMatrix

applyOp, applyOpCopy, asDoubleArray, clone, copyColumnTo, diagonalProduct, elementIterator, getBand, getColumnView, getRowView, getStride, getStrides, getTranspose, getTransposeView, subMatrix, trace

Methods inherited from class mikera.matrixx.impl.AArrayMatrix

get, getArray, getTransposeCopy, set

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, 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, ensureMutable, epsilonEquals, epsilonEquals, epsilonEquals, epsilonEquals, equals, 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, isMutable, isOrthogonal, isOrthogonal, isPositiveDefinite, isRectangularDiagonal, isSymmetric, 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, setColumn, 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, 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, elementPowSum, elementProduct, equals, equalsArray, get, get, get, get, get, getComponent, getComponents, getElements, getElements, getElements, isDense, isSparse, join, multiplyCopy, negateCopy, reciprocalCopy, scale, scaleCopy, 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.matrixx.IMatrix

add2, addAt, addCopy, addCopy, columnCount, diagonalProduct, get, getBand, getColumnClone, getColumns, getColumnView, getRowClone, getRows, getRowView, getTranspose, getTransposeView, innerProduct, innerProduct, innerProduct, inverse, isDiagonal, isIdentity, isInvertible, isRectangularDiagonal, isSquare, isSymmetric, rowCount, set, subMatrix, toNestedDoubleArrays, trace, transformInPlace, transposeInPlace

Methods inherited from interface mikera.arrayz.INDArray

abs, absCopy, add, add, addAt, addCopy, addCopy, addInnerProduct, addMultiple, addOuterProduct, addPower, addPower, applyOp, applyOp, applyOp, applyOp, applyOpCopy, asDoubleArray, asElementList, broadcast, broadcastCloneLike, broadcastCopyLike, broadcastLike, broadcastLike, broadcastLike, checkMutable, clamp, clone, componentCount, copy, dense, denseClone, dimensionality, divide, divide, divideCopy, elementAbsPowSum, elementCount, elementIterator, elementPowSum, elementProduct, elementsEqual, ensureMutable, epsilonEquals, epsilonEquals, equalsArray, exactClone, exp, fill, 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, 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, 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 mikera.arrayz.impl.IDenseArray

getArray

Methods inherited from interface mikera.arrayz.impl.IStridedArray

getArray

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

ADenseArrayMatrix

protected ADenseArrayMatrix(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 IDenseArray

Specified by:

getArrayOffset in interface IStridedArray

Specified by:

getArrayOffset in class AStridedMatrix

Returns:

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:

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 AStridedMatrix

isUpperTriangular

public boolean isUpperTriangular()

Description copied from class: AMatrix

Returns true if a matrix is upper triangular An upper triangular matrix is defined as having all elements equal to 0.0 where i > j

Overrides:

isUpperTriangular in class AMatrix

isLowerTriangular

public boolean isLowerTriangular()

Description copied from class: AMatrix

Returns true if a matrix is lower triangular. A lower triangular matrix is defined as having all elements equal to 0.0 where i < j

Overrides:

isLowerTriangular in class AMatrix

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

unsafeGet

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

set

public void set(AVector v)

Description copied from class: AMatrix

Sets every row of this matrix with the element values from a vector.

Overrides:

set in class AMatrix

set

public void set(AMatrix m)

Description copied from class: AMatrix

Sets this matrix with the element values from another matrix. Source matrix must have the same shape.

Overrides:

set in class AMatrix

setElements

public void setElements(double[] values,
                        int offset)

Description copied from interface: INDArray

Sets all elements in an array using the given double values

Specified by:

setElements in interface INDArray

Overrides:

setElements in class AMatrix

Parameters:

values - Element values in a double[] array. There must be at least as many element values as elements in this array.

offset - Position in the values array from which to start taking values.

setElements

public void setElements(int pos,
                        double[] values,
                        int offset,
                        int length)

Description copied from interface: INDArray

Sets elements in an array using the given double values. The source array must contain at least the specified length in terms of number of elements

Specified by:

setElements in interface INDArray

Overrides:

setElements in class AbstractArray<AVector>

Parameters:

pos - Offset into this array, expressed in terms of number of elements in row major order

values - Element values in a double[] array. There must be at least as many element values as elements in this array.

offset - Position in the values array from which to start taking values.

length - Number of elements to set.

getRow

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

Specified by:

getRow in interface IFastRows

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

setRow

public void setRow(int i,
                   AVector row)

Description copied from class: AMatrix

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

Overrides:

setRow 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

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

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>

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>

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

unsafeSet

public 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

index

protected int index(int row,
                    int col)

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:

transform

public void transform(AVector source,
                      AVector dest)

Description copied from interface: IMatrix

Transforms a source vector into a destination vector, using matrix multiplication (inner product). The destination vector is overwritten.

Specified by:

transform in interface IMatrix

Overrides:

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

add

public void add(AMatrix a)

Description copied from class: AMatrix

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

Overrides:

add in class AStridedMatrix

add

public void add(ADenseArrayMatrix a,
                ADenseArrayMatrix b)

addToArray

public void addToArray(double[] data,
                       int offset)

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 AStridedMatrix

addOuterProduct

public void addOuterProduct(AVector a,
                            AVector b)

Description copied from class: AMatrix

Adds the outer product of two vectors to this matrix

Overrides:

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

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 AStridedMatrix

Returns:

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

equals

public boolean equals(INDArray a)

Description copied from interface: INDArray

Checks if two arrays are equal exactly in terms of both value and shape

Specified by:

equals in interface INDArray

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:

asVector

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