ADiagonalMatrix (Vectorz 0.62.0 API)

java.lang.Object
- mikera.arrayz.impl.AbstractArray<AVector>
- - mikera.matrixx.AMatrix
  - - mikera.matrixx.impl.ABandedMatrix
    - - mikera.matrixx.impl.ASingleBandMatrix
      - mikera.matrixx.impl.ADiagonalMatrix

All Implemented Interfaces:

Serializable, Cloneable, Iterable<AVector>, INDArray, ISparse, IMatrix, IFastBands

Direct Known Subclasses:

DiagonalMatrix, IdentityMatrix, ScalarMatrix
```
public abstract class ADiagonalMatrix
extends ASingleBandMatrix
```
Abstract base class for square diagonal matrices

Author:

Mike

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

protected int dimensions

Fields
Modifier and Type	Field and Description
`protected int`	`dimensions`

Constructor Summary

Constructors
Modifier Constructor and Description

protected ADiagonalMatrix(int dimensions)

Constructors
Modifier	Constructor and Description
`protected`	`ADiagonalMatrix(int dimensions)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`AMatrix`	`addCopy(AMatrix a)` Adds another matrix to this matrix, returning a new matrix
`void`	`addToArray(double[] dest, int offset)` Adds all the elements of this array to a double array, in row-major order
`protected void`	`checkIndex(int i, int j)` Checks if the given index is valid for this matrix.
`protected void`	`checkSameShape(AMatrix m)` Checks if this matrix has the same shape as another matrix.
`protected void`	`checkSameShape(ARectangularMatrix m)` Checks if this matrix has the same shape as another matrix.
`int`	`checkSquare()` Checks if a matrix is square.
`AMatrix`	`clone()` Returns a clone of the array data, as a new array which will be fully mutable and may be of a different class to the original.
`int`	`columnCount()` Gets the number of columns in this matrix (dimension 1)
`void`	`copyColumnTo(int col, double[] dest, int destOffset)` Copies the elements in a selected row of this matrix to a double array
`void`	`copyRowTo(int row, double[] dest, int destOffset)` Copies the elements in a slected row of this matrix to a double array
`double`	`density()` Computes the density ratio of this sparse array (proportion of non-zero elements)
`double`	`determinant()` Calculates the determinant of the matrix.
`double`	`diagonalProduct()` Computes the product of entries on the main diagonal of a matrix
`int`	`dimensions()` Returns the number of dimensions of this diagonal matrix
`double`	`elementAbsPowSum(double p)` Returns the sum of the absolute values of all the elements raised to a specified power
`double`	`elementMax()` Returns the maximum element value in this array.
`double`	`elementMin()` Returns the maximum element value in this array.
`double`	`elementPowSum(double p)` Returns the sum of all the elements raised to a specified power
`double`	`elementSquaredSum()` Returns the squared sum of all elements in this matrix
`double`	`elementSum()` Returns the sum of all elements in this matrix
`boolean`	`equalsTranspose(AMatrix m)` Tests if this matrix is exactly equal to the transpose of another matrix
`abstract ADiagonalMatrix`	`exactClone()` Creates a deep clone of an array, using the same class implementation as the original array
`AVector`	`getBand(int band)` Gets a specific band of the matrix, as a view vector.
`ASingleElementVector`	`getColumn(int col)` Returns a column of the matrix.
`double`	`getDiagonalValue(int i)`
`abstract AVector`	`getLeadingDiagonal()` Returns a vector view of the leading diagonal values of the matrix
`AVector`	`getNonZeroBand()` Gets the non-zero band from the matrix
`ASingleElementVector`	`getRow(int row)` Returns a row of the matrix.
`ADiagonalMatrix`	`getTranspose()` Returns the transpose of this array.
`ADiagonalMatrix`	`getTransposeView()` Returns a transposed view of the array.
`boolean`	`hasUncountable()` Checks to see if any element in the matrix is NaN of Infinite.
`AMatrix`	`innerProduct(ADiagonalMatrix a)` Computes the inner product of this matrix with another diagonal matrix of the same shape.
`AMatrix`	`innerProduct(AMatrix a)` Computes the inner product of this matrix with another.
`boolean`	`isBoolean()` Returns true if the array is boolean (contains only 0.0 or 1.0 values)
`boolean`	`isDiagonal()` Returns true iff this matrix is a square diagonal matrix
`boolean`	`isFullyMutable()` If this method returns true, the INDArray is guaranteed to be fully mutable in all positions i.e.
`boolean`	`isIdentity()` Checks if this is an identity matrix (i.e.
`boolean`	`isLowerTriangular()` Returns true if a matrix is lower triangular.
`abstract boolean`	`isMutable()` Returns true if the INDArray is mutable (at least partially)
`boolean`	`isRectangularDiagonal()` Returns true iff this matrix is a diagonal matrix (might not be square)
`boolean`	`isSameShape(AMatrix m)` Returns true iff this matrix is exactly the same shape as another matrix
`boolean`	`isSameShape(ARectangularMatrix m)`
`boolean`	`isSquare()` Checks if this is a square matrix
`boolean`	`isSymmetric()` Returns true if a matrix is symmetric
`boolean`	`isUpperTriangular()` Returns true if a matrix is upper triangular An upper triangular matrix is defined as having all elements equal to 0.0 where i > j
`boolean`	`isZero()` Returns true if the matrix is the zero matrix (all components zero)
`int`	`lowerBandwidthLimit()` A limit on the lower bandwidth of the banded matrix.
`int`	`nonZeroBand()` Specifies which band of the matrix is nonzero
`long`	`nonZeroCount()` Returns the number of non-zero elements in the array.
`int`	`rank()` Calculate the rank of a matrix.
`int`	`rowCount()` Gets the number of rows in this matrix (dimension 0)
`double`	`rowDotProduct(int i, AVector v)` Returns the dot product of a specific row with a vector.
`void`	`set(int row, int column, double value)` Sets a value at a given position in a mutable 2D array
`double[]`	`toDoubleArray()` Copies the elements of this array to a new double[] 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.
`double`	`trace()` Computes the trace of a matrix, i.e.
`void`	`transform(Vector source, Vector dest)`
`void`	`transformInPlace(ADenseArrayVector v)`
`void`	`transformInPlace(AVector v)`
`AMatrix`	`transposeInnerProduct(AMatrix s)`
`void`	`transposeInPlace()` Transposes a matrix in place, if possible.
`double`	`unsafeGetDiagonalValue(int i)`
`int`	`upperBandwidthLimit()` A limit on the upper bandwidth of the banded matrix.
`void`	`validate()` Validates the internal data structure of the INDArray.

Methods inherited from class mikera.matrixx.impl.ASingleBandMatrix
isSparse, subMatrix

Methods inherited from class mikera.matrixx.impl.ABandedMatrix
fill, getRowView, lowerBandwidth, multiply, upperBandwidth

Methods inherited from class mikera.matrixx.AMatrix
abs, add, add, add, add, add2, addAt, addCopy, addCopy, addCopy, addCopy, addInnerProduct, addInnerProduct, addInnerProduct, addMultiple, addMultiple, addMultiple, addOuterProduct, addOuterProduct, addRowMultiple, applyOp, applyOp, applyOp, applyOp, applyOp, applyOp, applyOpCopy, asDoubleArray, asElementList, asVector, bandIndex, bandLength, bandLength, bandPosition, bandStartColumn, bandStartRow, broadcast, broadcastCloneLike, broadcastCopyLike, broadcastLike, broadcastLike, checkColumn, checkColumnCount, checkDimension, checkRow, checkRowCount, checkShape, clamp, composeWith, copy, dense, denseClone, dimensionality, divide, divide, divide, divide, elementCount, elementIterator, elementsEqual, ensureMutable, epsilonEquals, epsilonEquals, epsilonEquals, epsilonEquals, equals, equals, equals, equalsArray, equalsByRows, exp, get, get, get, get, getBandWrapped, getColumnClone, getColumns, getColumnView, getElements, getLongShape, getRowClone, getRows, getShape, getShape, getShapeClone, getSlices, getSlices, getSliceViews, getTransposeCopy, hashCode, hasOrthonormalColumns, hasOrthonormalRows, immutable, innerProduct, innerProduct, innerProduct, innerProduct, innerProduct, inputDimensions, inverse, isElementConstrained, isHermitian, isInvertible, isOrthogonal, isOrthogonal, isPositiveDefinite, isSameShape, isView, iterator, join, log, mul, multiply, multiply, multiply, multiplyCopy, multiplyRow, mutable, negate, outerProduct, outputDimensions, pow, reciprocal, reduce, reduce, reduceSlices, reduceSlices, reorder, reorder, replaceColumn, replaceRow, reshape, reshape, rotateView, scaleAdd, scaleAdd, set, set, set, set, set, set, set, set, setColumn, setElements, setElements, setRow, signum, slice, slice, sliceCount, sparse, sparseClone, sqrt, square, sub, sub, sub, subArray, swapColumns, swapRows, toAffineTransform, toArray, toDoubleBuffer, toMutableMatrix, toNestedDoubleArrays, toSliceArray, toString, toStringFull, toVector, transform, transposeInnerProduct, unsafeGet, unsafeSet

Methods inherited from class mikera.arrayz.impl.AbstractArray
absCopy, add, addAt, addInnerProduct, addPower, addPower, broadcastLike, checkMutable, componentCount, divideCopy, elementProduct, equals, equalsArray, get, get, get, get, get, getComponent, getComponents, getElements, getElements, getElements, isDense, join, multiplyCopy, negateCopy, reciprocalCopy, scale, scaleCopy, setElements, setInnerProduct, setMultiple, setMultiple, signumCopy, sliceValue, squareCopy, sub, sub, subCopy, withComponents

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

Methods inherited from interface mikera.arrayz.INDArray
absCopy, addAt, addPower, addPower, broadcastLike, checkMutable, componentCount, divideCopy, elementProduct, equalsArray, get, get, get, get, get, getComponent, getComponents, getElements, getElements, getElements, isDense, join, multiplyCopy, negateCopy, reciprocalCopy, scale, scaleCopy, setElements, setInnerProduct, setMultiple, setMultiple, signumCopy, sliceValue, squareCopy, sub, subCopy, withComponents

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Field Detail
  - dimensions
```
protected final int dimensions
```
- Constructor Detail
  - ADiagonalMatrix
```
protected ADiagonalMatrix(int dimensions)
```
- Method Detail
  - nonZeroBand
```
public int nonZeroBand()
```
    Description copied from class: ASingleBandMatrix
    
    Specifies which band of the matrix is nonzero
    
    Specified by:
    
    nonZeroBand in class ASingleBandMatrix
    
    Returns:
  - isSquare
```
public boolean isSquare()
```
    Description copied from interface: IMatrix
    
    Checks if this is a square matrix
    
    Specified by:
    
    isSquare in interface IMatrix
    
    Overrides:
    
    isSquare in class AMatrix
    
    Returns:
    
    true if square, false otherwise
  - 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 ASingleBandMatrix
  - 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
  - isSymmetric
```
public boolean isSymmetric()
```
    Description copied from class: AMatrix
    
    Returns true if a matrix is symmetric
    
    Specified by:
    
    isSymmetric in interface IMatrix
    
    Overrides:
    
    isSymmetric in class ASingleBandMatrix
    
    Returns:
  - isDiagonal
```
public boolean isDiagonal()
```
    Description copied from interface: IMatrix
    
    Returns true iff this matrix is a square diagonal matrix
    
    Specified by:
    
    isDiagonal in interface IMatrix
    
    Overrides:
    
    isDiagonal in class AMatrix
  - isRectangularDiagonal
```
public boolean isRectangularDiagonal()
```
    Description copied from interface: IMatrix
    
    Returns true iff this matrix is a diagonal matrix (might not be square)
    
    Specified by:
    
    isRectangularDiagonal in interface IMatrix
    
    Overrides:
    
    isRectangularDiagonal in class AMatrix
  - isUpperTriangular
```
public boolean isUpperTriangular()
```
    Description copied from class: AMatrix
    
    Returns true if a matrix is upper triangular An upper triangular matrix is defined as having all elements equal to 0.0 where i > j
    
    Overrides:
    
    isUpperTriangular in class ABandedMatrix
  - isLowerTriangular
```
public boolean isLowerTriangular()
```
    Description copied from class: AMatrix
    
    Returns true if a matrix is lower triangular. A lower triangular matrix is defined as having all elements equal to 0.0 where i < j
    
    Overrides:
    
    isLowerTriangular in class ABandedMatrix
  - isMutable
```
public abstract 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 ABandedMatrix
  - 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 ABandedMatrix
  - checkSameShape
