Matrix (Vectorz 0.62.0 API)

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
        
        mikera.matrixx.Matrix

All Implemented Interfaces:

Serializable, Cloneable, Iterable<AVector>, IDense, IDenseArray, IStridedArray, INDArray, IMatrix, IFastRows
```
public final class Matrix
extends ADenseArrayMatrix
```
Standard MxN matrix class backed by a densely packed double[] array This is the most efficient Vectorz type for dense 2D matrices.

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
Constructor and Description

Matrix(AMatrix m)
Creates a new Matrix with a copy of all data from the source matrix

Matrix(int rowCount, int columnCount)

Constructors
Constructor and Description
`Matrix(AMatrix m)` Creates a new Matrix with a copy of all data from the source matrix
`Matrix(int rowCount, int columnCount)`

Method Summary

All Methods Static Methods Instance Methods Concrete 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.
`static void`	`add(Matrix dest, Matrix a, Matrix b)`
`void`	`add2(AMatrix a, AMatrix b)` Adds two matrices to this matrix.
`void`	`add2(Matrix a, Matrix b)`
`void`	`addAt(int i, int j, double d)` Adds a value at a specific position in the matrix, mutating the matrix Does not perform bounds checking - this in an unsafe operation
`void`	`addMultiple(ADenseArrayMatrix m, double factor)`
`void`	`addMultiple(AMatrix m, double factor)` Adds a scalar multiple of another matrix to this matrix
`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)
`void`	`applyOp(Op2 op, double b)` Applies a binary operator to this array and a double value.
`double[]`	`asDoubleArray()` Returns the underlying double array representing the densely packed elements of this array Returns null if there is no such 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 elements of this array within the specified [min,max] range
`Matrix`	`copy()` Returns a defensive copy of the array data.
`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
`static Matrix`	`create(AMatrix m)` Creates a new mutable dense matrix containing a copy of another matroix
`static Matrix`	`create(AVector... data)` Creates a new Matrix using the given vectors as row data
`static Matrix`	`create(double[][] data)`
`static Matrix`	`create(INDArray m)`
`static Matrix`	`create(int... shape)` Creates a new zero-filled matrix of the specified shape.
`static Matrix`	`create(int rowCount, int columnCount)` Creates a new zero-filled matrix of the specified shape.
`static Matrix`	`createFromRows(Object... rows)`
`static Matrix`	`createIdentity(int dims)` Creates a square identity Matrix of the specified size. a_ij = 0 if i ≠ j a_ij = 1 if i = j
`static Matrix`	`createIdentity(int numRows, int numCols)` Creates a Matrix which contains ones along the main diagonal and zeros everywhere else.
`static Matrix`	`createRandom(int rows, int cols)`
`Iterator<Double>`	`elementIterator()` Returns an iterator over all elements in this array, in row-major order
`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
`Matrix`	`exactClone()` Creates a deep clone of an array, using the same class implementation as the original array
`void`	`exp()` Computes the function e^x (in-place) for all array elements
`void`	`fill(double value)` Fills this array with a single double value.
`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
`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.
`void`	`getElements(double[] dest, int offset)` Gets all elements of the array, copying them into a double array at the specified offset
`ArraySubVector`	`getRow(int row)` Returns a row of the matrix.
`ArraySubVector`	`getRowView(int row)` Returns a row of the matrix as a vector view.
`DenseColumnMatrix`	`getTranspose()` Returns the transpose of this array.
`DenseColumnMatrix`	`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
`Matrix`	`innerProduct(AMatrix a)` Computes the inner product of this matrix with another.
`Vector`	`innerProduct(AVector a)` Computes the inner product of this array with a vector
`boolean`	`isBoolean()` Returns true if the array is boolean (contains only 0.0 or 1.0 values)
`boolean`	`isFullyMutable()` If this method returns true, the INDArray is guaranteed to be fully mutable in all positions i.e.
`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 considered as 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 in place 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
`static void`	`scale(Matrix dest, Matrix src, double factor)`
`static void`	`scaleAdd(Matrix dest, Matrix a, Matrix b, double bFactor)`
`void`	`set(AMatrix a)` Sets this matrix with the element values from another matrix.
`void`	`set(AVector a)` Sets every row of this matrix with the element values from a vector.
`void`	`set(int i, int j, double value)` Sets a value at a given position in a mutable 2D array
`void`	`setColumn(int j, AVector col)` Sets a column in a matrix.
`void`	`setMultiple(Matrix m, double factor)`
`void`	`setRow(int i, AVector row)` Sets a row in a matrix to the value specified by the given vector
`void`	`signum()` Calculates the signum of all elements of this mutable array Sets each component of the array to its sign value (-1, 0 or 1)
`void`	`square()` Squares all elements of the array in place
`AStridedMatrix`	`subMatrix(int rowStart, int rows, int colStart, int cols)` Gets a rectangular submatrix view of part of a matrix
`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
`double[]`	`toDoubleArray()` Copies the elements of this array to a new double[] array.
`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()` Coerces the array into a flattened dense Vector, in row-major order May return the same array if it is already a Vector instance
`void`	`transform(AVector source, AVector dest)` Transforms a source vector into a destination vector, using matrix multiplication (inner product).
`void`	`transform(Vector source, Vector dest)`
`Matrix`	`transposeInnerProduct(Matrix s)`
`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.
`static Matrix`	`wrap(int rowCount, int columnCount, double[] data)` Wraps a double[] array as a dense Matrix.

Methods inherited from class mikera.matrixx.impl.ADenseArrayMatrix
add, add, addOuterProduct, addToArray, columnStride, equals, equals, equalsArray, isLowerTriangular, isUpperTriangular, reduce, rowDotProduct, rowStride, setElements, setElements

Methods inherited from class mikera.matrixx.impl.AStridedMatrix
applyOpCopy, clone, diagonalProduct, getColumnView, getStride, getStrides, 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
add, addCopy, addCopy, addCopy, addCopy, addCopy, addInnerProduct, addInnerProduct, addInnerProduct, addMultiple, addMultiple, addOuterProduct, applyOp, applyOp, applyOp, applyOp, asElementList, bandIndex, bandLength, bandPosition, bandStartColumn, bandStartRow, broadcast, broadcastCloneLike, broadcastCopyLike, broadcastLike, broadcastLike, checkColumnCount, checkDimension, checkRowCount, checkShape, composeWith, dense, denseClone, determinant, dimensionality, divide, divide, divide, divide, elementsEqual, ensureMutable, epsilonEquals, epsilonEquals, epsilonEquals, epsilonEquals, equals, equalsByRows, equalsTranspose, get, get, get, getBandWrapped, getColumnClone, getColumns, getLeadingDiagonal, getLongShape, getRowClone, getRows, getSlices, getSlices, getSliceViews, hashCode, hasOrthonormalColumns, hasOrthonormalRows, hasUncountable, immutable, innerProduct, innerProduct, innerProduct, innerProduct, inputDimensions, inverse, isDiagonal, isElementConstrained, isHermitian, isIdentity, isInvertible, isMutable, isOrthogonal, isOrthogonal, isPositiveDefinite, isRectangularDiagonal, isSymmetric, iterator, join, lowerBandwidth, lowerBandwidthLimit, mul, multiply, multiply, multiply, multiplyCopy, mutable, negate, outerProduct, outputDimensions, pow, rank, reduce, reduceSlices, reduceSlices, reorder, reorder, replaceColumn, replaceRow, reshape, reshape, rotateView, scaleAdd, scaleAdd, set, set, set, set, set, set, setElements, slice, slice, sliceCount, sparse, sparseClone, sqrt, sub, sub, sub, subArray, toAffineTransform, toArray, toMutableMatrix, toNestedDoubleArrays, toSliceArray, toString, toStringFull, transformInPlace, transformInPlace, 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
addCopy, addCopy, columnCount, diagonalProduct, getColumnClone, getColumns, getColumnView, getRowClone, getRows, innerProduct, inverse, isDiagonal, isIdentity, isInvertible, isRectangularDiagonal, isSquare, isSymmetric, rowCount, toNestedDoubleArrays, trace, transformInPlace, transposeInPlace

Methods inherited from interface mikera.arrayz.INDArray
absCopy, add, addAt, addCopy, addCopy, addInnerProduct, addMultiple, addOuterProduct, addPower, addPower, applyOp, applyOp, applyOpCopy, asElementList, broadcast, broadcastCloneLike, broadcastCopyLike, broadcastLike, broadcastLike, broadcastLike, checkMutable, clone, componentCount, dense, denseClone, dimensionality, divide, divide, divideCopy, elementAbsPowSum, elementCount, elementPowSum, elementProduct, elementsEqual, ensureMutable, epsilonEquals, epsilonEquals, equalsArray, 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, isDense, isElementConstrained, isMutable, isSameShape, isSparse, join, join, multiply, multiplyCopy, multiplyCopy, mutable, negate, negateCopy, outerProduct, pow, reciprocalCopy, reduce, reduceSlices, reduceSlices, reorder, reorder, reshape, rotateView, scale, scaleAdd, scaleAdd, scaleCopy, set, set, set, set, set, set, setElements, setInnerProduct, setMultiple, setMultiple, signumCopy, slice, slice, sliceCount, sliceValue, sparse, sparseClone, sqrt, squareCopy, sub, sub, subArray, subCopy, toArray, toSliceArray, 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
  - Matrix
```
public Matrix(AMatrix m)
```
    Creates a new Matrix with a copy of all data from the source matrix
    
    Parameters:
    
    m -
  - Matrix
```
public Matrix(int rowCount,
              int columnCount)
