java.lang.Object
- org.la4j.Matrix
- - org.la4j.matrix.SparseMatrix
  - - org.la4j.matrix.RowMajorSparseMatrix
    - - org.la4j.matrix.sparse.CRSMatrix

All Implemented Interfaces:

java.lang.Iterable<java.lang.Double>
```
public class CRSMatrix
extends RowMajorSparseMatrix
```
This is a CRS (Compressed Row Storage) matrix class.

Field Summary

Fields
Modifier and Type	Field	Description
`private int[]`	`columnIndices`
`private static byte`	`MATRIX_TAG`
`private static int`	`MINIMUM_SIZE`
`private int[]`	`rowPointers`
`private double[]`	`values`

Fields inherited from class org.la4j.matrix.SparseMatrix
cardinality

Fields inherited from class org.la4j.Matrix
columns, rows

Constructor Summary

Constructors
Constructor	Description
`CRSMatrix()`
`CRSMatrix(int rows, int columns)`
`CRSMatrix(int rows, int columns, int capacity)`
`CRSMatrix(int rows, int columns, int cardinality, double[] values, int[] columnIndices, int[] rowPointers)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`private int`	`align(int cardinality)`
`Matrix`	`blankOfShape(int rows, int columns)`	Creates the blank matrix (a zero matrix with same size) of this matrix of the given shape: `rows` x `columns`.
`static CRSMatrix`	`block(Matrix a, Matrix b, Matrix c, Matrix d)`	Creates a block `CRSMatrix` of the given blocks `a`, `b`, `c` and `d`.
`Matrix`	`copyOfShape(int rows, int columns)`	Copies this matrix into the new matrix with specified dimensions: `rows` and `columns`.
`static CRSMatrix`	`diagonal(int size, double diagonal)`	Creates a diagonal `CRSMatrix` of the given `size` whose diagonal elements are equal to `diagonal`.
`void`	`each(MatrixProcedure procedure)`	Applies given `procedure` to each element of this matrix.
`void`	`eachInRow(int i, VectorProcedure procedure)`	Applies given `procedure` to each element of specified row of this matrix.
`void`	`eachNonZero(MatrixProcedure procedure)`	Applies given `procedure` to each non-zero element of this matrix.
`void`	`eachNonZeroInRow(int i, VectorProcedure procedure)`	Applies the given `procedure` to each non-zero element of the specified row of this matrix.
`static CRSMatrix`	`from1DArray(int rows, int columns, double[] array)`	Creates a new `CRSMatrix` from the given 1D `array` with compressing (copying) the underlying array.
`static CRSMatrix`	`from2DArray(double[][] array)`	Creates a new `CRSMatrix` from the given 2D `array` with compressing (copying) the underlying array.
`static CRSMatrix`	`fromBinary(byte[] array)`	Decodes `CRSMatrix` from the given byte `array`.
`static CRSMatrix`	`fromCSV(java.lang.String csv)`	Parses `CRSMatrix` from the given CSV string.
`static CRSMatrix`	`fromMatrixMarket(java.lang.String mm)`	Parses `CRSMatrix` from the given Matrix Market string.
`Vector`	`getColumn(int j)`	Copies the specified column of this matrix into the vector.
`double`	`getOrElse(int i, int j, double defaultValue)`	Gets the specified element, or a `defaultValue` if there is no actual element at (`i`, `j`) in this sparse matrix.
`Vector`	`getRow(int i)`	Copies the specified row of this matrix into the vector.
`private void`	`growUp()`
`static CRSMatrix`	`identity(int size)`	Creates an identity `CRSMatrix` of the given `size`.
`private void`	`insert(int k, int i, int j, double value)`
`java.util.Iterator<java.lang.Integer>`	`iteratorOfNonZeroRows()`
`VectorIterator`	`iteratorOfRow(int i)`	Returns a vector iterator of the given row {code i}.
`double`	`max()`	Searches for the maximum value of the elements of this matrix.
`double`	`maxInRow(int i)`	Searches for the maximum value of specified row in this matrix.
`double`	`min()`	Searches for the minimum value of the elements of this matrix.
`double`	`minInRow(int i)`	Searches for the minimum value of specified row in this matrix.
`boolean`	`nonZeroAt(int i, int j)`	Whether or not the specified element is not zero.
`VectorIterator`	`nonZeroIteratorOfRow(int i)`	Returns a non-zero vector iterator of the given row `i`.
`RowMajorMatrixIterator`	`nonZeroRowMajorIterator()`	Returns a non-zero row-major matrix iterator.
`static CRSMatrix`	`random(int rows, int columns, double density, java.util.Random random)`	Creates a random `CRSMatrix` of the given shape: `rows` x `columns`.
`static CRSMatrix`	`randomSymmetric(int size, double density, java.util.Random random)`	Creates a random symmetric `CRSMatrix` of the given `size`.
`private void`	`remove(int k, int i)`
`RowMajorMatrixIterator`	`rowMajorIterator()`	Returns a row-major matrix iterator.
`private int`	`searchForColumnIndex(int j, int left, int right)`
`Matrix`	`select(int[] rowIndices, int[] columnIndices)`	Returns a CRSMatrix with the selected rows and columns.
`void`	`set(int i, int j, double value)`	Sets the specified element of this matrix to given `value`.
`void`	`setAll(double value)`	Sets all elements of this matrix to the given `value`.
`<T extends Matrix> T`	`to(MatrixFactory<T> factory)`	Converts this matrix using the given `factory`.
`byte[]`	`toBinary()`	Encodes this matrix into a byte array.
`void`	`updateAt(int i, int j, MatrixFunction function)`	Updates the specified element of this matrix by applying given `function`.
`static CRSMatrix`	`zero(int rows, int columns)`	Creates a zero `CRSMatrix` of the given shape: `rows` x `columns`.
`static CRSMatrix`	`zero(int rows, int columns, int capacity)`	Creates a zero `CRSMatrix` of the given shape: `rows` x `columns` with the given `capacity`.

Methods inherited from class org.la4j.matrix.RowMajorSparseMatrix
apply, apply, apply, isRowMajor, rotate, transpose

Methods inherited from class org.la4j.matrix.SparseMatrix
add, capacity, cardinality, density, eachNonZeroInColumn, ensureCardinalityIsCorrect, foldNonZero, foldNonZeroInColumn, foldNonZeroInColumns, foldNonZeroInRow, foldNonZeroInRows, get, isColumnMajor, isZeroAt, multiply, nonZeroColumnMajorIterator, nonZeroIterator, nonZeroIteratorOfColumn, toMatrixMarket

Methods inherited from class org.la4j.Matrix
add, blank, blankOfColumns, blankOfRows, columnMajorIterator, columns, constant, copy, copyOfColumns, copyOfRows, determinant, diagonalProduct, divide, eachInColumn, ensureDimensionsAreCorrect, ensureIndexesAreInBounds, equals, equals, euclideanNorm, fail, fold, foldColumn, foldColumns, foldRow, foldRows, hadamardProduct, hashCode, infinityNorm, insert, insert, insert, insert, insertColumn, insertRow, is, is, iterator, iteratorOfColumn, kroneckerProduct, manhattanNorm, maxInColumn, minInColumn, mkString, mkString, mkString, multiply, multiply, multiplyByItsTranspose, non, non, norm, power, product, random, randomSymmetric, rank, removeColumn, removeFirstColumn, removeFirstRow, removeLastColumn, removeLastRow, removeRow, rows, setColumn, setColumn, setRow, setRow, shuffle, slice, sliceBottomRight, sliceTopLeft, subtract, subtract, sum, swapColumns, swapRows, toColumnMajorSparseMatrix, toColumnVector, toCSV, toCSV, toDenseMatrix, toMatrixMarket, toRowMajorSparseMatrix, toRowVector, toSparseMatrix, toString, trace, transform, transformColumn, transformRow, unit, update, updateColumn, updateRow, withDecompositor, withInverter, withSolver

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

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

- Field Detail
  - MATRIX_TAG
```
private static final byte MATRIX_TAG
```
    See Also:
    
    Constant Field Values
  - MINIMUM_SIZE
```
private static final int MINIMUM_SIZE
```
    See Also:
    
    Constant Field Values
  - values
```
private double[] values
```
  - columnIndices
```
private int[] columnIndices
```
  - rowPointers
```
private int[] rowPointers
```
- Constructor Detail
  - CRSMatrix
```
public CRSMatrix()
```
  - CRSMatrix
```
public CRSMatrix(int rows,
                 int columns)
