mikera.matrixx.impl

Class SubsetMatrix

java.lang.Object

mikera.transformz.ATransform

mikera.transformz.AAffineTransform

mikera.transformz.ALinearTransform

mikera.matrixx.AMatrix

mikera.matrixx.impl.ABooleanMatrix

mikera.matrixx.impl.SubsetMatrix

All Implemented Interfaces:

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

public final class SubsetMatrix
extends ABooleanMatrix
implements ISparse

Matrix that transforms to a selection of specific elements of the source vector i.e. has exactly one 1.0 in each row

Author:

Mike

Method Summary

Methods

Modifier and Type	Method and Description
double	calculateElement(int i, AVector inputVector) Calculates a single element of the output.
double	calculateElement(int i, Vector inputVector)
int	columnCount() Returns the number of columns in the matrix
static SubsetMatrix	create(Index components, int inputDimensions)
double	density() Computes the density ratio of this sparse array (proportion of non-zero elements)
double	elementSum() Returns the sum of all elements in the matrix
SubsetMatrix	exactClone() Returns an exact deep clone of an array (i.e.
double	get(int row, int column) Returns a specified element in the matrix
AxisVector	getRow(int i) Returns a row of the matrix as a vector view
int	inputDimensions() Returns the number of dimensions required for input vectors
long	nonZeroCount() Returns the number of non-zero elements in the array.
int	outputDimensions() Returns the number of dimensions required for output vectors
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	transform(AVector source, AVector dest) Transforms the source vector, storing the result in the given destination vector
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	validate() Validates the internal data structure of the INDArray.

Methods inherited from class mikera.matrixx.impl.ABooleanMatrix

isBoolean, isFullyMutable

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, clamp, clone, cloneRow, compose, compose, composeWith, composeWith, copyColumnTo, copyOfMatrix, copyOfTranslationVector, copyRowTo, copyTo, determinant, dimensionality, divide, divide, elementCount, elementDiv, elementIterator, elementMul, elementSquaredSum, ensureMutable, epsilonEquals, epsilonEquals, epsilonEquals, equals, equals, equals, equals, exp, fill, get, get, get, getBand, getBandWrapped, getColumn, getElements, getLeadingDiagonal, getLongShape, getMatrixComponent, getShape, getShape, getSlices, getSliceViews, getTranspose, getTransposeCopy, getTransposeView, hashCode, hasOrthonormalColumns, hassOrthonormalRows, innerProduct, innerProduct, innerProduct, innerProduct, innerProduct, innerProduct, inverse, isDiagonal, isElementConstrained, isHermitian, isIdentity, isInvertible, isLowerTriangular, isMutable, isOrthogonal, isPositiveDefinite, isRectangularDiagonal, isSameShape, isSameShape, isSquare, isSymmetric, isUpperTriangular, isView, isZero, iterator, log, lowerBandwidth, lowerBandwidthLimit, mul, multiply, multiply, multiplyRow, negate, outerProduct, pow, reciprocal, reshape, reshape, scale, scaleAdd, set, 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, transform, transformInPlace, transformInPlace, transposeInnerProduct, transposeInnerProduct, transposeInPlace, unsafeSet, upperBandwidth, upperBandwidthLimit

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

Method Detail

create

public static SubsetMatrix create(Index components,
                  int inputDimensions)

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

inputDimensions

public int inputDimensions()

Description copied from class: ATransform

Returns the number of dimensions required for input vectors

Specified by:

inputDimensions in interface ITransform

Overrides:

inputDimensions in class AMatrix

Returns:

outputDimensions

public int outputDimensions()

Description copied from class: ATransform

Returns the number of dimensions required for output vectors

Specified by:

outputDimensions in interface ITransform

Overrides:

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

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:

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

density

public double density()

Description copied from interface: ISparse

Computes the density ratio of this sparse array (proportion of non-zero elements)

Specified by:

density in interface ISparse

Returns:

getRow

public AxisVector getRow(int i)

Description copied from class: AMatrix

Returns a row of the matrix as a vector view

Overrides:

getRow 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

calculateElement

public double calculateElement(int i,
                      Vector inputVector)

Overrides:

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

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

exactClone

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

validate

public void validate()

Description copied from interface: INDArray

Validates the internal data structure of the INDArray. Throws an exception on failure. Failure indicates a serious bug and/or data corruption.

Specified by:

validate in interface INDArray

Overrides:

validate in class AMatrix