mikera.matrixx

Class Matrix11

java.lang.Object

mikera.arrayz.impl.AbstractArray<AVector>

mikera.matrixx.AMatrix

mikera.matrixx.impl.APrimitiveMatrix

mikera.matrixx.Matrix11

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.lang.Comparable<INDArray>, java.lang.Iterable<AVector>, INDArray, IMatrix

public final class Matrix11
extends APrimitiveMatrix

Optimised 1x1 matrix implementation

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Matrix11()
Matrix11(AMatrix m)
Matrix11(double value)

Method Summary

Modifier and Type	Method and Description
void	addAt(int i, int j, double value) Adds a value at a specific position in the matrix, mutating the matrix Does not perform bounds checking - this in an unsafe operation
void	applyOp(Op op) Applies a unary operator to all elements of the array (in-place)
int	checkSquare() Checks if a matrix is square.
int	columnCount() Gets the number of columns in this matrix (dimension 1)
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 selected row of this matrix to a double array
double	determinant() Calculates the determinant of the matrix.
long	elementCount() Returns the total number of elements in this 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	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
AMatrix	exactClone() Creates a deep clone of an array, using the same class implementation as the original array
double	get(int row, int column) Returns the double value at the specified position in a 2D matrix
Vector1	getColumnClone(int column) Returns a column of the matrix as a new cloned, mutable vector The cloned column may be modified without affecting the original matrix.
void	getElements(double[] data, int offset) Copies all elements of this array a double array at the specified offset
Vector1	getRowClone(int row) Returns a row of the matrix as a new cloned, mutable vector.
Matrix11	inverse() Computes the inverse of a matrix.
boolean	isDiagonal() Returns true iff this matrix is a square diagonal matrix
boolean	isIdentity() Checks if this is an identity matrix (i.e.
boolean	isZero() Returns true if the matrix is the zero matrix (all components zero)
void	multiply(double factor) Multiplies all elements of the array in place by a given double value
long	nonZeroCount() Returns the number of non-zero elements in the array.
int	rowCount() Gets the number of rows in this matrix (dimension 0)
void	set(int row, int column, double value) Sets a value at a given position in a mutable 2D array
double[]	toDoubleArray() Copies the elements of this array to a new double[] array.
double	trace() Computes the trace of a matrix, i.e.
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.

Methods inherited from class mikera.matrixx.impl.APrimitiveMatrix

copy, getColumn, getRow, isFullyMutable, isSquare

Methods inherited from class mikera.matrixx.AMatrix

abs, add, add, add, add, add2, addCopy, addCopy, addCopy, addCopy, addCopy, addInnerProduct, addInnerProduct, addInnerProduct, addMultiple, addMultiple, addMultiple, addOuterProduct, addOuterProduct, addOuterProductSparse, addOuterProductSparse, addRowMultiple, addSparse, addSparse, addToArray, applyOp, applyOp, applyOp, applyOp, applyOp, applyOpCopy, asDoubleArray, asElementList, asVector, bandIndex, bandLength, bandPosition, bandStartColumn, bandStartRow, broadcast, broadcastCloneLike, broadcastCopyLike, broadcastLike, broadcastLike, checkColumn, checkRow, clamp, clone, composeWith, dense, denseClone, diagonalProduct, dimensionality, divide, divide, divide, divide, divideCopy, elementIterator, elementsEqual, ensureMutable, epsilonEquals, epsilonEquals, epsilonEquals, equals, equals, equals, equalsTranspose, exp, fill, get, get, get, get, getBand, getBandWrapped, getColumns, getColumnView, getElement, getLeadingDiagonal, getLongShape, getRows, getRowView, getShape, getShape, getShapeClone, getSlices, getSlices, getSliceViews, getTranspose, getTransposeCopy, getTransposeView, hashCode, hasOrthonormalColumns, hasOrthonormalRows, hasUncountable, immutable, innerProduct, innerProduct, innerProduct, innerProduct, innerProduct, innerProduct, inputDimensions, isBoolean, isElementConstrained, isHermitian, isInvertible, isLowerTriangular, isMutable, isOrthogonal, isOrthogonal, isPositiveDefinite, isRectangularDiagonal, isSameShape, isSameShape, isSymmetric, isUpperTriangular, isView, iterator, join, log, lowerBandwidth, lowerBandwidthLimit, mul, multiply, multiply, multiply, multiplyCopy, multiplyRow, mutable, negate, outerProduct, outputDimensions, pow, rank, reciprocal, reduce, reduce, reduceSlices, reduceSlices, reorder, reorder, replaceColumn, replaceRow, reshape, reshape, rotateView, rowDotProduct, scaleAdd, scaleAdd, set, set, set, set, set, set, set, set, setApplyOp, setApplyOp, setColumn, setElements, setElements, setMultiple, setMultiple, setMultiple, setMultiple, setMultiple, setRow, setSparse, setSparse, signum, slice, slice, sliceCount, sparse, sparseClone, sqrt, square, sub, sub, sub, subArray, subCopy, subMatrix, swapColumns, swapRows, toAffineTransform, toDoubleBuffer, toMatrix, toMatrixTranspose, toMutableMatrix, toNestedDoubleArrays, toSliceArray, toString, toStringFull, toVector, transform, transform, transformInPlace, transformInPlace, transposeInnerProduct, transposeInnerProduct, transposeInPlace, upperBandwidth, upperBandwidthLimit, validate

Methods inherited from class mikera.arrayz.impl.AbstractArray

absCopy, absDiff, absDiffCopy, add, addApplyOp, addAt, addCopy, addInnerProduct, addInnerProduct, addMultipleSparse, addPower, addPower, addSparse, broadcastLike, compareTo, componentCount, density, divideCopy, elementAbsPowSum, elementMaxAbs, elementPowSum, elementProduct, epsilonEquals, equals, equalsArray, get, get, get, get, getComponent, getComponents, getElements, getElements, getElements, isDense, isSparse, join, multiplyCopy, negateCopy, reciprocalCopy, scale, scaleCopy, setElements, setInnerProduct, setSparse, signumCopy, sliceValue, squareCopy, sub, sub, subCopy, withComponents

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface mikera.arrayz.INDArray

absCopy, absDiff, absDiffCopy, addApplyOp, addAt, addInnerProduct, addMultipleSparse, addPower, addPower, addSparse, broadcastLike, componentCount, divideCopy, elementAbsPowSum, elementMaxAbs, elementPowSum, elementProduct, epsilonEquals, equalsArray, get, get, get, get, getComponent, getComponents, getElements, getElements, getElements, isDense, isSparse, join, multiplyCopy, negateCopy, reciprocalCopy, scale, scaleCopy, setElements, setInnerProduct, setSparse, signumCopy, sliceValue, squareCopy, sub, subCopy, withComponents

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

Matrix11

public Matrix11()

Matrix11

public Matrix11(double value)

Matrix11

public Matrix11(AMatrix m)

Method Detail

rowCount

public int rowCount()

Description copied from interface: IMatrix

Gets the number of rows in this matrix (dimension 0)

Returns:

columnCount

public int columnCount()

Description copied from interface: IMatrix

Gets the number of columns in this matrix (dimension 1)

Returns:

checkSquare

public int checkSquare()

Description copied from class: AMatrix

Checks if a matrix is square. Returns the size if true, throws an exception otherwise;

Specified by:

checkSquare in class APrimitiveMatrix

Returns:

determinant

public double determinant()

Description copied from class: AMatrix

Calculates the determinant of the matrix.

Overrides:

determinant 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

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>

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

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

elementCount

public long elementCount()

Description copied from interface: INDArray

Returns the total number of elements in this array. Equivalent to the product of all dimension sizes.

Specified by:

elementCount in interface INDArray

Overrides:

elementCount in class AMatrix

isDiagonal

public boolean isDiagonal()

Description copied from interface: IMatrix

Returns true iff this matrix is a square diagonal matrix

Specified by:

isDiagonal in interface IMatrix

Overrides:

isDiagonal 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 AMatrix

isIdentity

public boolean isIdentity()

Description copied from interface: IMatrix

Checks if this is an identity matrix (i.e. 1.0 in leading diagonal, 0.0 elsewhere)

Specified by:

isIdentity in interface IMatrix

Overrides:

isIdentity in class AMatrix

Returns:

true if this matrix is a square identity matrix, false otherwise.

inverse

public Matrix11 inverse()

Description copied from class: AMatrix

Computes the inverse of a matrix. Returns null if the matrix is singular. Throws an Exception is the matrix is not square

Specified by:

inverse in interface IMatrix

Overrides:

inverse in class AMatrix

Returns:

A matrix which is the inverse of this matrix, or null if the inverse does not exist.

trace

public double trace()

Description copied from interface: IMatrix

Computes the trace of a matrix, i.e. the sum of all elements on the leading diagonal

Specified by:

trace in interface IMatrix

Overrides:

trace in class AMatrix

Returns:

get

public double get(int row,
                  int column)

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

Specified by:

get in class AMatrix

set

public void set(int row,
                int column,
                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

Specified by:

set in class AMatrix

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 AMatrix

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 AMatrix

addAt

public void addAt(int i,
                  int j,
                  double value)

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

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

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

getRowClone

public Vector1 getRowClone(int row)

Description copied from interface: IMatrix

Returns a row of the matrix as a new cloned, mutable vector. The cloned row may be modified without affecting the original matrix.

Specified by:

getRowClone in interface IMatrix

Overrides:

getRowClone in class AMatrix

getColumnClone

public Vector1 getColumnClone(int column)

Description copied from interface: IMatrix

Returns a column of the matrix as a new cloned, mutable vector The cloned column may be modified without affecting the original matrix.

Specified by:

getColumnClone in interface IMatrix

Overrides:

getColumnClone in class AMatrix

getElements

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

Description copied from interface: INDArray

Copies all elements of this array a double array at the specified offset

Specified by:

getElements in interface INDArray

Overrides:

getElements in class AMatrix

copyRowTo

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

Description copied from class: AMatrix

Copies the elements in a selected row of this matrix to a double array

Overrides:

copyRowTo in class AMatrix

Parameters:

row - The index of the selected row

dest - Destination double[] array

destOffset - Offset into destination array

copyColumnTo

public 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

Overrides:

copyColumnTo in class AMatrix

dest - Destination double[] array

exactClone

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

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:

toDoubleArray

public 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