mikera.matrixx

Class Matrix

java.lang.Object

mikera.transformz.ATransform

mikera.transformz.AAffineTransform

mikera.transformz.ALinearTransform

mikera.matrixx.AMatrix

mikera.matrixx.impl.AArrayMatrix

mikera.matrixx.impl.AStridedMatrix

mikera.matrixx.impl.ADenseArrayMatrix

mikera.matrixx.Matrix

All Implemented Interfaces:

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

public final class Matrix
extends ADenseArrayMatrix

Standard MxN matrix class backed by a fully packed double[] array This is the most efficient Vectorz type for 2D matrices.

Author:

Mike

Field Summary

Fields inherited from class mikera.matrixx.impl.AArrayMatrix

cols, data, rows

Constructor Summary

Constructors

Constructor and Description
Matrix(AMatrix m)

Method Summary

Methods

Modifier and Type	Method and Description
void	abs() Replaces all elements of this array with their absolute values, according to Math.abs(double)
void	add(AMatrix m) Adds another matrix to this matrix.
void	add(double d) Adds a double value to all elements in this array
void	add(Matrix m)
void	addMultiple(AMatrix m, double factor)
void	addMultiple(Matrix m, double factor)
void	addRowMultiple(int src, int dst, double factor) Adds a multiple of a source row to a destination row This is an elementary row operation
void	applyOp(Op op) Applies a unary operator to all elements of the array (in-place)
double[]	asDoubleArray() Returns the underlying double array representing the packed elements of this array Returns nil if there is no such underlying array
Vector	asVector() Returns the matrix values as a single reference Vector in the form [row0 row1 row2....]
void	clamp(double min, double max) Clamps all the elments of this array within the specified [min,max] range
Matrix	clone() Clones the transform, performing a deep copy where needed
Vector	cloneRow(int row)
void	copyColumnTo(int col, double[] dest, int destOffset)
void	copyRowTo(int row, double[] dest, int destOffset)
static Matrix	create(AMatrix m)
static Matrix	create(INDArray m)
static Matrix	create(int rowCount, int columnCount) Creates a new zero-filled matrix of the specified shape.
static Matrix	create(Object... rowVectors)
Iterator<Double>	elementIterator() Returns an iterator over all elements in this array.
double	elementSum() Returns the sum of all elements in the matrix
Matrix	exactClone() Returns an exact deep clone of an array (i.e.
void	exp() Computes the function e^x (in-place) for all array elements
double	get(int row, int column) Returns a specified element in the matrix
double[]	getArray()
int	getArrayOffset()
StridedVector	getBand(int band) Gets a specific band of the matrix, as a view vector.
AStridedVector	getColumn(int col) Returns a column of the matrix as a vector view
void	getElements(double[] dest, int offset) Gets all elements of the array, copying them into a double array
ArraySubVector	getRow(int row) Returns a row of the matrix as a vector view
StridedMatrix	getTranspose() Returns a transposed version of this matrix.
StridedMatrix	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
Matrix	innerProduct(AMatrix a)
Vector	innerProduct(AVector a)
Matrix	innerProduct(Matrix a)
boolean	isBoolean() Returns true if the array is boolean (contains only 0.0 or 1.0 values)
boolean	isPackedArray() Returns true if the data array is fully packed by this matrix in row-major order
boolean	isView() Return true if this array is a view type
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
void	multiply(double factor) Multiplies all elements of the array by a given double value
void	multiplyRow(int i, double factor) Multiplies a row by a constant factor This is an elementary row operation
long	nonZeroCount() Returns the number of non-zero elements in the array.
void	reciprocal() Replaces all elements in the array with their reciprocal
void	set(AMatrix a)
void	set(double value) Sets all elements of an array to a specific double value
void	set(int row, int column, double value) Sets a specified element in the matrix
void	setColumn(int j, AVector col)
void	setRow(int i, AVector row)
void	signum() Calculates the signum of all elements of the array
void	square() Squares all elements of the array
AStridedMatrix	subMatrix(int rowStart, int rows, int colStart, int cols)
void	swapColumns(int i, int j) Swaps two columns of the matrix in place
void	swapRows(int i, int j) Swaps two rows of the matrix in place This is an elementary row operation
void	toDoubleBuffer(DoubleBuffer dest) Copies the elements of this INDArray to the specified double buffer
Matrix	toMatrix() Coerces the matrix to the standard mutable Matrix type in row major order.
Matrix	toMatrixTranspose() Coerces the transpose of a matrix to the standard mutable Matrix type in row major order.
Vector	toVector() Converts the matrix to a single flattened vector in row major order.
Vector	transform(AVector a) Transforms a vector, returning a new transformed vector
void	transform(AVector source, AVector dest) Transforms the source vector, storing the result in the given destination vector
Vector	transform(Vector a) Transforms a vector, returning a new transformed vector
void	transform(Vector source, Vector dest)
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.
static Matrix	wrap(int rowCount, int columnCount, double[] data)

Methods inherited from class mikera.matrixx.impl.ADenseArrayMatrix

columnStride, rowStride

Methods inherited from class mikera.matrixx.impl.AStridedMatrix

getStride, getStrides

Methods inherited from class mikera.matrixx.impl.AArrayMatrix

columnCount, rowCount

Methods inherited from class mikera.matrixx.AMatrix

add, add, add, addAt, applyOp, asElementList, bandIndex, bandLength, bandLength, bandPosition, broadcast, broadcastCloneLike, broadcastLike, broadcastLike, calculateElement, calculateElement, compose, compose, composeWith, composeWith, copyOfMatrix, copyOfTranslationVector, copyTo, determinant, dimensionality, divide, divide, elementCount, elementDiv, elementMul, elementSquaredSum, ensureMutable, epsilonEquals, epsilonEquals, epsilonEquals, equals, equals, equals, equals, fill, get, get, get, getBandWrapped, getLeadingDiagonal, getLongShape, getMatrixComponent, getShape, getShape, getSlices, getSliceViews, getTransposeCopy, hashCode, hasOrthonormalColumns, hassOrthonormalRows, innerProduct, innerProduct, innerProduct, inputDimensions, inverse, isDiagonal, isElementConstrained, isFullyMutable, isHermitian, isIdentity, isInvertible, isLowerTriangular, isMutable, isOrthogonal, isPositiveDefinite, isRectangularDiagonal, isSameShape, isSameShape, isSquare, isSymmetric, isUpperTriangular, iterator, lowerBandwidth, lowerBandwidthLimit, mul, multiply, negate, outerProduct, outputDimensions, pow, reshape, reshape, scale, scaleAdd, set, set, set, set, setElements, setElements, slice, slice, sliceCount, sqrt, sub, sub, sub, sub, sub, toAffineTransform, toArray, toDoubleArray, toMutableMatrix, toString, trace, transformInPlace, transformInPlace, transposeInnerProduct, transposeInnerProduct, transposeInPlace, upperBandwidth, upperBandwidthLimit, validate

Methods inherited from class mikera.transformz.ALinearTransform

getTranslationComponent, isLinear

Methods inherited from class mikera.transformz.AAffineTransform

compose, transformNormal

Methods inherited from class mikera.transformz.ATransform

takeComponents, takeComponents, takeComponents

Methods inherited from class java.lang.Object

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

Methods inherited from interface mikera.arrayz.impl.IStridedArray

getShape

Methods inherited from interface mikera.arrayz.INDArray

add, applyOp, asElementList, broadcast, broadcastCloneLike, broadcastLike, copyTo, dimensionality, divide, divide, elementCount, elementSquaredSum, ensureMutable, epsilonEquals, epsilonEquals, equals, fill, get, get, get, getLongShape, getShape, getSlices, getSliceViews, getTransposeCopy, innerProduct, isElementConstrained, isFullyMutable, isMutable, isSameShape, multiply, negate, outerProduct, pow, reshape, scale, scaleAdd, set, set, set, set, setElements, setElements, slice, slice, sliceCount, sqrt, sub, sub, toArray, toDoubleArray, validate

Constructor Detail

Matrix

public Matrix(AMatrix m)

Method Detail

create

public static Matrix create(int rowCount,
            int columnCount)

Creates a new zero-filled matrix of the specified shape.

create

public static Matrix create(AMatrix m)

create

public static Matrix create(INDArray m)

create

public static Matrix create(Object... rowVectors)

isView

public boolean isView()

Description copied from interface: INDArray

Return true if this array is a view type

Specified by:

isView in interface INDArray

Overrides:

isView in class AMatrix

Returns:

isBoolean

public boolean isBoolean()

Description copied from interface: INDArray

Returns true if the array is boolean (contains only 0.0 or 1.0 values)

Specified by:

isBoolean in interface INDArray

Overrides:

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

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 ADenseArrayMatrix

wrap

public static Matrix wrap(int rowCount,
          int columnCount,
          double[] data)

subMatrix

public AStridedMatrix subMatrix(int rowStart,
                       int rows,
                       int colStart,
                       int cols)

Overrides:

subMatrix in class AStridedMatrix

innerProduct

public Vector innerProduct(AVector a)

Overrides:

innerProduct in class AMatrix

innerProduct

public Matrix innerProduct(Matrix a)

Overrides:

innerProduct in class AMatrix

innerProduct

public Matrix innerProduct(AMatrix a)

Overrides:

innerProduct in class AMatrix

elementSum

public double elementSum()

Description copied from class: AMatrix

Returns the sum of all elements in the matrix

Specified by:

elementSum in interface INDArray

Overrides:

elementSum in class AMatrix

Returns:

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

signum

public void signum()

Description copied from interface: INDArray

Calculates the signum of all elements of the array

Specified by:

signum in interface INDArray

Overrides:

signum in class AMatrix

square

public void square()

Description copied from interface: INDArray

Squares all elements of the array

Specified by:

square in interface INDArray

Overrides:

square 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

nonZeroCount

public 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

Returns:

clone

public Matrix clone()

Description copied from class: ATransform

Clones the transform, performing a deep copy where needed

Specified by:

clone in interface INDArray

Overrides:

clone in class AMatrix

Returns:

cloneRow

public Vector cloneRow(int row)

Overrides:

cloneRow in class AMatrix

copyRowTo

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

Overrides:

copyRowTo in class ADenseArrayMatrix

copyColumnTo

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

Overrides:

copyColumnTo in class AStridedMatrix

transform

public Vector transform(AVector a)

Description copied from class: ATransform

Transforms a vector, returning a new transformed vector

Overrides:

transform in class AMatrix

Returns:

transform

public Vector transform(Vector a)

Description copied from class: ATransform

Transforms a vector, returning a new transformed vector

Overrides:

transform in class AMatrix

Returns:

transform

public void transform(AVector source,
             AVector dest)

Description copied from class: ATransform

Transforms the source vector, storing the result in the given destination vector

Specified by:

transform in interface ITransform

Overrides:

transform in class AMatrix

transform

public void transform(Vector source,
             Vector dest)

Overrides:

transform in class AMatrix

getRow

public ArraySubVector getRow(int row)

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 col)

