SparseMatrix (xlinear API)

All Superinterfaces:

Matrix

All Known Implementing Classes:

ColtSparseMatrix
```
public interface SparseMatrix
extends Matrix
```

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`default DenseMatrix`	`add(DenseMatrix m)`
`default SparseMatrix`	`add(SparseMatrix m)`
`default void`	`addInPlace(DenseMatrix m)`
`default void`	`addInPlace(SparseMatrix m)`
`default CholeskyDecomposition`	`cholesky()` Default behavior for views: convert to concrete implementation and then compute the Cholesky
`default SparseMatrix`	`col(int index)`
`SparseMatrix`	`createEmpty(int nRows, int nCols)`
`default SparseMatrix`	`div(java.lang.Number n)`
`void`	`editNonZerosInPlace(MatrixVisitorEditInPlace visitor)`
`default Matrix`	`inverse()`
`default LUDecomposition`	`lu()` Default behavior for views: convert to concrete implementation and then compute the LU
`default DenseMatrix`	`mul(DenseMatrix m)`
`default SparseMatrix`	`mul(java.lang.Number n)`
`SparseMatrix`	`mul(SparseMatrix m)`
`default void`	`mulInPlace(java.lang.Number n)`
`default java.util.stream.DoubleStream`	`nonZeroEntries()`
`default SparseMatrix`	`operator_divide(java.lang.Number n)`
`default DenseMatrix`	`operator_minus(DenseMatrix m)`
`default Matrix`	`operator_minus(Matrix m)`
`default SparseMatrix`	`operator_minus(SparseMatrix m)`
`default DenseMatrix`	`operator_multiply(DenseMatrix m)`
`default Matrix`	`operator_multiply(Matrix m)`
`default SparseMatrix`	`operator_multiply(java.lang.Number n)`
`default SparseMatrix`	`operator_multiply(SparseMatrix m)`
`default DenseMatrix`	`operator_plus(DenseMatrix m)`
`default Matrix`	`operator_plus(Matrix m)`
`default SparseMatrix`	`operator_plus(SparseMatrix m)`
`default SparseMatrix`	`readOnlyView()`
`default SparseMatrix`	`row(int index)`
`default SparseMatrix`	`slice(int row0Incl, int row1Excl, int col0Incl, int col1Excl)`
`SparseMatrix`	`slice(int row0Incl, int row1Excl, int col0Incl, int col1Excl, boolean makeReadOnly)`
`default DenseMatrix`	`sub(DenseMatrix m)`
`default SparseMatrix`	`sub(SparseMatrix m)`
`default void`	`subInPlace(DenseMatrix m)`
`default void`	`subInPlace(SparseMatrix m)`
`default SparseMatrix`	`transpose()`
`void`	`visitNonZeros(MatrixVisitorViewOnly visitor)` Efficient traversal of non zero entries.

Methods inherited from interface xlinear.Matrix
add, addInPlace, divInPlace, get, get, isVector, mul, nCols, nEntries, nRows, operator_add, operator_add, operator_add, operator_divideAssign, operator_multiplyAssign, operator_remove, operator_remove, operator_remove, set, set, sub, subInPlace

- Method Detail
  - visitNonZeros
```
void visitNonZeros(MatrixVisitorViewOnly visitor)
```
    Efficient traversal of non zero entries. Specific order at which these entries are visited is up to the implementation. We assume the visits are done sequentially (refactor at some point with the Stream framework to give choice in future?)
  - editNonZerosInPlace
```
void editNonZerosInPlace(MatrixVisitorEditInPlace visitor)
```
  - createEmpty
```
SparseMatrix createEmpty(int nRows,
                         int nCols)
```
    Specified by:
    
    createEmpty in interface Matrix
  - cholesky
```
default CholeskyDecomposition cholesky()
```
    Default behavior for views: convert to concrete implementation and then compute the Cholesky
    
    Specified by:
    
    cholesky in interface Matrix
  - lu
```
default LUDecomposition lu()
```
    Default behavior for views: convert to concrete implementation and then compute the LU
    
    Specified by:
    
    lu in interface Matrix
  - inverse
```
default Matrix inverse()
```
    Specified by:
    
    inverse in interface Matrix
  - nonZeroEntries
```
default java.util.stream.DoubleStream nonZeroEntries()
```
    Specified by:
    
    nonZeroEntries in interface Matrix
  - transpose
```
default SparseMatrix transpose()
```
    Specified by:
    
    transpose in interface Matrix
  - operator_multiply
