TransposedMatrix (Vectorz 0.28.0 API)

java.lang.Object
- mikera.arrayz.impl.AbstractArray<AVector>
- - mikera.matrixx.AMatrix
  - - mikera.matrixx.impl.TransposedMatrix

All Implemented Interfaces:

Serializable, Cloneable, Iterable<AVector>, INDArray, IMatrix
```
public class TransposedMatrix
extends AMatrix
```
Class representing a transposed view of another matrix The transposed matrix is a reference to the underlying matrix data

Author:

Mike

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

protected AMatrix source

Fields
Modifier and Type	Field and Description
`protected AMatrix`	`source`

Method Summary

Methods
Modifier and Type	Method and Description
`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)
`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)`
`double`	`determinant()` Calculates the determinant of the matrix.
`long`	`elementCount()` Returns the total number of elements in 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 the matrix
`TransposedMatrix`	`exactClone()` Returns an exact deep clone of an array (i.e.
`double`	`get(int row, int column)` Returns a specified element in the matrix
`AVector`	`getColumn(int column)` Returns a column of the matrix as a vector view
`void`	`getElements(double[] dest, int destOffset)` Gets all elements of the array, copying them into a double array
`AVector`	`getLeadingDiagonal()` Returns a vector view of the leading diagonal values of the matrix
`AVector`	`getRow(int row)` Returns a row of the matrix as a vector view
`AMatrix`	`getTranspose()` Returns a transposed version of this matrix.
`Matrix`	`getTransposeCopy()` Returns a transposed copy of the array.
`AMatrix`	`getTransposeView()` Returns a transposed view of the array.
`AMatrix`	`innerProduct(AMatrix s)`
`Matrix`	`innerProduct(Matrix s)`
`boolean`	`isFullyMutable()` If this method returns true, the INDArray is guaranteed to be fully mutable in all positions 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`	`isSymmetric()` Returns true if a matrix is symmetric
`boolean`	`isUpperTriangular()` Returns true if a matrix is upper triangular
`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)
`void`	`multiply(double factor)` Multiplies all elements of the array by a given double value
`long`	`nonZeroCount()` Returns the number of non-zero elements in the array.
`int`	`rowCount()` Returns the number of rows in the matrix
`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
`int`	`sliceCount()` returns the number of major slices in this array.
`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.
`AMatrix`	`transposeInnerProduct(AMatrix s)`
`Matrix`	`transposeInnerProduct(Matrix s)`
`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.
`static AMatrix`	`wrap(AMatrix m)`

Methods inherited from class mikera.matrixx.AMatrix
abs, add, add, add, add, add, addAt, addMultiple, addRowMultiple, asDoubleArray, asElementList, asVector, bandIndex, bandLength, bandLength, bandPosition, broadcast, broadcastCloneLike, broadcastLike, broadcastLike, calculateElement, calculateElement, clamp, clone, cloneColumn, cloneRow, compose, composeWith, copyTo, dimensionality, divide, divide, elementDiv, elementIterator, elementMul, elementSquaredSum, ensureMutable, epsilonEquals, epsilonEquals, epsilonEquals, equals, equals, equals, equals, equalsTranspose, exp, fill, get, get, get, getBand, getBandWrapped, getLongShape, getShape, getShape, getShapeClone, getSlices, getSlices, getSliceViews, hashCode, hasOrthonormalColumns, hasOrthonormalRows, immutable, innerProduct, innerProduct, innerProduct, innerProduct, inputDimensions, inverse, isBoolean, isDiagonal, isElementConstrained, isHermitian, isIdentity, isInvertible, isOrthogonal, isPositiveDefinite, isRectangularDiagonal, isSameShape, isSameShape, isSquare, iterator, join, log, lowerBandwidth, lowerBandwidthLimit, mul, multiply, multiplyRow, mutable, negate, outerProduct, outputDimensions, pow, reciprocal, replaceColumn, replaceRow, reshape, reshape, rotateView, scaleAdd, set, set, set, set, set, setColumn, setElements, setElements, setRow, signum, slice, slice, sqrt, square, sub, sub, sub, sub, sub, subArray, subMatrix, swapColumns, swapRows, toAffineTransform, toArray, toDoubleArray, toDoubleBuffer, toMutableMatrix, toString, toVector, trace, transform, transform, transform, transform, transformInPlace, transformInPlace, transposeInPlace, upperBandwidth, upperBandwidthLimit, validate

Methods inherited from class mikera.arrayz.impl.AbstractArray
density, scale, sparse

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface mikera.arrayz.INDArray
scale, sparse

- Field Detail
  - source
```
protected final AMatrix source
```
- Method Detail
  - wrap
```
public static AMatrix wrap(AMatrix m)
```
  - rowCount
```
public int rowCount()
```
    Description copied from class: AMatrix
    
    Returns the number of rows in the matrix
    
    Specified by:
    
    rowCount in interface IMatrix
  - columnCount
```
public int columnCount()
```
    Description copied from class: AMatrix
    
    Returns the number of columns in the matrix
    
    Specified by:
    
    columnCount in interface IMatrix
  - 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
    
    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:
  - 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
    
    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
  - 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.
  - getRow