```
protected void checkSameShape(AMatrix m)
```
    Description copied from class: AMatrix
    
    Checks if this matrix has the same shape as another matrix. Throws an exception if not.
    
    Overrides:
    
    checkSameShape in class AMatrix
  - checkSameShape
```
protected void checkSameShape(ARectangularMatrix m)
```
    Description copied from class: AMatrix
    
    Checks if this matrix has the same shape as another matrix. Throws an exception if not.
    
    Overrides:
    
    checkSameShape in class AMatrix
  - checkIndex
```
protected final void checkIndex(int i,
                                int j)
```
    Description copied from class: AMatrix
    
    Checks if the given index is valid for this matrix. Throws an exception if not.
    
    Overrides:
    
    checkIndex in class AMatrix
  - isSameShape
```
public final boolean isSameShape(ARectangularMatrix m)
```
  - upperBandwidthLimit
```
public final int upperBandwidthLimit()
```
    Description copied from class: AMatrix
    
    A limit on the upper bandwidth of the banded matrix. Actual upper bandwidth is guaranteed to be less than or equal to this value. Implementation should be O(1).
    
    Specified by:
    
    upperBandwidthLimit in class ABandedMatrix
    
    Returns:
  - lowerBandwidthLimit
```
public final int lowerBandwidthLimit()
```
    Description copied from class: AMatrix
    
    A limit on the lower bandwidth of the banded matrix. Actual lower bandwidth is guaranteed to be less than or equal to this value. Implementation should be O(1).
    
    Specified by:
    
    lowerBandwidthLimit in class ABandedMatrix
    
    Returns:
  - getBand