```
  - CRSMatrix
```
public CRSMatrix(int rows,
                 int columns,
                 int capacity)
```
  - CRSMatrix
```
public CRSMatrix(int rows,
                 int columns,
                 int cardinality,
                 double[] values,
                 int[] columnIndices,
                 int[] rowPointers)
```
- Method Detail
  - zero
```
public static CRSMatrix zero(int rows,
                             int columns)
```
    Creates a zero CRSMatrix of the given shape: rows x columns.
  - zero
```
public static CRSMatrix zero(int rows,
                             int columns,
                             int capacity)
```
    Creates a zero CRSMatrix of the given shape: rows x columns with the given capacity.
  - diagonal
```
public static CRSMatrix diagonal(int size,
                                 double diagonal)
```
    Creates a diagonal CRSMatrix of the given size whose diagonal elements are equal to diagonal.
  - identity
```
public static CRSMatrix identity(int size)
```
    Creates an identity CRSMatrix of the given size.
  - random
```
public static CRSMatrix random(int rows,
                               int columns,
                               double density,
                               java.util.Random random)
```
    Creates a random CRSMatrix of the given shape: rows x columns.
  - randomSymmetric
```
public static CRSMatrix randomSymmetric(int size,
                                        double density,
                                        java.util.Random random)
```
    Creates a random symmetric CRSMatrix of the given size.
  - from1DArray
```
public static CRSMatrix from1DArray(int rows,
                                    int columns,
                                    double[] array)