```
public AVector getRow(int row)
```
    Description copied from class: AMatrix
    
    Returns a row of the matrix as a vector view
    
    Overrides:
    
    getRow in class AMatrix
  - sliceCount
```
public int sliceCount()
```
    Description copied from interface: INDArray
    
    returns the number of major slices in this array.
    
    Specified by:
    
    sliceCount in interface INDArray
    
    Overrides:
    
    sliceCount in class AMatrix
    
    Returns:
  - 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
  - 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
  - getColumn
```
public AVector getColumn(int column)
```
    Description copied from class: AMatrix
    
    Returns a column of the matrix as a vector view
    
    Overrides:
    
    getColumn in class AMatrix
  - copyRowTo
```
public void copyRowTo(int row,
             double[] dest,
             int destOffset)
```
    Overrides:
    
    copyRowTo in class AMatrix
  - copyColumnTo
```
public void copyColumnTo(int col,
                double[] dest,
                int destOffset)
```
    Overrides:
    
    copyColumnTo in class AMatrix
  - getElements
```
public 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
  - determinant
```
public double determinant()
```
    Description copied from class: AMatrix
    
    Calculates the determinant of the matrix.
    
    Overrides:
    
    determinant in class AMatrix
  - isSymmetric
```
public boolean isSymmetric()
```
    Description copied from class: AMatrix
    
    Returns true if a matrix is symmetric
    
    Overrides:
    
    isSymmetric 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:
  - 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
  - getTranspose
```
public AMatrix 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
    
    Returns:
  - getTransposeView
```
public AMatrix getTransposeView()
```
    Description copied from interface: INDArray
    
    Returns a transposed view of the array. May throw UnsupportedOperationException if the array does not support this capability
    
    Specified by:
    
    getTransposeView in interface INDArray
    
    Overrides:
    
    getTransposeView in class AMatrix
    
    Returns:
  - getTransposeCopy
```
public Matrix getTransposeCopy()
```
    Description copied from interface: INDArray
    
    Returns a transposed copy of the array.
    
    Specified by:
    
    getTransposeCopy in interface INDArray
    
    Overrides:
    
    getTransposeCopy in class AMatrix
    
    Returns:
  - transposeInnerProduct
```
public AMatrix transposeInnerProduct(AMatrix s)
```
    Overrides:
    
    transposeInnerProduct in class AMatrix
  - transposeInnerProduct
```
public Matrix transposeInnerProduct(Matrix s)
```
    Overrides:
    
    transposeInnerProduct in class AMatrix
  - innerProduct
```
public AMatrix innerProduct(AMatrix s)
```
    Overrides:
    
    innerProduct in class AMatrix
  - innerProduct
```
public Matrix innerProduct(Matrix s)
```
    Overrides:
    
    innerProduct in class AMatrix
  - exactClone
```
public TransposedMatrix 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:
  - 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:
  - 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
  - multiply
```
public void multiply(double factor)
```
    Description copied from interface: INDArray
    
    Multiplies all elements of the array by a given double value
    
    Specified by:
    
    multiply in interface INDArray
    
    Overrides:
    
    multiply in class AMatrix
  - 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
  - getLeadingDiagonal
```
public AVector getLeadingDiagonal()
```
    Description copied from class: AMatrix
    
    Returns a vector view of the leading diagonal values of the matrix
    
    Overrides:
    
    getLeadingDiagonal in class AMatrix
    
    Returns:
  - elementCount
```
public long elementCount()
```
    Description copied from interface: INDArray
    
    Returns the total number of elements in this array. Equivalent to the product all dimension sizes.
    
    Specified by:
    
    elementCount in interface INDArray
    
    Overrides:
    
    elementCount 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:
  - elementMin
```
public double elementMin()
```
    Description copied from interface: INDArray
    
    Returns the maximum element value in this array.
    
    Specified by:
    
    elementMin in interface INDArray
    
    Overrides:
    
    elementMin in class AbstractArray<AVector>
    
    Returns:
  - elementMax
```
public double elementMax()
```
    Description copied from interface: INDArray
    
    Returns the maximum element value in this array.
    
    Specified by:
    
    elementMax in interface INDArray
    
    Overrides:
    
    elementMax in class AbstractArray<AVector>
    
    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:

Class TransposedMatrix

Field Summary

Method Summary

Methods inherited from class mikera.matrixx.AMatrix

Methods inherited from class mikera.arrayz.impl.AbstractArray

Methods inherited from class java.lang.Object

Methods inherited from interface mikera.arrayz.INDArray

Field Detail

source

Method Detail

wrap

rowCount

columnCount

isFullyMutable

isMutable

get

set

unsafeGet

unsafeSet

getRow

sliceCount

toMatrixTranspose

toMatrix

getColumn

copyRowTo

copyColumnTo

getElements

determinant

isSymmetric

isZero

isUpperTriangular

isLowerTriangular

getTranspose

getTransposeView

getTransposeCopy

transposeInnerProduct

transposeInnerProduct

innerProduct

innerProduct

exactClone

isView

applyOp

applyOp

multiply

set

getLeadingDiagonal

elementCount

elementSum

elementMin

elementMax

nonZeroCount