mikera.matrixx.impl

Class AVectorMatrix<T extends AVector>

java.lang.Object

mikera.transformz.ATransform

mikera.transformz.AAffineTransform

mikera.transformz.ALinearTransform

mikera.matrixx.AMatrix

mikera.matrixx.impl.AVectorMatrix<T>

All Implemented Interfaces:

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

Direct Known Subclasses:

BroadcastVectorMatrix, VectorMatrixM3, VectorMatrixMN

public abstract class AVectorMatrix<T extends AVector>
extends AMatrix

Abstract base class for matrices that use a collection of Vectors as storage for the matrix rows. Vector matrices may support appending with new rows - this functionality can be useful e.g. when building a matrix to represent a data set.

Author:

Mike

Constructor Summary

Constructors

Constructor and Description
AVectorMatrix()

Method Summary

Methods

Modifier and Type	Method and Description
abstract void	appendRow(AVector row)
void	applyOp(Op op) Applies a unary operator to all elements of the array (in-place)
double	calculateElement(int i, AVector inputVector) Calculates a single element of the output.
AMatrix	clone() Clones the transform, performing a deep copy where needed
void	copyRowTo(int row, double[] dest, int destOffset)
double	elementSquaredSum() Returns the squared sum of all elements in the matrix
double	elementSum() Returns the sum of all elements in the matrix
double	get(int row, int column) Returns a specified element in the matrix
void	getElements(double[] dest, int destOffset) Gets all elements of the array, copying them into a double array
abstract T	getRow(int row) Gets a row of the matrix.
boolean	isFullyMutable() If this method returns true, the INDArray is guaranteed to be fully mutable in all positions i.e.
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.
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	transform(AVector source, AVector dest) Transforms the source vector, storing the result in the given destination 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.

Methods inherited from class mikera.matrixx.AMatrix

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

Constructor Detail

AVectorMatrix

public AVectorMatrix()

Method Detail

appendRow

public abstract void appendRow(AVector row)

getRow

public abstract T getRow(int row)

Gets a row of the matrix. Should be guaranteed to be an existing vector by all descendents of VectorMatrix.

Overrides:

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

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:

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:

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

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

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

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

calculateElement

public double calculateElement(int i,
                      AVector inputVector)

Description copied from class: ATransform

Calculates a single element of the output. Not necessarily faster than calculating full output, but can be in some circumstances.

Overrides:

calculateElement in class AMatrix

copyRowTo

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

Overrides:

copyRowTo in class AMatrix

getElements

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

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

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

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:

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:

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:

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