mikera.matrixx.impl

Class ImmutableMatrix

java.lang.Object

mikera.transformz.ATransform

mikera.transformz.AAffineTransform

mikera.transformz.ALinearTransform

mikera.matrixx.AMatrix

mikera.matrixx.impl.ImmutableMatrix

All Implemented Interfaces:

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

public final class ImmutableMatrix
extends AMatrix

Constructor Summary

Constructors

Constructor and Description
ImmutableMatrix(AMatrix m)

Method Summary

Methods

Modifier and Type	Method and Description
Matrix	clone() Clones the transform, performing a deep copy where needed
int	columnCount() Returns the number of columns in the matrix
void	copyColumnTo(int col, double[] dest, int destOffset)
void	copyRowTo(int row, double[] dest, int destOffset)
static INDArray	create(AMatrix a)
double	elementSquaredSum() Returns the squared sum of all elements in the matrix
double	elementSum() Returns the sum of all elements in the matrix
AMatrix	exactClone() Returns an exact deep clone of an array (i.e.
double	get(int row, int column) Returns a specified element in the matrix
void	getElements(double[] dest, int offset) Gets all elements of the array, copying them into a double array
double[]	getInternalData() Unsafe method that returns the internal data array
Vector	innerProduct(AVector a)
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	isMutable() Returns true if the INDArray is mutable (at least partially)
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)
long	nonZeroCount() Returns the number of non-zero elements in the array.
int	rowCount() Returns the number of rows in the matrix
void	set(int row, int column, double value) Sets a specified element in the matrix
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(Vector source, Vector dest)
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.
static ImmutableMatrix	wrap(int rows, int cols, double[] data)
static ImmutableMatrix	wrap(Matrix source)

Methods inherited from class mikera.matrixx.AMatrix

abs, add, add, add, add, add, addAt, addMultiple, addRowMultiple, applyOp, applyOp, asDoubleArray, asElementList, asVector, bandIndex, bandLength, bandLength, bandPosition, broadcast, broadcastCloneLike, broadcastLike, broadcastLike, calculateElement, calculateElement, clamp, cloneRow, compose, compose, composeWith, composeWith, copyOfMatrix, copyOfTranslationVector, copyTo, determinant, dimensionality, divide, divide, elementCount, elementDiv, elementIterator, elementMul, ensureMutable, epsilonEquals, epsilonEquals, epsilonEquals, equals, equals, equals, equals, exp, fill, get, get, get, getBand, getBandWrapped, getColumn, getLeadingDiagonal, getLongShape, getMatrixComponent, getRow, getShape, getShape, getShapeClone, getSlices, getSlices, getSliceViews, getTranspose, getTransposeCopy, getTransposeView, hashCode, hasOrthonormalColumns, hassOrthonormalRows, immutable, innerProduct, innerProduct, innerProduct, innerProduct, innerProduct, inputDimensions, inverse, isDiagonal, isElementConstrained, isHermitian, isIdentity, isInvertible, isLowerTriangular, isOrthogonal, isPositiveDefinite, isRectangularDiagonal, isSameShape, isSameShape, isSquare, isSymmetric, isUpperTriangular, iterator, join, log, lowerBandwidth, lowerBandwidthLimit, mul, multiply, multiply, multiplyRow, mutable, negate, outerProduct, outputDimensions, pow, reciprocal, reshape, reshape, rotateView, scale, scaleAdd, set, set, set, set, set, set, setColumn, setElements, setElements, setRow, signum, slice, slice, sliceCount, sqrt, square, sub, sub, sub, sub, sub, subArray, subMatrix, swapColumns, swapRows, toAffineTransform, toArray, toDoubleArray, toMutableMatrix, toString, trace, transform, transform, transformInPlace, transformInPlace, transposeInnerProduct, transposeInnerProduct, transposeInPlace, unsafeSet, 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

Constructor Detail

ImmutableMatrix

public ImmutableMatrix(AMatrix m)

Method Detail

wrap

public static ImmutableMatrix wrap(Matrix source)

wrap

public static ImmutableMatrix wrap(int rows,
                   int cols,
                   double[] data)

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

isMutable

public boolean isMutable()

Description copied from interface: INDArray

Returns true if the INDArray is mutable (at least partially)

Specified by:

isMutable in interface INDArray

Overrides:

isMutable in class AMatrix

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

Overrides:

isFullyMutable in class AMatrix

Returns:

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:

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:

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 AMatrix

Returns:

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:

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

copyRowTo

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

Overrides:

copyRowTo in class AMatrix

innerProduct

public Vector innerProduct(AVector a)

Overrides:

innerProduct in class AMatrix

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 void transform(Vector source,
             Vector dest)

Overrides:

transform in class AMatrix

copyColumnTo

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

Overrides:

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

elementSquaredSum

public double elementSquaredSum()

Description copied from class: AMatrix

Returns the squared sum of all elements in the matrix

Specified by:

elementSquaredSum in interface INDArray

Overrides:

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

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

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:

exactClone

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

getInternalData

public double[] getInternalData()

Unsafe method that returns the internal data array

Returns:

create

public static INDArray create(AMatrix a)