ColumnMajorSparseMatrix (la4j 0.6.0 API)

java.lang.Object
- org.la4j.Matrix
- - org.la4j.matrix.SparseMatrix
  - - org.la4j.matrix.ColumnMajorSparseMatrix

All Implemented Interfaces:

Iterable<Double>

Direct Known Subclasses:

CCSMatrix
```
public abstract class ColumnMajorSparseMatrix
extends SparseMatrix
```

Field Summary
- Fields inherited from class org.la4j.matrix.SparseMatrix
  cardinality
- Fields inherited from class org.la4j.Matrix
  columns, rows

Constructor Summary

Constructors
Constructor and Description
`ColumnMajorSparseMatrix(int rows, int columns)`
`ColumnMajorSparseMatrix(int rows, int columns, int cardinality)`

Method Summary

Methods
Modifier and Type	Method and Description
`<T> T`	`apply(MatrixMatrixOperation<T> operation, Matrix that)` Pipes this matrix to a given `operation`.
`<T> T`	`apply(MatrixOperation<T> operation)` Pipes this matrix to a given `operation`.
`<T> T`	`apply(MatrixVectorOperation<T> operation, Vector that)` Pipes this matrix to a given `operation`.
`static ColumnMajorSparseMatrix`	`block(Matrix a, Matrix b, Matrix c, Matrix d)` Creates a block `ColumnMajorSparseMatrix` of the given blocks `a`, `b`, `c` and `d`.
`static ColumnMajorSparseMatrix`	`diagonal(int size, double diagonal)` Creates a diagonal `ColumnMajorSparseMatrix` of the given `size` whose diagonal elements are equal to `diagonal`.
`static ColumnMajorSparseMatrix`	`from1DArray(int rows, int columns, double[] array)` Creates a new `ColumnMajorSparseMatrix` from the given 1D `array` with compressing (copying) the underlying array.
`static ColumnMajorSparseMatrix`	`from2DArray(double[][] array)` Creates a new `ColumnMajorSparseMatrix` from the given 2D `array` with compressing (copying) the underlying array.
`static ColumnMajorSparseMatrix`	`fromCSV(String csv)` Parses `ColumnMajorSparseMatrix` from the given CSV string.
`static ColumnMajorSparseMatrix`	`fromMatrixMarket(String mm)` Parses `ColumnMajorSparseMatrix` from the given Matrix Market string.
`static ColumnMajorSparseMatrix`	`identity(int size)` Creates an identity `ColumnMajorSparseMatrix` of the given `size`.
`boolean`	`isRowMajor()` Checks whether or not this sparse matrix row-major.
`ColumnMajorMatrixIterator`	`iterator()` Returns a matrix iterator.
`abstract Iterator<Integer>`	`iteratorOrNonZeroColumns()`
`MatrixIterator`	`nonZeroIterator()` Returns a non-zero matrix iterator.
`static ColumnMajorSparseMatrix`	`random(int rows, int columns, double density, Random random)` Creates a random `ColumnMajorSparseMatrix` of the given shape: `rows` x `columns`.
`static ColumnMajorSparseMatrix`	`randomSymmetric(int size, double density, Random random)` Creates a random symmetric `ColumnMajorSparseMatrix` of the given `size`.
`Matrix`	`rotate()` Rotates this matrix by 90 degrees to the right.
`Matrix`	`transpose()` Transposes this matrix.
`static ColumnMajorSparseMatrix`	`zero(int rows, int columns)` Creates a zero `ColumnMajorSparseMatrix` of the given shape: `rows` x `columns`.
`static ColumnMajorSparseMatrix`	`zero(int rows, int columns, int capacity)` Creates a zero `ColumnMajorSparseMatrix` of the given shape: `rows` x `columns` with the given `capacity`.

Methods inherited from class org.la4j.matrix.SparseMatrix
add, capacity, cardinality, density, eachNonZero, eachNonZeroInColumn, eachNonZeroInRow, ensureCardinalityIsCorrect, foldNonZero, foldNonZeroInColumn, foldNonZeroInColumns, foldNonZeroInRow, foldNonZeroInRows, get, getColumn, getOrElse, getRow, isColumnMajor, isZeroAt, multiply, nonZeroAt, nonZeroColumnMajorIterator, nonZeroIteratorOfColumn, nonZeroIteratorOfRow, nonZeroRowMajorIterator, toMatrixMarket

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

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

- Constructor Detail
  - ColumnMajorSparseMatrix
```
public ColumnMajorSparseMatrix(int rows,
                       int columns)
```
  - ColumnMajorSparseMatrix
```
public ColumnMajorSparseMatrix(int rows,
                       int columns,
                       int cardinality)
```
- Method Detail
  - zero
```
public static ColumnMajorSparseMatrix zero(int rows,
                           int columns)
```
    Creates a zero ColumnMajorSparseMatrix of the given shape: rows x columns.
  - zero
```
public static ColumnMajorSparseMatrix zero(int rows,
                           int columns,
                           int capacity)
```
    Creates a zero ColumnMajorSparseMatrix of the given shape: rows x columns with the given capacity.
  - diagonal
```
public static ColumnMajorSparseMatrix diagonal(int size,
                               double diagonal)
```
    Creates a diagonal ColumnMajorSparseMatrix of the given size whose diagonal elements are equal to diagonal.
  - identity
