Matrices (la4j 0.6.0 API)

java.lang.Object
- org.la4j.Matrices

public final class Matrices
extends Object

Field Summary

Fields
Modifier and Type	Field and Description
`static MatrixFactory<Basic1DMatrix>`	`BASIC_1D` A matrix factory that produces zero `Basic1DMatrix`.
`static MatrixFactory<Basic2DMatrix>`	`BASIC_2D` A matrix factory that produces zero `Basic2DMatrix`.
`static MatrixFactory<CCSMatrix>`	`CCS` A matrix factory that produces zero `CCSMatrix`.
`static MatrixFactory<?>[]`	`CONVERTERS`
`static MatrixFactory<CRSMatrix>`	`CRS` A matrix factory that produces zero `CRSMatrix`.
`static MatrixFunction`	`DEC_FUNCTION` Decreases each element of matrix by `1`.
`static MatrixFactory<Basic2DMatrix>`	`DENSE` A default matrix factory for dense matrices.
`static MatrixPredicate`	`DIAGONAL_MATRIX` Checks whether the matrix is a diagonal matrix.
`static AdvancedMatrixPredicate`	`DIAGONALLY_DOMINANT_MATRIX` Checks whether the matrix is a diagonally dominant matrix.
`static double`	`EPS` The machine epsilon, that is calculated at runtime.
`static MatrixPredicate`	`IDENTITY_MATRIX` Checks whether the matrix is an identity matrix.
`static MatrixFunction`	`INC_FUNCTION` Increases each element of matrix by `1`.
`static MatrixFunction`	`INV_FUNCTION` Inverts each element of matrix.
`static MatrixPredicate`	`LOWER_BIDIAGONAL_MATRIX` Checks whether the matrix is a lower bi-diagonal matrix.
`static MatrixPredicate`	`LOWER_TRIANGULAR_MATRIX` Checks whether the matrix is a lower triangular matrix.
`static MatrixPredicate`	`NEGATIVE_MATRIX` Checks whether the matrix is a negative matrix.
`static AdvancedMatrixPredicate`	`POSITIVE_DEFINITE_MATRIX` Checks whether the matrix is positive definite.
`static MatrixPredicate`	`POSITIVE_MATRIX` Checks whether the matrix is a positive matrix.
`static int`	`ROUND_FACTOR` Exponent of machine epsilon
`static MatrixFactory<CRSMatrix>`	`SPARSE` A default factory for sparse matrices.
`static MatrixFactory<CCSMatrix>`	`SPARSE_COLUMN_MAJOR` A default factory for sparse column-major matrices.
`static MatrixFactory<CRSMatrix>`	`SPARSE_ROW_MAJOR` A default factory for sparse row-major matrices.
`static AdvancedMatrixPredicate`	`SYMMETRIC_MATRIX` Checks whether the matrix is a symmetric matrix.
`static MatrixPredicate`	`TRIDIAGONAL_MATRIX` Checks whether the matrix is a tridiagonal matrix.
`static MatrixPredicate`	`UPPER_BIDIAGONAL_MATRIX` Checks whether the matrix is an upper bidiagonal matrix.
`static MatrixPredicate`	`UPPER_TRIANGULAR_MATRIX` Checks whether the matrix is an upper triangular matrix.
`static MatrixPredicate`	`ZERO_MATRIX` Checks whether the matrix is a zero matrix.

Constructor Summary

Constructors
Constructor and Description

Matrices()

Constructors
Constructor and Description
`Matrices()`

Method Summary

