mikera.matrixx.impl

Class PermutedMatrix

java.lang.Object

mikera.arrayz.impl.AbstractArray<AVector>

mikera.matrixx.AMatrix

mikera.matrixx.impl.ARectangularMatrix

mikera.matrixx.impl.PermutedMatrix

All Implemented Interfaces:

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

public class PermutedMatrix
extends ARectangularMatrix

Matrix class representing a permuted view of a matrix

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
PermutedMatrix(AMatrix source, Index rowPermutations)
PermutedMatrix(AMatrix source, Index rowPermutations, Index columnPermutations)

Method Summary

Modifier and Type	Method and Description
void	abs() Replaces all elements of this array with their absolute values, according to Math.abs(double)
void	addSparse(double value) Adds to the non-sparse elements of this array
void	applyOp(IOperator op) Applies a unary operator to all elements of the array (in-place)
void	applyOp(Op op) Applies a unary operator to all elements of the array (in-place)
void	applyOp(Op2 op, double b) Applies a binary operator to this array and a double value.
int	componentCount() Returns the number of components of this array.
double	elementMax() Returns the maximum element value in this array.
double	elementMin() Returns the maximum element value in this array.
double	elementSum() Returns the sum of all elements in this matrix
PermutedMatrix	exactClone() Creates a deep clone of an array, using the same class implementation as the original array
void	exp() Computes the function e^x (in-place) for all array elements
void	fill(double value) Fills this array with a single double value.
double	get(int row, int column) Returns the double value at the specified position in a 2D matrix
AVector	getColumnView(int column) Returns a column of the permuted matrix as a vector reference
INDArray	getComponent(int k) Gets a component from the array at the specified index Will throw an error if components are not supported, or if the component is out of bounds as defined by 0 <= k
INDArray[]	getComponents() Gets all components in a new array, with length componentCount();
AVector	getRowView(int row) Returns a row of the permuted matrix as a vector reference
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 considered as a view type.
boolean	isZero() Returns true if the matrix is the zero matrix (all components zero)
void	log() Computes the natural logarithm (in-place) for all array elements
void	multiply(double factor) Multiplies all elements of the array in place by a given double value
void	negate() Negates all elements in the array in place
long	nonZeroCount() Returns the number of non-zero elements in the array.
void	reciprocal() Replaces all elements in the array with their reciprocal
void	set(int row, int column, double value) Sets a value at a given position in a mutable 2D array
void	setSparse(double value) Sets the non-sparse elements of this array to the specified value May throw an exception if non-sparse elements are not mutable
void	signum() Calculates the signum of all elements of this mutable array Sets each component of the array to its sign value (-1, 0 or 1)
void	sqrt() Computes the square root of all elements in the array
void	square() Squares all elements of the array in place
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.ARectangularMatrix

bandLength, checkColumn, checkRow, checkSquare, columnCount, elementCount, getElement, getShape, getShape, getShapeClone, isSameShape, isSameShape, isSameShape, isSquare, rowCount

Methods inherited from class mikera.matrixx.AMatrix

add, add, add, add, add2, addAt, addCopy, addCopy, addCopy, addCopy, addCopy, addInnerProduct, addInnerProduct, addInnerProduct, addMultiple, addMultiple, addMultiple, addOuterProduct, addOuterProduct, addOuterProductSparse, addOuterProductSparse, addRowMultiple, addSparse, addSparse, addToArray, applyOp, applyOp, applyOp, applyOpCopy, asDoubleArray, asElementList, asVector, bandIndex, bandPosition, bandStartColumn, bandStartRow, broadcast, broadcastCloneLike, broadcastCopyLike, broadcastLike, broadcastLike, clamp, clone, composeWith, copy, copyColumnTo, copyRowTo, dense, denseClone, determinant, diagonalProduct, dimensionality, divide, divide, divide, divide, divideCopy, elementIterator, elementsEqual, elementSquaredSum, ensureMutable, epsilonEquals, epsilonEquals, epsilonEquals, equals, equals, equals, equalsArray, equalsTranspose, get, get, get, get, getBand, getBandWrapped, getColumn, getColumnClone, getColumns, getElements, getLeadingDiagonal, getLongShape, getRow, getRowClone, getRows, getSlices, getSlices, getSliceViews, getTranspose, getTransposeCopy, getTransposeView, hashCode, hasOrthonormalColumns, hasOrthonormalRows, hasUncountable, immutable, innerProduct, innerProduct, innerProduct, innerProduct, innerProduct, innerProduct, inputDimensions, inverse, isDiagonal, isElementConstrained, isHermitian, isIdentity, isInvertible, isLowerTriangular, isOrthogonal, isOrthogonal, isPositiveDefinite, isRectangularDiagonal, isSymmetric, isUpperTriangular, iterator, join, lowerBandwidth, lowerBandwidthLimit, mul, multiply, multiply, multiply, multiplyCopy, multiplyRow, mutable, outerProduct, outputDimensions, pow, rank, 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, slice, slice, sliceCount, sparse, sparseClone, sub, sub, sub, subArray, subCopy, subMatrix, swapColumns, swapRows, toAffineTransform, toDoubleArray, toDoubleBuffer, toMatrix, toMatrixTranspose, toMutableMatrix, toNestedDoubleArrays, toSliceArray, toString, toStringFull, toVector, trace, 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, broadcastLike, compareTo, density, divideCopy, elementAbsPowSum, elementMaxAbs, elementPowSum, elementProduct, epsilonEquals, equals, equalsArray, get, get, get, get, getElements, getElements, getElements, isDense, isSparse, join, multiplyCopy, negateCopy, reciprocalCopy, scale, scaleCopy, setElements, setInnerProduct, 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, broadcastLike, divideCopy, elementAbsPowSum, elementMaxAbs, elementPowSum, elementProduct, epsilonEquals, equalsArray, get, get, get, get, getElements, getElements, getElements, isDense, isSparse, join, multiplyCopy, negateCopy, reciprocalCopy, scale, scaleCopy, setElements, setInnerProduct, 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

