Package org.flag4j.core

Interface MatrixMixin<T,U,V,W,VV,X extends Number,TT extends VectorMixin<TT,UU,?,?,?,?,?,?>,UU extends VectorMixin<UU,UU,?,CVector,X,U,U,CMatrix>>

Type Parameters:

T - Matrix type.

U - Dense matrix type.

V - Sparse matrix type.

W - Complex matrix type.

VV - Complex sparse matrix type.

X - Matrix entry type.

TT - Vector type equivalent.

UU - Dense vector type.

Y - Real matrix type.

All Superinterfaces:

MatrixComparisonsMixin<T>, MatrixManipulationsMixin<T,X>, MatrixOperationsMixin<T,U,V,W,VV,X,TT,UU>, MatrixPropertiesMixin

All Known Implementing Classes:

CMatrix, CooCMatrix, CooMatrix, CsrCMatrix, CsrMatrix, Matrix

public interface MatrixMixin<T,U,V,W,VV,X extends Number,TT extends VectorMixin<TT,UU,?,?,?,?,?,?>,UU extends VectorMixin<UU,UU,?,CVector,X,U,U,CMatrix>>
extends MatrixPropertiesMixin, MatrixComparisonsMixin<T>, MatrixManipulationsMixin<T,X>, MatrixOperationsMixin<T,U,V,W,VV,X,TT,UU>

This interface specified methods which all matrices should implement.

Method Summary

Modifier and Type	Method	Description
X	get(int... indices)	Gets the element of this matrix at the specified indices.
int	numCols()	Gets the number of columns in this matrix.
int	numRows()	Gets the number of rows in this matrix.
Shape	shape()	Gets the shape of this matrix.

Methods inherited from interface org.flag4j.core.MatrixComparisonsMixin

isI

Methods inherited from interface org.flag4j.core.MatrixManipulationsMixin

removeCol, removeCols, removeRow, removeRows, set, set, setCol, setCol, setCol, setCol, setCol, setRow, setRow, setRow, setRow, setRow, setSlice, setSlice, setSlice, setSlice, setSlice, setSlice, setSlice, setSlice, swapCols, swapRows

Methods inherited from interface org.flag4j.core.MatrixOperationsMixin

add, add, add, add, add, add, addToEachCol, addToEachCol, addToEachCol, addToEachCol, addToEachRow, addToEachRow, addToEachRow, addToEachRow, augment, augment, augment, augment, augment, augment, augment, augment, augment, augment, copy, det, elemDiv, elemDiv, elemMult, elemMult, elemMult, elemMult, fib, fib, fib, fib, getCol, getCol, getColBelow, getDiag, getRow, getRowAfter, getSlice, H, mult, mult, mult, mult, mult, mult, mult, mult, mult, mult, mult, mult, mult, multTranspose, multTranspose, multTranspose, multTranspose, multTranspose, multTranspose, pow, setCol, stack, stack, stack, stack, stack, stack, stack, stack, stack, stack, stack, stack, stack, stack, stack, stack, stack, stack, stack, stack, sub, sub, sub, sub, sub, sub, sumCols, sumRows, toVector, tr, trace

Methods inherited from interface org.flag4j.core.MatrixPropertiesMixin

isDiag, isFullRank, isInvertible, isSingular, isSquare, isTri, isTriL, isTriU, isVector, matrixRank, vectorType

Method Details

numRows

int numRows()

Gets the number of rows in this matrix.

Returns:

The number of rows in this matrix.

numCols

int numCols()

Gets the number of columns in this matrix.

Returns:

The number of columns in this matrix.

get

X get(int... indices)

Gets the element of this matrix at the specified indices.

Parameters:

indices - Indices of the element to get.

Returns:

The element of this matrix at the specified indices.

Throws:

IllegalArgumentException - If indices is not of length 2.

ArrayIndexOutOfBoundsException - If any indices are not within this matrix.

shape

Shape shape()

Gets the shape of this matrix.

Returns:

The shape of this matrix.