DenseMatrix (la4j 0.6.0 API)

java.lang.Object
- org.la4j.Matrix
- - org.la4j.matrix.DenseMatrix

All Implemented Interfaces:

Iterable<Double>

Direct Known Subclasses:

Basic1DMatrix, Basic2DMatrix
```
public abstract class DenseMatrix
extends Matrix
```

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

Constructor Summary

Constructors
Constructor and Description

DenseMatrix(int rows, int columns)

Constructors
Constructor and Description
`DenseMatrix(int rows, int columns)`

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 DenseMatrix`	`block(Matrix a, Matrix b, Matrix c, Matrix d)` Creates a block `DenseMatrix` of the given blocks `a`, `b`, `c` and `d`.
`static DenseMatrix`	`constant(int rows, int columns, double constant)` Creates a constant `DenseMatrix` of the given shape and `value`.
`static DenseMatrix`	`diagonal(int size, double diagonal)` Creates a diagonal `DenseMatrix` of the given `size` whose diagonal elements are equal to `diagonal`.
`static DenseMatrix`	`from1DArray(int rows, int columns, double[] array)` Creates a `DenseMatrix` of the given 1D `array` w/o copying the underlying array.
`static DenseMatrix`	`from2DArray(double[][] array)` Creates a `DenseMatrix` of the given 2D `array` w/o copying the underlying array.
`static DenseMatrix`	`fromCSV(String csv)` Parses `DenseMatrix` from the given CSV string.
`static DenseMatrix`	`fromMatrixMarket(String mm)` Parses `DenseMatrix` from the given Matrix Market string.
`Vector`	`getColumn(int j)` Copies the specified column of this matrix into the vector.
`Vector`	`getRow(int i)` Copies the specified row of this matrix into the vector.
`static DenseMatrix`	`identity(int size)` Creates an identity `DenseMatrix` of the given `size`.
`static DenseMatrix`	`random(int rows, int columns, Random random)` Creates a random `DenseMatrix` of the given shape: `rows` x `columns`.
`static DenseMatrix`	`randomSymmetric(int size, Random random)` Creates a random symmetric `DenseMatrix` of the given `size`.
`abstract double[][]`	`toArray()` Converts this dense matrix to double array.
`String`	`toMatrixMarket(NumberFormat formatter)` Converts this matrix into the Matrix Market string using the given number `formatter`.
`static DenseMatrix`	`unit(int rows, int columns)` Creates an unit `DenseMatrix` of the given shape: `rows` x `columns`.
`static DenseMatrix`	`zero(int rows, int columns)` Creates a zero `DenseMatrix` of the given shape: `rows` x `columns`.

Methods inherited from class org.la4j.Matrix
add, add, blank, blankOfColumns, blankOfRows, blankOfShape, columnMajorIterator, columns, copy, copyOfColumns, copyOfRows, copyOfShape, determinant, diagonalProduct, divide, each, eachInColumn, eachInRow, ensureDimensionsAreCorrect, ensureIndexesAreInBounds, equals, equals, euclideanNorm, fail, fold, foldColumn, foldColumns, foldRow, foldRows, get, hadamardProduct, hashCode, infinityNorm, insert, insert, insert, insert, insertColumn, insertRow, is, is, iterator, iteratorOfColumn, iteratorOfRow, kroneckerProduct, manhattanNorm, max, maxInColumn, maxInRow, min, minInColumn, minInRow, mkString, mkString, mkString, multiply, multiply, multiply, multiplyByItsTranspose, non, non, norm, power, product, rank, removeColumn, removeFirstColumn, removeFirstRow, removeLastColumn, removeLastRow, removeRow, rotate, 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, transpose, update, updateAt, updateColumn, updateRow, withDecompositor, withInverter, withSolver

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

- Constructor Detail
  - DenseMatrix
```
public DenseMatrix(int rows,
           int columns)
```
- Method Detail
  - zero
```
public static DenseMatrix zero(int rows,
               int columns)
```
    Creates a zero DenseMatrix of the given shape: rows x columns.
  - constant
```
public static DenseMatrix constant(int rows,
                   int columns,
                   double constant)
```
    Creates a constant DenseMatrix of the given shape and value.
  - diagonal
```
public static DenseMatrix diagonal(int size,
                   double diagonal)
```
    Creates a diagonal DenseMatrix of the given size whose diagonal elements are equal to diagonal.
  - unit
```
public static DenseMatrix unit(int rows,
               int columns)
```
    Creates an unit DenseMatrix of the given shape: rows x columns.
  - identity
```
public static DenseMatrix identity(int size)
```
    Creates an identity DenseMatrix of the given size.
  - random
```
public static DenseMatrix random(int rows,
                 int columns,
                 Random random)
```
    Creates a random DenseMatrix of the given shape: rows x columns.
  - randomSymmetric
```
public static DenseMatrix randomSymmetric(int size,
                          Random random)
```
    Creates a random symmetric DenseMatrix of the given size.
  - from1DArray
```
public static DenseMatrix from1DArray(int rows,
                      int columns,
                      double[] array)
```
    Creates a DenseMatrix of the given 1D array w/o copying the underlying array.
  - from2DArray
```
public static DenseMatrix from2DArray(double[][] array)
```
    Creates a DenseMatrix of the given 2D array w/o copying the underlying array.
  - block
```
public static DenseMatrix block(Matrix a,
                Matrix b,
                Matrix c,
                Matrix d)
```
    Creates a block DenseMatrix of the given blocks a, b, c and d.
  - fromCSV
```
public static DenseMatrix fromCSV(String csv)
```
    Parses DenseMatrix from the given CSV string.
    
    Parameters:
    csv - the CSV string representing a matrix
    
    Returns:
    a parsed matrix
  - fromMatrixMarket
```
public static DenseMatrix fromMatrixMarket(String mm)
```
    Parses DenseMatrix from the given Matrix Market string.
    
    Parameters:
    mm - the string in Matrix Market format
    
    Returns:
    a parsed matrix
  - toArray
```
public abstract double[][] toArray()
```
    Converts this dense matrix to double array.
    
    Returns:
    an array representation of this matrix
  - getRow
```
public Vector getRow(int i)
```
    Description copied from class: Matrix
    
    Copies the specified row of this matrix into the vector.
    
    Specified by:
    
    getRow in class Matrix
    
    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.
    
    Specified by:
    
    getColumn in class Matrix
    
    Parameters:
    j - the column index
    
    Returns:
    the column represented as vector
  - 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
  - toMatrixMarket
```
public String toMatrixMarket(NumberFormat formatter)
```
    Description copied from class: Matrix
    
    Converts this matrix into the Matrix Market string using the given number formatter.
    
    Specified by:
    
    toMatrixMarket in class Matrix
    
    Returns:
    a string in Matrix Market format representing this matrix;

Class DenseMatrix

Field Summary

Fields inherited from class org.la4j.Matrix

Constructor Summary

Method Summary

Methods inherited from class org.la4j.Matrix

Methods inherited from class java.lang.Object

Constructor Detail

DenseMatrix

Method Detail

zero

constant

diagonal

unit

identity

random

randomSymmetric

from1DArray

from2DArray

block

fromCSV

fromMatrixMarket

toArray

getRow

getColumn

apply

apply

apply

toMatrixMarket