```
    Creates a new CRSMatrix from the given 1D array with compressing (copying) the underlying array.
  - from2DArray
```
public static CRSMatrix from2DArray(double[][] array)
```
    Creates a new CRSMatrix from the given 2D array with compressing (copying) the underlying array.
  - block
```
public static CRSMatrix block(Matrix a,
                              Matrix b,
                              Matrix c,
                              Matrix d)
```
    Creates a block CRSMatrix of the given blocks a, b, c and d.
  - fromBinary
```
public static CRSMatrix fromBinary(byte[] array)
```
    Decodes CRSMatrix from the given byte array.
    
    Parameters:
    
    array - the byte array representing a matrix
    
    Returns:
    
    a decoded matrix
  - fromCSV
```
public static CRSMatrix fromCSV(java.lang.String csv)
```
    Parses CRSMatrix from the given CSV string.
    
    Parameters:
    
    csv - the CSV string representing a matrix
    
    Returns:
    
    a parsed matrix
  - fromMatrixMarket
```
public static CRSMatrix fromMatrixMarket(java.lang.String mm)
```
    Parses CRSMatrix from the given Matrix Market string.
    
    Parameters:
    
    mm - the string in Matrix Market format
    
    Returns:
    
    a parsed matrix
  - getOrElse
```
public double getOrElse(int i,
                        int j,
                        double defaultValue)
```
    Description copied from class: SparseMatrix
    
    Gets the specified element, or a defaultValue if there is no actual element at (i, j) in this sparse matrix.
    
    Specified by:
    
    getOrElse in class SparseMatrix
    
    Parameters:
    
    i - the element's row index
    
    j - the element's column index
    
    defaultValue - the default value
    
    Returns:
    
    the element of this vector or a default value
  - set
```
public void set(int i,
                int j,
                double value)
```
    Description copied from class: Matrix
    
    Sets the specified element of this matrix to given value.
    
    Specified by:
    
    set in class Matrix
    
    Parameters:
    
    i - element's row index
    
    j - element's column index
    
    value - element's new value
  - setAll
```
public void setAll(double value)
```
    Description copied from class: Matrix
    
    Sets all elements of this matrix to the given value.
    
    Overrides:
    
    setAll in class Matrix
    
    Parameters:
    
    value - the element's new value
  - getRow
```
public Vector getRow(int i)
```
    Description copied from class: Matrix
    
    Copies the specified row of this matrix into the vector.
    
    Overrides:
    
    getRow in class SparseMatrix
    
    Parameters:
    
    i - the row index
    
    Returns:
    
    the row represented as vector
  - getColumn
```
public Vector getColumn(int j)
```
    Description copied from class: Matrix
    
    Copies the specified column of this matrix into the vector.
    
    Overrides:
    
    getColumn in class SparseMatrix
    
    Parameters:
    
    j - the column index
    
    Returns:
    
    the column represented as vector
  - copyOfShape
```
public Matrix copyOfShape(int rows,
                          int columns)