```
default SparseMatrix operator_multiply(java.lang.Number n)
```
    Specified by:
    
    operator_multiply in interface Matrix
  - mul
```
default SparseMatrix mul(java.lang.Number n)
```
    Specified by:
    
    mul in interface Matrix
  - operator_divide
```
default SparseMatrix operator_divide(java.lang.Number n)
```
    Specified by:
    
    operator_divide in interface Matrix
  - div
```
default SparseMatrix div(java.lang.Number n)
```
    Specified by:
    
    div in interface Matrix
  - mulInPlace
```
default void mulInPlace(java.lang.Number n)
```
    Specified by:
    
    mulInPlace in interface Matrix
  - operator_multiply
```
default Matrix operator_multiply(Matrix m)
```
    Specified by:
    
    operator_multiply in interface Matrix
  - operator_multiply
```
default DenseMatrix operator_multiply(DenseMatrix m)
```
    Specified by:
    
    operator_multiply in interface Matrix
  - operator_multiply
```
default SparseMatrix operator_multiply(SparseMatrix m)
```
    Specified by:
    
    operator_multiply in interface Matrix
  - mul
```
default DenseMatrix mul(DenseMatrix m)
```
    Specified by:
    
    mul in interface Matrix
  - mul
```
SparseMatrix mul(SparseMatrix m)
```
    Specified by:
    
    mul in interface Matrix
  - operator_plus
```
default Matrix operator_plus(Matrix m)
```
    Specified by:
    
    operator_plus in interface Matrix
  - operator_plus
```
default DenseMatrix operator_plus(DenseMatrix m)
```
    Specified by:
    
    operator_plus in interface Matrix
  - operator_plus
```
default SparseMatrix operator_plus(SparseMatrix m)
```
    Specified by:
    
    operator_plus in interface Matrix
  - add
```
default DenseMatrix add(DenseMatrix m)
```
    Specified by:
    
    add in interface Matrix
  - add
```
default SparseMatrix add(SparseMatrix m)
```
    Specified by:
    
    add in interface Matrix
  - addInPlace
```
default void addInPlace(DenseMatrix m)
```
    Specified by:
    
    addInPlace in interface Matrix
  - addInPlace
```
default void addInPlace(SparseMatrix m)
```
    Specified by:
    
    addInPlace in interface Matrix
  - operator_minus
```
default Matrix operator_minus(Matrix m)
```
    Specified by:
    
    operator_minus in interface Matrix
  - operator_minus
```
default DenseMatrix operator_minus(DenseMatrix m)
```
    Specified by:
    
    operator_minus in interface Matrix
  - operator_minus
```
default SparseMatrix operator_minus(SparseMatrix m)
```
    Specified by:
    
    operator_minus in interface Matrix
  - sub
```
default DenseMatrix sub(DenseMatrix m)
```
    Specified by:
    
    sub in interface Matrix
  - sub
```
default SparseMatrix sub(SparseMatrix m)
```
    Specified by:
    
    sub in interface Matrix
  - subInPlace
```
default void subInPlace(DenseMatrix m)
```
    Specified by:
    
    subInPlace in interface Matrix
  - subInPlace
```
default void subInPlace(SparseMatrix m)
```
    Specified by:
    
    subInPlace in interface Matrix
  - slice
```
SparseMatrix slice(int row0Incl,
                   int row1Excl,
                   int col0Incl,
                   int col1Excl,
                   boolean makeReadOnly)
```
    Specified by:
    
    slice in interface Matrix
  - slice
```
default SparseMatrix slice(int row0Incl,
                           int row1Excl,
                           int col0Incl,
                           int col1Excl)
```
    Specified by:
    
    slice in interface Matrix
  - row
```
default SparseMatrix row(int index)
```
    Specified by:
    
    row in interface Matrix
  - col
```
default SparseMatrix col(int index)
```
    Specified by:
    
    col in interface Matrix
  - readOnlyView
```
default SparseMatrix readOnlyView()
```
    Specified by:
    
    readOnlyView in interface Matrix

Interface SparseMatrix

Method Summary

Methods inherited from interface xlinear.Matrix

Method Detail

visitNonZeros

editNonZerosInPlace

createEmpty

cholesky

lu

inverse

nonZeroEntries

transpose

operator_multiply

mul

operator_divide

div

mulInPlace

operator_multiply

operator_multiply

operator_multiply

mul

mul

operator_plus

operator_plus

operator_plus

add

add

addInPlace

addInPlace

operator_minus

operator_minus

operator_minus

sub

sub

subInPlace

subInPlace

slice

slice

row

col

readOnlyView