```
public static ColumnMajorSparseMatrix identity(int size)
```
    Creates an identity ColumnMajorSparseMatrix of the given size.
  - random
```
public static ColumnMajorSparseMatrix random(int rows,
                             int columns,
                             double density,
                             Random random)
```
    Creates a random ColumnMajorSparseMatrix of the given shape: rows x columns.
  - randomSymmetric
```
public static ColumnMajorSparseMatrix randomSymmetric(int size,
                                      double density,
                                      Random random)
```
    Creates a random symmetric ColumnMajorSparseMatrix of the given size.
  - from1DArray
```
public static ColumnMajorSparseMatrix from1DArray(int rows,
                                  int columns,
                                  double[] array)
```
    Creates a new ColumnMajorSparseMatrix from the given 1D array with compressing (copying) the underlying array.
  - from2DArray
```
public static ColumnMajorSparseMatrix from2DArray(double[][] array)
```
    Creates a new ColumnMajorSparseMatrix from the given 2D array with compressing (copying) the underlying array.
  - block
```
public static ColumnMajorSparseMatrix block(Matrix a,
                            Matrix b,
                            Matrix c,
                            Matrix d)
```
    Creates a block ColumnMajorSparseMatrix of the given blocks a, b, c and d.
  - fromCSV
```
public static ColumnMajorSparseMatrix fromCSV(String csv)
```
    Parses ColumnMajorSparseMatrix from the given CSV string.
    
    Parameters:
    csv - the CSV string representing a matrix
    
    Returns:
    a parsed matrix
  - fromMatrixMarket
```
public static ColumnMajorSparseMatrix fromMatrixMarket(String mm)
```
    Parses ColumnMajorSparseMatrix from the given Matrix Market string.
    
    Parameters:
    mm - the string in Matrix Market format
    
    Returns:
    a parsed matrix
  - isRowMajor
```
public boolean isRowMajor()
```
    Description copied from class: SparseMatrix
    
    Checks whether or not this sparse matrix row-major.
    
    Specified by:
    
    isRowMajor in class SparseMatrix
  - transpose
```
public Matrix transpose()
```
    Description copied from class: Matrix
    
    Transposes this matrix.
    
    Overrides:
    
    transpose in class Matrix
    
    Returns:
    the transposed matrix
  - rotate
```
public Matrix rotate()
```
    Description copied from class: Matrix
    
    Rotates this matrix by 90 degrees to the right.
    
    Overrides:
    
    rotate in class Matrix
    
    Returns:
    the rotated matrix
  - iterator
```
public ColumnMajorMatrixIterator iterator()
```
    Description copied from class: Matrix
    
    Returns a matrix iterator.
    
    Specified by:
    
    iterator in interface Iterable<Double>
    
    Overrides:
    
    iterator in class Matrix
    
    Returns:
    a matrix iterator
  - nonZeroIterator
```
public MatrixIterator nonZeroIterator()
```
    Description copied from class: SparseMatrix
    
    Returns a non-zero matrix iterator.
    
    Overrides:
    
    nonZeroIterator in class SparseMatrix
    
    Returns:
    a non-zero matrix iterator
  - iteratorOrNonZeroColumns
```
public abstract Iterator<Integer> iteratorOrNonZeroColumns()
```
  - apply
```
public <T> T apply(MatrixOperation<T> operation)
```
    Description copied from class: Matrix
    
    Pipes this matrix to a given operation.
    
    Specified by:
    
    apply in class Matrix
    
    Type Parameters:
    T - the result type
    Parameters:
    operation - the matrix operation (an operation that takes a matrix and returns T)
    
    Returns:
    the result of an operation applied to this matrix
  - apply
```
public <T> T apply(MatrixMatrixOperation<T> operation,
          Matrix that)
```
    Description copied from class: Matrix
    
    Pipes this matrix to a given operation.
    
    Specified by:
    
    apply in class Matrix
    
    Type Parameters:
    T - the result type
    Parameters:
    operation - the matrix-matrix operation (an operation that takes two matrices and returns T)
    that - the right hand matrix of the given operation
    
    Returns:
    the result of an operation applied to this matrix
  - apply
```
public <T> T apply(MatrixVectorOperation<T> operation,
          Vector that)
```
    Description copied from class: Matrix
    
    Pipes this matrix to a given operation.
    
    Specified by:
    
    apply in class Matrix
    
    Type Parameters:
    T - the result type
    Parameters:
    operation - the matrix-vector operation (an operation that takes matrix and vector and returns T)
    that - the right hand vector of the given operation
    
    Returns:
    the result of an operation applied to this matrix

Class ColumnMajorSparseMatrix

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.SparseMatrix

Methods inherited from class org.la4j.Matrix

Methods inherited from class java.lang.Object

Constructor Detail

ColumnMajorSparseMatrix

ColumnMajorSparseMatrix

Method Detail

zero

zero

diagonal

identity

random

randomSymmetric

from1DArray

from2DArray

block

fromCSV

fromMatrixMarket

isRowMajor

transpose

rotate

iterator

nonZeroIterator

iteratorOrNonZeroColumns

apply

apply

apply