```
    Description copied from class: Matrix
    
    Copies this matrix into the new matrix with specified dimensions: rows and columns.
    
    Specified by:
    
    copyOfShape in class Matrix
    
    Parameters:
    
    rows - the number of rows in new matrix
    
    columns - the number of columns in new matrix
    
    Returns:
    
    the copy of this matrix with new size
  - eachNonZero
```
public void eachNonZero(MatrixProcedure procedure)
```
    Description copied from class: SparseMatrix
    
    Applies given procedure to each non-zero element of this matrix.
    
    Overrides:
    
    eachNonZero in class SparseMatrix
    
    Parameters:
    
    procedure - the matrix procedure
  - each
```
public void each(MatrixProcedure procedure)
```
    Description copied from class: Matrix
    
    Applies given procedure to each element of this matrix.
    
    Overrides:
    
    each in class Matrix
    
    Parameters:
    
    procedure - the matrix procedure
  - eachInRow
```
public void eachInRow(int i,
                      VectorProcedure procedure)
```
    Description copied from class: Matrix
    
    Applies given procedure to each element of specified row of this matrix.
    
    Overrides:
    
    eachInRow in class Matrix
    
    Parameters:
    
    i - the row index
    
    procedure - the vector procedure
  - eachNonZeroInRow
```
public void eachNonZeroInRow(int i,
                             VectorProcedure procedure)
```
    Description copied from class: SparseMatrix
    
    Applies the given procedure to each non-zero element of the specified row of this matrix.
    
    Overrides:
    
    eachNonZeroInRow in class SparseMatrix
    
    Parameters:
    
    i - the row index.
    
    procedure - the VectorProcedure.
  - updateAt
```
public void updateAt(int i,
                     int j,
                     MatrixFunction function)
```
    Description copied from class: Matrix
    
    Updates the specified element of this matrix by applying given function.
    
    Overrides:
    
    updateAt in class Matrix
    
    Parameters:
    
    i - the row index
    
    j - the column index
    
    function - the matrix function
  - nonZeroAt
```
public boolean nonZeroAt(int i,
                         int j)
```
    Description copied from class: SparseMatrix
    
    Whether or not the specified element is not zero.
    
    Specified by:
    
    nonZeroAt in class SparseMatrix
    
    Parameters:
    
    i - element's row index
    
    j - element's column index
    
    Returns:
    
    true if specified element is not zero, false otherwise
  - searchForColumnIndex
```
private int searchForColumnIndex(int j,
                                 int left,
                                 int right)
```
  - insert
```
private void insert(int k,
                    int i,
                    int j,
                    double value)
```
  - remove
```
private void remove(int k,
                    int i)
```
  - growUp
```
private void growUp()
```
  - align
```
private int align(int cardinality)
```
  - max
```
public double max()
```
    Description copied from class: Matrix
    
    Searches for the maximum value of the elements of this matrix.
    
    Overrides:
    
    max in class Matrix
    
    Returns:
    
    maximum value of this matrix
  - min
```
public double min()
```
    Description copied from class: Matrix
    
    Searches for the minimum value of the elements of this matrix.
    
    Overrides:
    
    min in class Matrix
    
    Returns:
    
    minimum value of this matrix
  - maxInRow
```
public double maxInRow(int i)
```
    Description copied from class: Matrix
    
    Searches for the maximum value of specified row in this matrix.
    
    Overrides:
    
    maxInRow in class Matrix
    
    Parameters:
    
    i - the row index
    
    Returns:
    
    maximum value of specified row in this matrix
  - minInRow
```
public double minInRow(int i)
```
    Description copied from class: Matrix
    
    Searches for the minimum value of specified row in this matrix.
    
    Overrides:
    
    minInRow in class Matrix
    
    Parameters:
    
    i - the row index
    
    Returns:
    
    minimum value of specified row in this matrix
  - select
```
public Matrix select(int[] rowIndices,
                     int[] columnIndices)