```
public AVector getBand(int band)
```
    Description copied from class: AMatrix
    
    Gets a specific band of the matrix, as a view vector. The band is truncated at the edges of the matrix, i.e. it does not wrap around the matrix.
    
    Specified by:
    
    getBand in interface IMatrix
    
    Specified by:
    
    getBand in interface IFastBands
    
    Overrides:
    
    getBand in class ASingleBandMatrix
    
    Returns:
  - getNonZeroBand
```
public AVector getNonZeroBand()
```
    Description copied from class: ASingleBandMatrix
    
    Gets the non-zero band from the matrix
    
    Specified by:
    
    getNonZeroBand in class ASingleBandMatrix
    
    Returns:
  - determinant
```
public double determinant()
```
    Description copied from class: AMatrix
    
    Calculates the determinant of the matrix.
    
    Overrides:
    
    determinant in class AMatrix
  - rank
```
public int rank()
```
    Description copied from class: AMatrix
    
    Calculate the rank of a matrix. This is equivalent to the maximum number of linearly independent rows or columns.
    
    Overrides:
    
    rank in class ASingleBandMatrix
  - dimensions
```
public int dimensions()
```
    Returns the number of dimensions of this diagonal matrix
    
    Returns:
  - isSameShape
```
public boolean isSameShape(AMatrix m)
```
    Description copied from class: AMatrix
    
    Returns true iff this matrix is exactly the same shape as another matrix
    
    Overrides:
    
    isSameShape in class AMatrix
    
    Returns:
  - checkSquare