Methods
Modifier and Type	Method and Description
`static MatrixProcedure`	`asAccumulatorProcedure(MatrixAccumulator accumulator)` Creates an accumulator procedure that adapts a matrix accumulator for procedure interface.
`static MatrixFunction`	`asConstFunction(double arg)` Creates a const function that evaluates it's argument to given `value`.
`static MatrixFunction`	`asDivFunction(double arg)` Creates a div function that divides it's argument by given `value`.
`static MatrixFunction`	`asMinusFunction(double arg)` Creates a minus function that subtracts given `value` from it's argument.
`static MatrixFunction`	`asModFunction(double arg)` Creates a mod function that calculates the modulus of it's argument and given `value`.
`static MatrixFunction`	`asMulFunction(double arg)` Creates a mul function that multiplies given `value` by it's argument.
`static MatrixFunction`	`asPlusFunction(double arg)` Creates a plus function that adds given `value` to it's argument.
`static MatrixAccumulator`	`asProductAccumulator(double neutral)` Creates a product matrix accumulator that calculates the product of all elements in the matrix.
`static MatrixAccumulator`	`asProductFunctionAccumulator(double neutral, MatrixFunction function)` Creates a product function accumulator, that calculates the product of all elements in the matrix after applying given `function` to each of them.
`static MatrixAccumulator`	`asSumAccumulator(double neutral)` Creates a sum matrix accumulator that calculates the sum of all elements in the matrix.
`static MatrixAccumulator`	`asSumFunctionAccumulator(double neutral, MatrixFunction function)` Creates a sum function accumulator, that calculates the sum of all elements in the matrix after applying given `function` to each of them.
`static MatrixAccumulator`	`mkEuclideanNormAccumulator()` Makes an Euclidean norm accumulator that allows to use `org.la4j.Matrix#fold(org.la4j.vector.functor.MatrixAccumulator)` method for norm calculation.
`static MatrixAccumulator`	`mkInfinityNormAccumulator()` Makes an Infinity norm accumulator that allows to use `org.la4j.Matrix#fold(org.la4j.vector.functor.MatrixAccumulator)` method for norm calculation.
`static MatrixAccumulator`	`mkManhattanNormAccumulator()` Makes an Manhattan norm accumulator that allows to use `org.la4j.Matrix#fold(org.la4j.vector.functor.MatrixAccumulator)` method for norm calculation.
`static MatrixAccumulator`	`mkMaxAccumulator()` Makes a maximum matrix accumulator that accumulates the maximum of matrix elements.
`static MatrixAccumulator`	`mkMinAccumulator()` Makes a minimum matrix accumulator that accumulates the minimum of matrix elements.

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

- Field Detail
  - EPS
```
public static final double EPS
```
    The machine epsilon, that is calculated at runtime.
  - ROUND_FACTOR
```
public static final int ROUND_FACTOR
```
    Exponent of machine epsilon
  - DIAGONAL_MATRIX
```
public static final MatrixPredicate DIAGONAL_MATRIX
```
    Checks whether the matrix is a diagonal matrix.
  - IDENTITY_MATRIX
```
public static final MatrixPredicate IDENTITY_MATRIX
```
    Checks whether the matrix is an identity matrix.
  - ZERO_MATRIX
```
public static final MatrixPredicate ZERO_MATRIX
```
    Checks whether the matrix is a zero matrix.
  - TRIDIAGONAL_MATRIX
```
public static final MatrixPredicate TRIDIAGONAL_MATRIX
```
    Checks whether the matrix is a tridiagonal matrix.
  - POSITIVE_MATRIX
```
public static final MatrixPredicate POSITIVE_MATRIX
```
    Checks whether the matrix is a positive matrix.
  - NEGATIVE_MATRIX
```
public static final MatrixPredicate NEGATIVE_MATRIX
```
    Checks whether the matrix is a negative matrix.
  - LOWER_BIDIAGONAL_MATRIX
```
public static final MatrixPredicate LOWER_BIDIAGONAL_MATRIX
```
    Checks whether the matrix is a lower bi-diagonal matrix.
  - UPPER_BIDIAGONAL_MATRIX
```
public static final MatrixPredicate UPPER_BIDIAGONAL_MATRIX
```
    Checks whether the matrix is an upper bidiagonal matrix.
  - LOWER_TRIANGULAR_MATRIX
```
public static final MatrixPredicate LOWER_TRIANGULAR_MATRIX
```
    Checks whether the matrix is a lower triangular matrix.
  - UPPER_TRIANGULAR_MATRIX
```
public static final MatrixPredicate UPPER_TRIANGULAR_MATRIX
```
    Checks whether the matrix is an upper triangular matrix.
  - SYMMETRIC_MATRIX