```
    Returns a CRSMatrix with the selected rows and columns.
    
    Overrides:
    
    select in class Matrix
    
    Parameters:
    
    rowIndices - the array of row indices
    
    columnIndices - the array of column indices
    
    Returns:
    
    the new matrix with the selected rows and columns
  - to
```
public <T extends Matrix> T to(MatrixFactory<T> factory)
```
    Description copied from class: Matrix
    
    Converts this matrix using the given factory.
    
    Overrides:
    
    to in class Matrix
    
    Type Parameters:
    
    T - type of the result matrix
    
    Parameters:
    
    factory - the factory that creates an output matrix
    
    Returns:
    
    converted matrix
  - blankOfShape
```
public Matrix blankOfShape(int rows,
                           int columns)
```
    Description copied from class: Matrix
    
    Creates the blank matrix (a zero matrix with same size) of this matrix of the given shape: rows x columns.
    
    Specified by:
    
    blankOfShape in class Matrix
    
    Returns:
    
    blank matrix
  - iteratorOfNonZeroRows
```
public java.util.Iterator<java.lang.Integer> iteratorOfNonZeroRows()
```
    Specified by:
    
    iteratorOfNonZeroRows in class RowMajorSparseMatrix
  - rowMajorIterator
```
public RowMajorMatrixIterator rowMajorIterator()
```
    Description copied from class: Matrix
    
    Returns a row-major matrix iterator.
    
    Overrides:
    
    rowMajorIterator in class Matrix
    
    Returns:
    
    a row-major matrix iterator.
  - nonZeroRowMajorIterator
```
public RowMajorMatrixIterator nonZeroRowMajorIterator()
```
    Description copied from class: SparseMatrix
    
    Returns a non-zero row-major matrix iterator.
    
    Overrides:
    
    nonZeroRowMajorIterator in class SparseMatrix
    
    Returns:
    
    a non-zero row-major matrix iterator.
  - nonZeroIteratorOfRow
```
public VectorIterator nonZeroIteratorOfRow(int i)
```
    Description copied from class: SparseMatrix
    
    Returns a non-zero vector iterator of the given row i.
    
    Overrides:
    
    nonZeroIteratorOfRow in class SparseMatrix
    
    Returns:
    
    a non-zero vector iterator
  - iteratorOfRow
```
public VectorIterator iteratorOfRow(int i)
```
    Description copied from class: Matrix
    
    Returns a vector iterator of the given row {code i}.
    
    Overrides:
    
    iteratorOfRow in class Matrix
    
    Returns:
    
    a vector iterator
  - toBinary
```
public byte[] toBinary()
```
    Description copied from class: Matrix
    
    Encodes this matrix into a byte array.
    
    Specified by:
    
    toBinary in class Matrix
    
    Returns:
    
    a byte array representing this matrix

Class CRSMatrix

Field Summary

Fields inherited from class org.la4j.matrix.SparseMatrix

Fields inherited from class org.la4j.Matrix

Constructor Summary

Method Summary

Methods inherited from class org.la4j.matrix.RowMajorSparseMatrix

Methods inherited from class org.la4j.matrix.SparseMatrix

Methods inherited from class org.la4j.Matrix

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Field Detail

MATRIX_TAG

MINIMUM_SIZE

values

columnIndices

rowPointers

Constructor Detail

CRSMatrix

CRSMatrix

CRSMatrix

CRSMatrix

Method Detail

zero

zero

diagonal

identity

random

randomSymmetric

from1DArray

from2DArray

block

fromBinary

fromCSV

fromMatrixMarket

getOrElse

set

setAll

getRow

getColumn

copyOfShape

eachNonZero

each

eachInRow

eachNonZeroInRow

updateAt

nonZeroAt

searchForColumnIndex

insert

remove

growUp

align

max

min

maxInRow

minInRow

select

to

blankOfShape

iteratorOfNonZeroRows

rowMajorIterator

nonZeroRowMajorIterator

nonZeroIteratorOfRow

iteratorOfRow

toBinary