```
public int checkSquare()
```
    Description copied from class: AMatrix
    
    Checks if a matrix is square. Returns the size if true, throws an exception otherwise;
    
    Overrides:
    
    checkSquare in class AMatrix
    
    Returns:
  - 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>
  - 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>
  - 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 ABandedMatrix
  - elementSquaredSum
```
public double elementSquaredSum()
```
    Description copied from class: AMatrix
    
    Returns the squared sum of all elements in this matrix
    
    Specified by:
    
    elementSquaredSum in interface INDArray
    
    Overrides:
    
    elementSquaredSum in class ABandedMatrix
  - 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 ASingleBandMatrix
  - copyRowTo
```
public void copyRowTo(int row,
                      double[] dest,
                      int destOffset)
```
    Description copied from class: AMatrix
    
    Copies the elements in a slected row of this matrix to a double array
    
    Overrides:
    
    copyRowTo in class ABandedMatrix
    
    Parameters:
    
    row - The index of the selected row
    
    dest - Destination double[] array
    
    destOffset - Offset into destination array
  - addToArray
```
public void addToArray(double[] dest,
                       int offset)
```
    Description copied from interface: INDArray
    
    Adds all the elements of this array to a double array, in row-major order
    
    Specified by:
    
    addToArray in interface INDArray
    
    Overrides:
    
    addToArray in class ABandedMatrix
  - addCopy
