mikera.matrixx

Class Matrix

java.lang.Object

mikera.transformz.ATransform

mikera.transformz.AAffineTransform

mikera.transformz.ALinearTransform

mikera.matrixx.AMatrix

mikera.matrixx.impl.ArrayMatrix

mikera.matrixx.Matrix

All Implemented Interfaces:

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

public final class Matrix
extends ArrayMatrix

Standard MxN matrix class backed by a flat double[] array

Author:

Mike

Field Summary

Fields inherited from class mikera.matrixx.impl.ArrayMatrix

cols, data, rows

Constructor Summary

Constructors

Constructor and Description
Matrix(AMatrix m)
Matrix(int rowCount, int columnCount)

Method Summary

Methods

Modifier and Type	Method and Description
void	add(AMatrix m) Adds another matrix to this matrix.
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)
Vector	asVector() Returns the matrix values as a single reference Vector in the form [row0 row1 row2....]
void	clamp(double min, double max)
Matrix	clone() Clones the transform, performing a deep copy where needed
int	columnCount() Returns the number of columns in the matrix
static Matrix	create(AMatrix m)
static Matrix	create(int rowCount, int columnCount)
Matrix	create(Object... rowVectors)
double	elementSum() Returns the sum of all elements in the matrix
Matrix	exactClone() Returns an exact deep clone of an array (i.e.
double	get(int row, int column) Returns a specified element in the matrix
StridedVector	getColumn(int row) 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.
Matrix	innerProduct(AMatrix a)
AVector	innerProduct(AVector a)
Matrix	innerProduct(Matrix a)
Vector	innerProduct(Vector a)
boolean	isPackedArray()
boolean	isView() Return true if this is a view
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
int	rowCount() Returns the number of rows in the matrix
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	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
void	transform(AVector source, AVector dest) Transforms the source vector, storing the result in the given destination vector
static Matrix	wrap(int rowCount, int columnCount, double[] data)

Methods inherited from class mikera.matrixx.AMatrix

abs, add, add, add, addAt, applyOp, asElementList, broadcast, calculateElement, cloneRow, compose, compose, composeWith, composeWith, copyOfMatrix, copyOfTranslationVector, copyTo, determinant, dimensionality, elementCount, elementIterator, elementMul, elementSquaredSum, epsilonEquals, epsilonEquals, epsilonEquals, equals, equals, equals, equals, exp, fill, get, get, get, getLeadingDiagonal, getLongShape, getMatrixComponent, getShape, getShape, getSlices, getSliceViews, hashCode, hasOrthonormalColumns, hassOrthonormalRows, innerProduct, innerProduct, inputDimensions, inverse, isDiagonal, isElementConstrained, isFullyMutable, isHermitian, isIdentity, isInvertible, isLowerTriangular, isMutable, isOrthogonal, isPositiveDefinite, isRectangularDiagonal, isSquare, isSymmetric, isUpperTriangular, isZeroMatrix, iterator, log, mul, multiply, negate, outerProduct, outputDimensions, pow, reshape, scale, scaleAdd, set, set, set, set, setElements, setElements, signum, slice, slice, sliceCount, sqrt, square, sub, sub, sub, sub, toAffineTransform, toMatrix, toMutableMatrix, toString, toVector, trace, transformInPlace, transformInPlace, transposeInPlace, 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, transform

Methods inherited from class java.lang.Object

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

Constructor Detail

Matrix

public Matrix(int rowCount,
      int columnCount)

Matrix

public Matrix(AMatrix m)

Method Detail

create

public static Matrix create(int rowCount,
            int columnCount)

create

public static Matrix create(AMatrix m)

create

public Matrix create(Object... rowVectors)

isView

public boolean isView()

Description copied from interface: INDArray

Return true if this is a view

Specified by:

isView in interface INDArray

Overrides:

isView in class AMatrix

Returns:

isPackedArray

public boolean isPackedArray()

Specified by:

isPackedArray in class ArrayMatrix

wrap

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

innerProduct

public AVector innerProduct(AVector a)

Overrides:

innerProduct in class AMatrix

innerProduct

public Vector innerProduct(Vector a)

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:

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:

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

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 AMatrix

getColumn

public StridedVector getColumn(int row)

Description copied from class: AMatrix

Returns a column of the matrix as a vector view

Overrides:

getColumn in class AMatrix

rowCount

public int rowCount()

Description copied from class: AMatrix

Returns the number of rows in the matrix

Specified by:

rowCount in interface IMatrix

Specified by:

rowCount in class AMatrix

columnCount

public int columnCount()

Description copied from class: AMatrix

Returns the number of columns in the matrix

Specified by:

columnCount in interface IMatrix

Specified by:

columnCount in class AMatrix

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:

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

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

Specified by:

get 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

Specified by:

set 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

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(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

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

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 AMatrix

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)

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