```
- 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(int... shape)
```
    Creates a new zero-filled matrix of the specified shape.
  - create
```
public static Matrix create(AMatrix m)
```
    Creates a new mutable dense matrix containing a copy of another matroix
  - createRandom
```
public static Matrix createRandom(int rows,
                                  int cols)
```
  - create
```
public static Matrix create(INDArray m)
```
  - createFromRows
```
public static Matrix createFromRows(Object... rows)
```
  - create
```
public static Matrix create(double[][] data)
```
  - create
```
public static Matrix create(AVector... data)
```
    Creates a new Matrix using the given vectors as row data
    
    Parameters:
    
    data -
    
    Returns:
  - 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
  - isView
```
public boolean isView()
```
    Description copied from interface: INDArray
    
    Return true if this array is considered as a view type. This indicates (but does not guarantee): a) Data is *likely* to be shared with other arrays, so mutation of one may affect others b) It is *unlikely* to be in the most efficient general purpose format isView is intended to be used as for heuristics. It should *not* be used where the outcome might affect correctness.
    
    Specified by:
    
    isView in interface INDArray
    
    Overrides:
    
    isView in class AMatrix
  - 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
  - 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
    
    Returns:
  - wrap
```
public static Matrix wrap(int rowCount,
                          int columnCount,
                          double[] data)
```
    Wraps a double[] array as a dense Matrix. Double array must contain exactly the right number of elements, if not consider Matrixx.wrapStrided(..) *
    
    Parameters:
    
    rowCount -
    
    columnCount -
    
    data -
    
    Returns:
  - subMatrix