```
public AMatrix addCopy(AMatrix a)
```
    Description copied from interface: IMatrix
    
    Adds another matrix to this matrix, returning a new matrix
    
    Specified by:
    
    addCopy in interface IMatrix
    
    Overrides:
    
    addCopy in class AMatrix
    
    Returns:
  - copyColumnTo
```
public void copyColumnTo(int col,
                         double[] dest,
                         int destOffset)
```
    Description copied from class: AMatrix
    
    Copies the elements in a selected row of this matrix to a double array
    
    Overrides:
    
    copyColumnTo in class AMatrix
    
    dest - Destination double[] array
  - innerProduct
```
public AMatrix innerProduct(ADiagonalMatrix a)
```
    Computes the inner product of this matrix with another diagonal matrix of the same shape. The result will be a diagnonal matrix of the same shape.
    
    Parameters:
    
    a -
    
    Returns:
  - innerProduct
```
public AMatrix innerProduct(AMatrix a)
```
    Description copied from interface: IMatrix
    
    Computes the inner product of this matrix with another. Equivalent to matrix x matrix multiplication
    
    Specified by:
    
    innerProduct in interface IMatrix
    
    Overrides:
    
    innerProduct in class AMatrix
    
    Returns:
  - transposeInnerProduct
```
public AMatrix transposeInnerProduct(AMatrix s)
```
    Overrides:
    
    transposeInnerProduct in class AMatrix
  - transformInPlace
```
public void transformInPlace(AVector v)
```
    Specified by:
    
    transformInPlace in interface IMatrix
    
    Overrides:
    
    transformInPlace in class AMatrix
  - transformInPlace
```
public void transformInPlace(ADenseArrayVector v)
```
    Overrides:
    
    transformInPlace in class AMatrix
  - transform
```
public void transform(Vector source,
                      Vector dest)
```
    Overrides:
    
    transform in class AMatrix
  - rowCount
```
public int rowCount()
```
    Description copied from interface: IMatrix
    
    Gets the number of rows in this matrix (dimension 0)
    
    Returns:
  - columnCount