Description copied from class: AMatrix

Returns a column of the matrix as a vector view

Overrides:

getColumn in class AStridedMatrix

swapRows

public void swapRows(int i,
            int j)

Description copied from class: AMatrix

Swaps two rows of the matrix in place This is an elementary row operation

Overrides:

swapRows in class AMatrix

swapColumns

public void swapColumns(int i,
               int j)

Description copied from class: AMatrix

Swaps two columns of the matrix in place

Overrides:

swapColumns in class AMatrix

multiplyRow

public void multiplyRow(int i,
               double factor)

Description copied from class: AMatrix

Multiplies a row by a constant factor This is an elementary row operation

Overrides:

multiplyRow in class AMatrix

addRowMultiple

public void addRowMultiple(int src,
                  int dst,
                  double factor)

Description copied from class: AMatrix

Adds a multiple of a source row to a destination row This is an elementary row operation

Overrides:

addRowMultiple in class AMatrix

asVector

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

toVector

public Vector toVector()

Description copied from class: AMatrix

Converts the matrix to a single flattened vector in row major order.

Specified by:

toVector in interface INDArray

Overrides:

toVector in class AMatrix

Returns:

toMatrix

public final Matrix toMatrix()

Description copied from class: AMatrix

Coerces the matrix to the standard mutable Matrix type in row major order. Performs a copy if necessary.

