mikera.matrixx.impl

Class PermutationMatrix

java.lang.Object

mikera.transformz.ATransform

mikera.transformz.AAffineTransform

mikera.transformz.ALinearTransform

mikera.matrixx.AMatrix

mikera.matrixx.impl.PermutationMatrix

All Implemented Interfaces:

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

public final class PermutationMatrix
extends AMatrix
implements ISparse

Method Summary

Methods

Modifier and Type	Method and Description
int	columnCount() Returns the number of columns in the matrix
static PermutationMatrix	create(Index rowPermutations)
static PermutationMatrix	create(int... rowPermutations)
static PermutationMatrix	createIdentity(int length)
static PermutationMatrix	createRandomPermutation(int length)
static PermutationMatrix	createSwap(int i, int j, int length)
double	density() Computes the density ratio of this sparse array (proportion of non-zero elements)
double	determinant() Calculates the determinant of the matrix.
double	elementSquaredSum() Returns the squared sum of all elements in the matrix
double	elementSum() Returns the sum of all elements in the matrix
PermutationMatrix	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	getColumn(int j) Returns a column of the matrix as a vector view
AxisVector	getRow(int i) Returns a row of the matrix as a vector view
PermutationMatrix	getTranspose() Returns a transposed version of this matrix.
boolean	hasOrthonormalColumns()
boolean	hassOrthonormalRows()
Matrix	innerProduct(AMatrix a)
Matrix	innerProduct(Matrix a)
PermutationMatrix	inverse() Return the inverse of this transformation if possible
boolean	isDiagonal() Returns true iff a matrix is a square diagonal matrix
boolean	isFullyMutable() Returns true if the INDArray is fully mutable in all positions i.e.
boolean	isIdentity() Returns true if this transform is known to be the identity function, i.e.
boolean	isLowerTriangular() Returns true if a matrix is lower triangular
boolean	isMutable() Returns true if the INDArray is mutable (at least partially)
boolean	isOrthogonal()
boolean	isSquare() Returns true if the transform is square (same number of input and output dimensions)
boolean	isSymmetric() Returns true if a matrix is symmetric
boolean	isUpperTriangular() Returns true if a matrix is upper triangular
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	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	trace()
void	transform(AVector source, AVector dest) Transforms the source vector, storing the result in the given destination vector
void	validate() Validates the internal data structure of the INDArray.
static PermutationMatrix	wrap(Index rowPermutations)

Methods inherited from class mikera.matrixx.AMatrix

abs, add, add, add, add, addAt, addMultiple, addRowMultiple, applyOp, applyOp, asElementList, asVector, broadcast, calculateElement, clamp, clone, cloneRow, compose, compose, composeWith, composeWith, copyOfMatrix, copyOfTranslationVector, copyTo, dimensionality, elementCount, elementIterator, elementMul, epsilonEquals, epsilonEquals, epsilonEquals, equals, equals, equals, equals, exp, fill, get, get, get, getElements, getLeadingDiagonal, getLongShape, getMatrixComponent, getShape, getShape, getSlices, getSliceViews, getTransposeView, hashCode, innerProduct, innerProduct, innerProduct, inputDimensions, isElementConstrained, isHermitian, isInvertible, isPositiveDefinite, isRectangularDiagonal, isView, isZeroMatrix, iterator, log, mul, multiply, multiply, multiplyRow, negate, outerProduct, outputDimensions, pow, reciprocal, reshape, scale, scaleAdd, set, set, set, set, set, set, setColumn, setElements, setElements, setRow, signum, slice, slice, sliceCount, sqrt, square, sub, sub, sub, sub, toAffineTransform, toDoubleBuffer, toMatrix, toMutableMatrix, toString, toVector, transformInPlace, transformInPlace, transposeInPlace

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

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

createIdentity

public static PermutationMatrix createIdentity(int length)

createSwap

public static PermutationMatrix createSwap(int i,
                           int j,
                           int length)

create

public static PermutationMatrix create(Index rowPermutations)

wrap

public static PermutationMatrix wrap(Index rowPermutations)

create

public static PermutationMatrix create(int... rowPermutations)

createRandomPermutation

public static PermutationMatrix createRandomPermutation(int length)

isFullyMutable

public boolean isFullyMutable()

Description copied from interface: INDArray

Returns true if the INDArray is 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:

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:

isSymmetric

public boolean isSymmetric()

Description copied from class: AMatrix

Returns true if a matrix is symmetric

Overrides:

isSymmetric in class AMatrix

determinant

public double determinant()

Description copied from class: AMatrix

Calculates the determinant of the matrix.

Overrides:

determinant in class AMatrix

isIdentity

public boolean isIdentity()

Description copied from class: ATransform

Returns true if this transform is known to be the identity function, i.e. it maps all vectors to themselves

Overrides:

isIdentity in class AMatrix

isOrthogonal

public boolean isOrthogonal()

Overrides:

isOrthogonal in class AMatrix

hasOrthonormalColumns

public boolean hasOrthonormalColumns()

Overrides:

hasOrthonormalColumns in class AMatrix

hassOrthonormalRows

public boolean hassOrthonormalRows()

Overrides:

hassOrthonormalRows in class AMatrix

isDiagonal

public boolean isDiagonal()

Description copied from class: AMatrix

Returns true iff a matrix is a square diagonal matrix

Overrides:

isDiagonal in class AMatrix

isUpperTriangular

public boolean isUpperTriangular()

Description copied from class: AMatrix

Returns true if a matrix is upper triangular

Overrides:

isUpperTriangular in class AMatrix

isLowerTriangular

public boolean isLowerTriangular()

Description copied from class: AMatrix

Returns true if a matrix is lower triangular

Overrides:

isLowerTriangular in class AMatrix

isSquare

public boolean isSquare()

Description copied from class: ATransform

Returns true if the transform is square (same number of input and output dimensions)

Overrides:

isSquare 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

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:

trace

public double trace()

Overrides:

trace in class AMatrix

inverse

public PermutationMatrix inverse()

Description copied from class: ATransform

Return the inverse of this transformation if possible

Overrides:

inverse in class AMatrix

Returns:

getTranspose

public PermutationMatrix getTranspose()

Description copied from class: AMatrix

Returns a transposed version of this matrix. May or may not be a view.

Specified by:

getTranspose in interface INDArray

Overrides:

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

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

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

getColumn

public AxisVector getColumn(int j)

Description copied from class: AMatrix

Returns a column of the matrix as a vector view

Overrides:

getColumn in class AMatrix

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

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

innerProduct

public Matrix innerProduct(AMatrix a)

Overrides:

innerProduct in class AMatrix

innerProduct

public Matrix innerProduct(Matrix a)

Overrides:

innerProduct in class AMatrix

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

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:

exactClone

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