```
public AStridedMatrix subMatrix(int rowStart,
                                int rows,
                                int colStart,
                                int cols)
```
    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
  - innerProduct
```
public Vector innerProduct(AVector a)
```
    Description copied from interface: INDArray
    
    Computes the inner product of this array with a vector
    
    Specified by:
    
    innerProduct in interface INDArray
    
    Specified by:
    
    innerProduct in interface IMatrix
    
    Overrides:
    
    innerProduct in class AMatrix
    
    Parameters:
    
    a - A vector
    
    Returns:
    
    A new array representing the inner product
  - innerProduct
```
public Matrix innerProduct(AMatrix a)
```
    Description copied from interface: IMatrix
    
    Computes the inner product of this matrix with another. Equivalent to matrix x matrix multiplication
    
    Specified by:
    
    innerProduct in interface IMatrix
    
    Overrides:
    
    innerProduct in class AMatrix
    
    Returns:
  - transposeInnerProduct
```
public Matrix transposeInnerProduct(Matrix s)
```
    Overrides:
    
    transposeInnerProduct 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 ADenseArrayMatrix
  - 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 ADenseArrayMatrix
  - 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 ADenseArrayMatrix
  - 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 ADenseArrayMatrix
  - 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 this mutable array Sets each component of the array to its sign value (-1, 0 or 1)
    
    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 in place
    
    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
  - copyRowTo