Overrides:

toMatrix in class AMatrix

toMatrixTranspose

public Matrix toMatrixTranspose()

Description copied from class: AMatrix

Coerces the transpose of a matrix to the standard mutable Matrix type in row major order. Performs a copy if necessary.

Overrides:

toMatrixTranspose in class AMatrix

toDoubleBuffer

public void toDoubleBuffer(DoubleBuffer dest)

Description copied from interface: INDArray

Copies the elements of this INDArray to the specified double buffer

Specified by:

toDoubleBuffer in interface INDArray

Overrides:

toDoubleBuffer in class AMatrix

asDoubleArray

public double[] asDoubleArray()

Description copied from interface: INDArray

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

Specified by:

asDoubleArray in interface INDArray

Overrides:

asDoubleArray in class AStridedMatrix

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:

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 ADenseArrayMatrix

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 ADenseArrayMatrix

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

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

addMultiple

public void addMultiple(Matrix m,
               double factor)

add

public void add(Matrix m)

addMultiple

public void addMultiple(AMatrix m,
               double factor)

Overrides:

addMultiple in class AMatrix

add

public void add(double d)

Description copied from interface: INDArray

Adds a double value to all elements in this array

Specified by:

add in interface INDArray

Overrides:

add in class AMatrix

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

multiply