```
public static final AdvancedMatrixPredicate SYMMETRIC_MATRIX
```
    Checks whether the matrix is a symmetric matrix.
  - DIAGONALLY_DOMINANT_MATRIX
```
public static final AdvancedMatrixPredicate DIAGONALLY_DOMINANT_MATRIX
```
    Checks whether the matrix is a diagonally dominant matrix.
  - POSITIVE_DEFINITE_MATRIX
```
public static final AdvancedMatrixPredicate POSITIVE_DEFINITE_MATRIX
```
    Checks whether the matrix is positive definite.
  - BASIC_2D
```
public static final MatrixFactory<Basic2DMatrix> BASIC_2D
```
    A matrix factory that produces zero Basic2DMatrix.
  - BASIC_1D
```
public static final MatrixFactory<Basic1DMatrix> BASIC_1D
```
    A matrix factory that produces zero Basic1DMatrix.
  - DENSE
```
public static final MatrixFactory<Basic2DMatrix> DENSE
```
    A default matrix factory for dense matrices.
  - CCS
```
public static final MatrixFactory<CCSMatrix> CCS
```
    A matrix factory that produces zero CCSMatrix.
  - CRS
```
public static final MatrixFactory<CRSMatrix> CRS
```
    A matrix factory that produces zero CRSMatrix.
  - SPARSE
```
public static final MatrixFactory<CRSMatrix> SPARSE
```
    A default factory for sparse matrices.
  - SPARSE_ROW_MAJOR
```
public static final MatrixFactory<CRSMatrix> SPARSE_ROW_MAJOR
```
    A default factory for sparse row-major matrices.
  - SPARSE_COLUMN_MAJOR
```
public static final MatrixFactory<CCSMatrix> SPARSE_COLUMN_MAJOR
```
    A default factory for sparse column-major matrices.
  - CONVERTERS
```
public static final MatrixFactory<?>[] CONVERTERS
```
  - INC_FUNCTION
```
public static final MatrixFunction INC_FUNCTION
```
    Increases each element of matrix by 1.
  - DEC_FUNCTION
```
public static final MatrixFunction DEC_FUNCTION
```
    Decreases each element of matrix by 1.
  - INV_FUNCTION
```
public static final MatrixFunction INV_FUNCTION
```
    Inverts each element of matrix.
- Constructor Detail
  - Matrices
```
public Matrices()
```
- Method Detail
  - asConstFunction
```
public static MatrixFunction asConstFunction(double arg)
```
    Creates a const function that evaluates it's argument to given value.
    
    Parameters:
    arg - a const value
    
    Returns:
    a closure object that does _
  - asPlusFunction
```
public static MatrixFunction asPlusFunction(double arg)
```
    Creates a plus function that adds given value to it's argument.
    
    Parameters:
    arg - a value to be added to function's argument
    
    Returns:
    a closure object that does _ + _
  - asMinusFunction
```
public static MatrixFunction asMinusFunction(double arg)
```
    Creates a minus function that subtracts given value from it's argument.
    
    Parameters:
    arg - a value to be subtracted from function's argument
    
    Returns:
    a closure that does _ - _
  - asMulFunction
```
public static MatrixFunction asMulFunction(double arg)
```
    Creates a mul function that multiplies given value by it's argument.
    
    Parameters:
    arg - a value to be multiplied by function's argument
    
    Returns:
    a closure that does _ * _
  - asDivFunction
```
public static MatrixFunction asDivFunction(double arg)
```
    Creates a div function that divides it's argument by given value.
    
    Parameters:
    arg - a divisor value
    
    Returns:
    a closure that does _ / _
  - asModFunction
```
public static MatrixFunction asModFunction(double arg)
```
    Creates a mod function that calculates the modulus of it's argument and given value.
    
    Parameters:
    arg - a divisor value
    
    Returns:
    a closure that does _ % _
  - mkMinAccumulator
```
public static MatrixAccumulator mkMinAccumulator()
```
    Makes a minimum matrix accumulator that accumulates the minimum of matrix elements.
    
    Returns:
    a minimum vector accumulator
  - mkMaxAccumulator