```
public final 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
    
    Overrides:
    
    copyRowTo in class ADenseArrayMatrix
    
    Parameters:
    
    row - The index of the selected row
    
    dest - Destination double[] array
    
    destOffset - Offset into destination array
  - copyColumnTo
```
public final 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
  - 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 ADenseArrayMatrix
  - transform
```
public void transform(Vector source,
                      Vector dest)
```
    Overrides:
    
    transform in class AMatrix
  - getRow
```
public ArraySubVector getRow(int row)
```
    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 ADenseArrayMatrix
  - getRowView
```
public ArraySubVector getRowView(int row)
```
    Description copied from interface: IMatrix
    
    Returns a row of the matrix as a vector view. May be used to modify the original matrix.
    
    Specified by:
    
    getRowView in interface IMatrix
    
    Overrides:
    
    getRowView in class AStridedMatrix
  - getColumn
```
public AStridedVector getColumn(int col)
```
    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 ADenseArrayMatrix
  - 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 ADenseArrayMatrix
  - toVector
```
public Vector toVector()
```
    Description copied from interface: INDArray
    
    Coerces the array into a flattened dense Vector, in row-major order May return the same array if it is already a Vector instance
    
    Specified by:
    
    toVector in interface INDArray
    
    Overrides:
    
    toVector in class AMatrix
  - 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
  - toDoubleArray
```
public final double[] toDoubleArray()
```
    Description copied from interface: INDArray
    
    Copies the elements of this array to a new double[] array.
    
    Specified by:
    
    toDoubleArray in interface INDArray
    
    Overrides:
    
    toDoubleArray 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 densely packed elements of this array Returns null if there is no such array
    
    Specified by:
    
    asDoubleArray in interface INDArray
    
    Overrides:
    
    asDoubleArray in class AStridedMatrix
  - get
```
public 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
  - 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 ADenseArrayMatrix
  - 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 ADenseArrayMatrix
    
    Returns:
  - addAt
```
public void addAt(int i,
                  int j,
                  double d)
```
    Description copied from interface: IMatrix
    
    Adds a value at a specific position in the matrix, mutating the matrix Does not perform bounds checking - this in an unsafe operation
    
    Specified by:
    
    addAt in interface IMatrix
    
    Overrides:
    
    addAt in class AMatrix
  - set
```
public 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
  - 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
  - applyOp
```
public void applyOp(Op2 op,
                    double b)
```
    Description copied from interface: INDArray
    
    Applies a binary operator to this array and a double value. Works as if the double value was broadcast to the shape of this array.
    
    Specified by:
    
    applyOp in interface INDArray
    
    Overrides:
    
    applyOp in class AMatrix
  - addMultiple
```
public void addMultiple(ADenseArrayMatrix m,
                        double factor)
```
  - setMultiple
```
public void setMultiple(Matrix m,
                        double factor)
```
  - 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 ADenseArrayMatrix
  - add2
```
public void add2(AMatrix a,
                 AMatrix b)
```
    Description copied from interface: IMatrix
    
    Adds two matrices to this matrix. May be better optimised than adding both matrices individually.
    
    Specified by:
    
    add2 in interface IMatrix
    
    Overrides:
    
    add2 in class AMatrix
  - add
```
public static void add(Matrix dest,
                       Matrix a,
                       Matrix b)
```
  - scale
```
public static void scale(Matrix dest,
                         Matrix src,
                         double factor)
```
  - scaleAdd
```
public static void scaleAdd(Matrix dest,
                            Matrix a,
                            Matrix b,
                            double bFactor)
```
  - add2
```
public void add2(Matrix a,
                 Matrix b)
```
  - addMultiple
```
public void addMultiple(AMatrix m,
                        double factor)
```
    Description copied from class: AMatrix
    
    Adds a scalar multiple of another matrix to this matrix
    
    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. Implementations may optimize the case of 0.0
    
    Specified by:
    
    add in interface INDArray
    
    Overrides:
    
    add in class AMatrix
  - multiply
```
public void multiply(double factor)
```
    Description copied from interface: INDArray
    
    Multiplies all elements of the array in place by a given double value
    
    Specified by:
    
    multiply in interface INDArray
    
    Overrides:
    
    multiply in class AMatrix
  - set
```
public void set(AMatrix a)
```
    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 ADenseArrayMatrix
  - set