public void multiply(double factor)

Description copied from interface: INDArray

Multiplies all elements of the array by a given double value

Specified by:

multiply in interface INDArray

Overrides:

multiply in class AMatrix

set

public void set(AMatrix a)

Overrides:

set in class AMatrix

getElements

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

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

elementIterator

public Iterator<Double> elementIterator()

Description copied from interface: INDArray

Returns an iterator over all elements in this array.

Specified by:

elementIterator in interface INDArray

Overrides:

elementIterator in class AMatrix

Returns:

getTranspose

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

set

public void set(double value)

Description copied from interface: INDArray

Sets all elements of an array to a specific double value

Specified by:

set in interface INDArray

Overrides:

set 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

clamp

public void clamp(double min,
         double max)

Description copied from interface: INDArray

Clamps all the elments of this array within the specified [min,max] range

Specified by:

clamp in interface INDArray

Overrides:

clamp in class AMatrix

exactClone

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

setRow

public void setRow(int i,
          AVector row)

Overrides:

setRow in class AMatrix

setColumn

public void setColumn(int j,
             AVector col)

Overrides:

setColumn in class AMatrix

getBand

public StridedVector getBand(int band)

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.

Overrides:

getBand in class AMatrix

Returns:

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

Overrides:

index in class ADenseArrayMatrix

Returns:

getArrayOffset

public int getArrayOffset()

Specified by:

getArrayOffset in interface IStridedArray

Specified by:

getArrayOffset in class ADenseArrayMatrix

getArray

public double[] getArray()

Specified by:

getArray in interface IStridedArray

Overrides:

getArray in class AArrayMatrix