PermutedMatrix

public PermutedMatrix(AMatrix source,
                      Index rowPermutations)

PermutedMatrix

public PermutedMatrix(AMatrix source,
                      Index rowPermutations,
                      Index columnPermutations)

Method Detail

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

Specified by:

isFullyMutable 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

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

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

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

Overrides:

set in class ARectangularMatrix

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.

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.

getRowView

public AVector getRowView(int row)

Returns a row of the permuted matrix as a vector reference

Specified by:

getRowView in interface IMatrix

Overrides:

getRowView in class AMatrix

getColumnView

public AVector getColumnView(int column)

Returns a column of the permuted matrix as a vector reference

Specified by:

getColumnView in interface IMatrix

Overrides:

getColumnView in class AMatrix

exactClone

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

isView

public boolean isView()

Description copied from interface: INDArray

Return true if this array is considered as a view type. This indicates (but does not guarantee): a) Data is *likely* to be shared with other arrays, so mutation of one may affect others b) It is *unlikely* to be in the most efficient general purpose format isView is intended to be used as for heuristics. It should *not* be used where the outcome might affect correctness.

Specified by:

isView in interface INDArray

Overrides:

isView in class AMatrix

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

componentCount

public int componentCount()

Description copied from interface: INDArray

Returns the number of components of this array. May return 0 if components are not supported

Specified by:

componentCount in interface INDArray

Overrides:

componentCount in class AbstractArray<AVector>

Returns:

getComponent

public INDArray getComponent(int k)

Description copied from interface: INDArray

Gets a component from the array at the specified index Will throw an error if components are not supported, or if the component is out of bounds as defined by 0 <= k

Specified by:

getComponent in interface INDArray

Overrides:

getComponent in class AbstractArray<AVector>

Returns:

getComponents

public INDArray[] getComponents()

Description copied from interface: INDArray

Gets all components in a new array, with length componentCount();

Specified by:

getComponents in interface INDArray

Overrides:

getComponents in class AbstractArray<AVector>

Returns:

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

applyOp

public void applyOp(IOperator 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

Parameters:

op - The operator to apply to the array

applyOp

public void applyOp(Op2 op,
                    double b)

Description copied from interface: INDArray

Applies a binary operator to this array and a double value. Works as if the double value was broadcast to the shape of this array.

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

fill

public void fill(double value)

Description copied from interface: INDArray

Fills this array with a single double value. Requires the array to be mutable.

Specified by:

fill in interface INDArray

Overrides:

fill in class AMatrix

setSparse

public void setSparse(double value)

Description copied from interface: INDArray

Sets the non-sparse elements of this array to the specified value May throw an exception if non-sparse elements are not mutable

Specified by:

setSparse in interface INDArray

Overrides:

setSparse in class AbstractArray<AVector>

addSparse

public void addSparse(double value)

Description copied from interface: INDArray

Adds to the non-sparse elements of this array

Specified by:

addSparse in interface INDArray

Overrides:

addSparse in class AbstractArray<AVector>

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

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>

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>

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

abs

public void abs()

Description copied from interface: INDArray

Replaces all elements of this array with their absolute values, according to Math.abs(double)

Specified by:

abs in interface INDArray

Overrides:

abs in class AMatrix

square

public void square()

Description copied from interface: INDArray

Squares all elements of the array in place

Specified by:

square in interface INDArray

Overrides:

square in class AMatrix

sqrt

public void sqrt()

Description copied from interface: INDArray

Computes the square root of all elements in the array

Specified by:

sqrt in interface INDArray

Overrides:

sqrt in class AMatrix

signum

public void signum()

Description copied from interface: INDArray

Calculates the signum of all elements of this mutable array Sets each component of the array to its sign value (-1, 0 or 1)

Specified by:

signum in interface INDArray

Overrides:

signum in class AMatrix

negate

public void negate()

Description copied from interface: INDArray

Negates all elements in the array in place

Specified by:

negate in interface INDArray

Overrides:

negate in class AMatrix

log

public void log()

Description copied from interface: INDArray

Computes the natural logarithm (in-place) for all array elements

Specified by:

log in interface INDArray

Overrides:

log in class AMatrix

exp

public void exp()

Description copied from interface: INDArray

Computes the function e^x (in-place) for all array elements

Specified by:

exp in interface INDArray

Overrides:

exp in class AMatrix

reciprocal

public void reciprocal()

Description copied from interface: INDArray

Replaces all elements in the array with their reciprocal

Specified by:

reciprocal in interface INDArray

Overrides:

reciprocal in class AMatrix