```
public void set(AVector a)
```
    Description copied from class: AMatrix
    
    Sets every row of this matrix with the element values from a vector.
    
    Overrides:
    
    set in class ADenseArrayMatrix
  - 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 at the specified offset
    
    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, in row-major order
    
    Specified by:
    
    elementIterator in interface INDArray
    
    Overrides:
    
    elementIterator in class AStridedMatrix
  - getTranspose
```
public DenseColumnMatrix 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 DenseColumnMatrix 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
  - fill
```
public void fill(double value)
```
    Description copied from interface: INDArray
    
    Fills this array with a single double value. Requires the array to be mutable.
    
    Specified by:
    
    fill in interface INDArray
    
    Overrides:
    
    fill 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 elements of this array within the specified [min,max] range
    
    Specified by:
    
    clamp in interface INDArray
    
    Overrides:
    
    clamp in class AMatrix
  - copy
```
public Matrix copy()
```
    Description copied from interface: INDArray
    
    Returns a defensive copy of the array data. Use this if the original array might change and you need a defensive copy. May return the same array if the original was immutable, otherwise will return a defensive copy.
    
    Specified by:
    
    copy in interface INDArray
    
    Overrides:
    
    copy in class AMatrix
  - exactClone
```
public Matrix 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
  - 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 ADenseArrayMatrix
  - setColumn
```
public void setColumn(int j,
                      AVector col)
```
    Description copied from class: AMatrix
    
    Sets a column in a matrix.
    
    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.
    
    Specified by:
    
    getBand in interface IMatrix
    
    Overrides:
    
    getBand in class AStridedMatrix
    
    Returns:
  - index
```
protected final 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
    
    Overrides:
    
    index in class ADenseArrayMatrix
    
    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 IDenseArray
    
    Specified by:
    
    getArrayOffset in interface IStridedArray
    
    Specified by:
    
    getArrayOffset in class ADenseArrayMatrix
    
    Returns:
  - createIdentity
```
public static Matrix createIdentity(int numRows,
                                    int numCols)
```
    Creates a Matrix which contains ones along the main diagonal and zeros everywhere else. If square, is equal to the identity matrix.
    
    Parameters:
    
    numRows - Number of rows in the matrix.
    
    numCols - NUmber of columns in the matrix.
    
    Returns:
    
    A matrix with diagonal elements equal to one.
  - createIdentity
```
public static Matrix createIdentity(int dims)
```
    Creates a square identity Matrix of the specified size.
    
    a_ij = 0 if i ≠ j
    a_ij = 1 if i = j
    
    Returns:
    
    A new instance of an identity matrix.

Class Matrix

Field Summary

Fields inherited from class mikera.matrixx.impl.AArrayMatrix

Fields inherited from class mikera.matrixx.impl.ARectangularMatrix

Constructor Summary

Method Summary

Methods inherited from class mikera.matrixx.impl.ADenseArrayMatrix

Methods inherited from class mikera.matrixx.impl.AStridedMatrix

Methods inherited from class mikera.matrixx.impl.AArrayMatrix

Methods inherited from class mikera.matrixx.impl.ARectangularMatrix

Methods inherited from class mikera.matrixx.AMatrix

Methods inherited from class mikera.arrayz.impl.AbstractArray

Methods inherited from class java.lang.Object

Methods inherited from interface mikera.matrixx.IMatrix

Methods inherited from interface mikera.arrayz.INDArray

Methods inherited from interface mikera.arrayz.impl.IDenseArray

Methods inherited from interface mikera.arrayz.impl.IStridedArray

Methods inherited from interface java.lang.Iterable

Constructor Detail

Matrix

Matrix

Method Detail

create

create

create

createRandom

create

createFromRows

create

create

isFullyMutable

isView

isBoolean

isZero

isPackedArray

wrap

subMatrix

innerProduct

innerProduct

transposeInnerProduct

elementSum

elementSquaredSum

elementMax

elementMin

abs

signum

square

exp

log

nonZeroCount

copyRowTo

copyColumnTo

transform

transform

getRow

getRowView

getColumn

swapRows

swapColumns

multiplyRow

addRowMultiple

asVector

toVector

toMatrix

toDoubleArray

toMatrixTranspose

toDoubleBuffer

asDoubleArray

get

unsafeSet

unsafeGet

addAt

set

applyOp

applyOp

addMultiple

setMultiple

add

add2

add