```
public int columnCount()
```
    Description copied from interface: IMatrix
    
    Gets the number of columns in this matrix (dimension 1)
    
    Returns:
  - isIdentity
```
public boolean isIdentity()
```
    Description copied from interface: IMatrix
    
    Checks if this is an identity matrix (i.e. 1.0 in leading diagonal, 0.0 elsewhere)
    
    Specified by:
    
    isIdentity in interface IMatrix
    
    Overrides:
    
    isIdentity in class ASingleBandMatrix
    
    Returns:
    
    true if this matrix is a square identity matrix, false otherwise.
  - transposeInPlace
```
public void transposeInPlace()
```
    Description copied from interface: IMatrix
    
    Transposes a matrix in place, if possible. Throws an exception if this is not possible (e.g. if the matrix is not square or not sufficiently mutable)
    
    Specified by:
    
    transposeInPlace in interface IMatrix
    
    Overrides:
    
    transposeInPlace in class AMatrix
  - rowDotProduct
```
public double rowDotProduct(int i,
                            AVector v)
```
    Description copied from class: AMatrix
    
    Returns the dot product of a specific row with a vector. Unsafe operation: performs no bounds checking
    
    Overrides:
    
    rowDotProduct in class AMatrix
    
    Returns:
  - 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
    
    Specified by:
    
    set in class AMatrix
  - getLeadingDiagonal
```
public abstract 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:
  - getDiagonalValue
```
public double getDiagonalValue(int i)
```
  - getRow
```
public ASingleElementVector getRow(int row)
```
    Description copied from interface: IMatrix
    
    Returns a row of the matrix. May or may not be a view, depending on matrix type. Intended for the fastest possible read access of the row. This often means a view, but might not be (e.g. getRow on a Matrix33 returns a Vector3).
    
    Specified by:
    
    getRow in interface IMatrix
    
    Overrides:
    
    getRow in class AMatrix
  - getColumn
```
public ASingleElementVector getColumn(int col)
```
    Description copied from interface: IMatrix
    
    Returns a column of the matrix. May or may not be a view, depending on matrix type. Intended for the fastest possible read access of the column. This often means a view, but might not be (e.g. getColumn on a Matrix33 returns a Vector3).
    
    Specified by:
    
    getColumn in interface IMatrix
    
    Overrides:
    
    getColumn in class AMatrix
  - unsafeGetDiagonalValue
```
public double unsafeGetDiagonalValue(int i)
```
  - getTranspose
```
public ADiagonalMatrix getTranspose()
```
    Description copied from interface: INDArray
    
    Returns the transpose of this array. A transpose of an array is equivalent to reversing the order of dimensions. May or may not return a view depending on the array type.
    
    Specified by:
    
    getTranspose in interface INDArray
    
    Specified by:
    
    getTranspose in interface IMatrix
    
    Overrides:
    
    getTranspose in class AMatrix
    
    Returns:
    
    the transpose of this matrix
  - getTransposeView
```
public ADiagonalMatrix getTransposeView()
```
    Description copied from interface: INDArray
    
    Returns a transposed view of the array. May throw UnsupportedOperationException if the array type does not support this capability
    
    Specified by:
    
    getTransposeView in interface INDArray
    
    Specified by:
    
    getTransposeView in interface IMatrix
    
    Overrides:
    
    getTransposeView in class AMatrix
    
    Returns:
    
    the transpose of this matrix, as a view
  - 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
    
    Overrides:
    
    density in class ABandedMatrix
    
    Returns:
  - 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 ABandedMatrix
  - trace
```
public double trace()
```
    Description copied from interface: IMatrix
    
    Computes the trace of a matrix, i.e. the sum of all elements on the leading diagonal
    
    Specified by:
    
    trace in interface IMatrix
    
    Overrides:
    
    trace in class ABandedMatrix
    
    Returns:
  - diagonalProduct
```
public double diagonalProduct()
```
    Description copied from class: AMatrix
    
    Computes the product of entries on the main diagonal of a matrix
    
    Specified by:
    
    diagonalProduct in interface IMatrix
    
    Overrides:
    
    diagonalProduct in class ABandedMatrix
    
    Returns:
  - toDoubleArray
```
public double[] toDoubleArray()
```
    Description copied from interface: INDArray
    
    Copies the elements of this array to a new double[] array.
    
    Specified by:
    
    toDoubleArray in interface INDArray
    
    Overrides:
    
    toDoubleArray in class ABandedMatrix
  - toMatrixTranspose
```
public final 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 ABandedMatrix
  - equalsTranspose