```
public static MatrixAccumulator mkMaxAccumulator()
```
    Makes a maximum matrix accumulator that accumulates the maximum of matrix elements.
    
    Returns:
    a maximum vector accumulator
  - mkEuclideanNormAccumulator
```
public static MatrixAccumulator mkEuclideanNormAccumulator()
```
    Makes an Euclidean norm accumulator that allows to use org.la4j.Matrix#fold(org.la4j.vector.functor.MatrixAccumulator) method for norm calculation.
    
    Returns:
    an Euclidean norm accumulator
  - mkManhattanNormAccumulator
```
public static MatrixAccumulator mkManhattanNormAccumulator()
```
    Makes an Manhattan norm accumulator that allows to use org.la4j.Matrix#fold(org.la4j.vector.functor.MatrixAccumulator) method for norm calculation.
    
    Returns:
    a Manhattan norm accumulator
  - mkInfinityNormAccumulator
```
public static MatrixAccumulator mkInfinityNormAccumulator()
```
    Makes an Infinity norm accumulator that allows to use org.la4j.Matrix#fold(org.la4j.vector.functor.MatrixAccumulator) method for norm calculation.
    
    Returns:
    an Infinity norm accumulator
  - asSumAccumulator
```
public static MatrixAccumulator asSumAccumulator(double neutral)
```
    Creates a sum matrix accumulator that calculates the sum of all elements in the matrix.
    
    Parameters:
    neutral - the neutral value
    
    Returns:
    a sum accumulator
  - asProductAccumulator
```
public static MatrixAccumulator asProductAccumulator(double neutral)
```
    Creates a product matrix accumulator that calculates the product of all elements in the matrix.
    
    Parameters:
    neutral - the neutral value
    
    Returns:
    a product accumulator
  - asSumFunctionAccumulator
```
public static MatrixAccumulator asSumFunctionAccumulator(double neutral,
                                         MatrixFunction function)
```
    Creates a sum function accumulator, that calculates the sum of all elements in the matrix after applying given function to each of them.
    
    Parameters:
    neutral - the neutral value
    function - the matrix function
    
    Returns:
    a sum function accumulator
  - asProductFunctionAccumulator
```
public static MatrixAccumulator asProductFunctionAccumulator(double neutral,
                                             MatrixFunction function)
```
    Creates a product function accumulator, that calculates the product of all elements in the matrix after applying given function to each of them.
    
    Parameters:
    neutral - the neutral value
    function - the matrix function
    
    Returns:
    a product function accumulator
  - asAccumulatorProcedure
```
public static MatrixProcedure asAccumulatorProcedure(MatrixAccumulator accumulator)
```
    Creates an accumulator procedure that adapts a matrix accumulator for procedure interface. This is useful for reusing a single accumulator for multiple fold operations in multiple matrices.
    
    Parameters:
    accumulator - the matrix accumulator
    
    Returns:
    an accumulator procedure

Class Matrices

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

EPS

ROUND_FACTOR

DIAGONAL_MATRIX

IDENTITY_MATRIX

ZERO_MATRIX

TRIDIAGONAL_MATRIX

POSITIVE_MATRIX

NEGATIVE_MATRIX

LOWER_BIDIAGONAL_MATRIX

UPPER_BIDIAGONAL_MATRIX

LOWER_TRIANGULAR_MATRIX

UPPER_TRIANGULAR_MATRIX

SYMMETRIC_MATRIX

DIAGONALLY_DOMINANT_MATRIX

POSITIVE_DEFINITE_MATRIX

BASIC_2D

BASIC_1D

DENSE

CCS

CRS

SPARSE

SPARSE_ROW_MAJOR

SPARSE_COLUMN_MAJOR

CONVERTERS

INC_FUNCTION

DEC_FUNCTION

INV_FUNCTION

Constructor Detail

Matrices

Method Detail

asConstFunction

asPlusFunction

asMinusFunction

asMulFunction

asDivFunction

asModFunction

mkMinAccumulator

mkMaxAccumulator

mkEuclideanNormAccumulator

mkManhattanNormAccumulator

mkInfinityNormAccumulator

asSumAccumulator

asProductAccumulator

asSumFunctionAccumulator

asProductFunctionAccumulator

asAccumulatorProcedure