```
public boolean equalsTranspose(AMatrix m)
```
    Description copied from class: AMatrix
    
    Tests if this matrix is exactly equal to the transpose of another matrix
    
    Overrides:
    
    equalsTranspose 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 ABandedMatrix
  - exactClone
```
public abstract ADiagonalMatrix 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
  - clone
```
public AMatrix clone()
```
    Description copied from interface: INDArray
    
    Returns a clone of the array data, as a new array which will be fully mutable and may be of a different class to the original. Clone should attempt to return the most efficient possible array type. Clone should preserve sparsity property where possible, but this is not guaranteed.
    
    Specified by:
    
    clone in interface INDArray
    
    Overrides:
    
    clone in class AMatrix
  - hasUncountable
```
public boolean hasUncountable()
```
    Description copied from class: AMatrix
    
    Checks to see if any element in the matrix is NaN of Infinite.
    
    Specified by:
    
    hasUncountable in interface INDArray
    
    Overrides:
    
    hasUncountable in class ASingleBandMatrix
    
    Returns:
    
    True if any element in the matrix is NaN of Infinite.
  - elementPowSum
```
public double elementPowSum(double p)
```
    Returns the sum of all the elements raised to a specified power
    
    Specified by:
    
    elementPowSum in interface INDArray
    
    Overrides:
    
    elementPowSum in class ASingleBandMatrix
    
    Returns:
  - elementAbsPowSum
```
public double elementAbsPowSum(double p)
```
    Returns the sum of the absolute values of all the elements raised to a specified power
    
    Specified by:
    
    elementAbsPowSum in interface INDArray
    
    Overrides:
    
    elementAbsPowSum in class ASingleBandMatrix
    
    Returns:

Class ADiagonalMatrix

Field Summary

Constructor Summary

Method Summary

Methods inherited from class mikera.matrixx.impl.ASingleBandMatrix

Methods inherited from class mikera.matrixx.impl.ABandedMatrix

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

Methods inherited from interface java.lang.Iterable

Field Detail

dimensions

Constructor Detail

ADiagonalMatrix

Method Detail

nonZeroBand

isSquare

isZero

isBoolean

isSymmetric

isDiagonal

isRectangularDiagonal

isUpperTriangular

isLowerTriangular

isMutable

isFullyMutable

checkSameShape

checkSameShape

checkIndex

isSameShape

upperBandwidthLimit

lowerBandwidthLimit

getBand

getNonZeroBand

determinant

rank

dimensions

isSameShape

checkSquare

elementMax

elementMin

elementSum

elementSquaredSum

nonZeroCount

copyRowTo

addToArray

addCopy

copyColumnTo

innerProduct

innerProduct

transposeInnerProduct

transformInPlace

transformInPlace

transform

rowCount

columnCount

isIdentity

transposeInPlace

rowDotProduct

set

getLeadingDiagonal

getDiagonalValue

getRow

getColumn

unsafeGetDiagonalValue

getTranspose

getTransposeView

density

toMatrix

trace

diagonalProduct

toDoubleArray

toMatrixTranspose

equalsTranspose

validate

exactClone

clone

hasUncountable

elementPowSum