Package space.kscience.kmath.linear

Types

BufferMatrix

common

class BufferMatrix<T : Any>(rowNum: Int, colNum: Int, buffer: Buffer<T>) : Structure2D<T>

BufferMatrixContext

common

class BufferMatrixContext<T : Any, R : Ring<T>>(elementContext: R, bufferFactory: BufferFactory<T>) : GenericMatrixContext<T, R, BufferMatrix<T>>

Basic implementation of Matrix space based on NDStructure

BufferVectorSpace

common

class BufferVectorSpace<T : Any, S : Space<T>>(size: Int, space: S, bufferFactory: BufferFactory<T>) : VectorSpace<T, S>

CholeskyDecompositionFeature

common

interface CholeskyDecompositionFeature<T : Any> : MatrixFeature

Matrices with this feature support Cholesky factorization: a = l · lH where a is the owning matrix.

DeterminantFeature

common

interface DeterminantFeature<T : Any> : MatrixFeature

Matrices with this feature can compute their determinant.

DiagonalFeature

common

interface DiagonalFeature : MatrixFeature

Matrices with this feature are considered to have only diagonal non-null elements.

GenericMatrixContext

common

interface GenericMatrixContext<T : Any, R : Ring<T>, out M : Matrix<T>> : MatrixContext<T, M>

Partial implementation of MatrixContext for matrices of Ring.

InverseMatrixFeature

common

interface InverseMatrixFeature<T : Any> : MatrixFeature

Matrices with this feature can be inverted: inverse = a-1 where a is the owning matrix.

LFeature

common

object LFeature : MatrixFeature

Matrices with this feature are lower triangular ones.

LinearSolver

common

interface LinearSolver<T : Any>

A group of methods to resolve equation A dot X = B, where A and B are matrices or vectors

LupDecomposition

common

class LupDecomposition<T : Any>(context: MatrixContext<T, Matrix<T>>, elementContext: Field<T>, lu: Matrix<T>, pivot: IntArray, even: Boolean) : LupDecompositionFeature<T> , DeterminantFeature<T>

Common implementation of LupDecompositionFeature.

LupDecompositionFeature

common

interface LupDecompositionFeature<T : Any> : MatrixFeature

Matrices with this feature support LU factorization with partial pivoting: p · a = l · u where a is the owning matrix.

Matrix

common

typealias Matrix<T> = Structure2D<T>

Alias for Structure2D with more familiar name.

MatrixBuilder

common

class MatrixBuilder(rows: Int, columns: Int)

MatrixContext

common

interface MatrixContext<T : Any, out M : Matrix<T>> : SpaceOperations<Matrix<T>>

Basic operations on matrices.

MatrixFeature

common

interface MatrixFeature

A marker interface representing some properties of matrices or additional transformations of them.

MatrixWrapper

common

class MatrixWrapper<T : Any> : Structure2D<T>

A Matrix that holds MatrixFeature objects.

OrthogonalFeature

common

object OrthogonalFeature : MatrixFeature

Matrices with this feature are orthogonal ones: a · aT = u where a is the owning matrix, u is the unit matrix (UnitFeature).

Point

common

typealias Point<T> = Buffer<T>

QRDecompositionFeature

common

interface QRDecompositionFeature<T : Any> : MatrixFeature

Matrices with this feature support QR factorization: a = q · r where a is the owning matrix.

RealMatrixContext

common

object RealMatrixContext : MatrixContext<Double, BufferMatrix<Double>>

SingularValueDecompositionFeature

common

interface SingularValueDecompositionFeature<T : Any> : MatrixFeature

Matrices with this feature support SVD: a = u · s · vH where a is the owning matrix.

TransposedFeature

common

class TransposedFeature<T : Any>(original: Matrix<T>) : MatrixFeature

UFeature

common

object UFeature : MatrixFeature

Matrices with this feature are upper triangular ones.

UnitFeature

common

object UnitFeature : DiagonalFeature

Matrices with this feature have unit elements on diagonal and zero elements in all other places.

VectorSpace

common

interface VectorSpace<T : Any, S : Space<T>> : Space<Point<T>>

A linear space for vectors.

VirtualMatrix

common

class VirtualMatrix<T : Any>(rowNum: Int, colNum: Int, generator: (i: Int, j: Int) -> T) : Structure2D<T>

The matrix where each element is evaluated each time when is being accessed.

ZeroFeature

common

object ZeroFeature : DiagonalFeature

Matrices with this feature have all zero elements.

Functions

asMatrix

common

fun <T : Any> Point<T>.asMatrix(): VirtualMatrix<T>

asPoint

common

fun <T : Any> Matrix<T>.asPoint(): Point<T>

Convert matrix to vector if it is possible

build

common

fun Structure2D.Companion.build(rows: Int, columns: Int): MatrixBuilder

column

common

fun <T : Any> Structure2D.Companion.column(vararg values: T): Matrix<T>

inline fun <T : Any> Structure2D.Companion.column(size: Int, factory: BufferFactory<T> = Buffer.Companion::auto, noinline builder: (Int) -> T): Matrix<T>

DeterminantFeature

common

fun <T : Any> DeterminantFeature(determinant: T): DeterminantFeature<T>

Produces a DeterminantFeature where the DeterminantFeature.determinant is determinant.

getFeature

common

inline fun <T : Any, F : Any> MatrixContext<T, *>.getFeature(m: Matrix<T>): F?

Gets a feature from the matrix.

inverseWithLup

common

fun RealMatrixContext.inverseWithLup(matrix: Matrix<Double>): Matrix<Double>

Inverses a square matrix using LUP decomposition.

inline fun <T : Comparable<T>, F : Field<T>> GenericMatrixContext<T, F, Matrix<T>>.inverseWithLup(matrix: Matrix<T>, noinline bufferFactory: MutableBufferFactory<T> = MutableBuffer.Companion::auto, noinline checkSingular: (T) -> Boolean): Matrix<T>

lup

common

fun MatrixContext<Double, Matrix<Double>>.lup(matrix: Matrix<Double>): LupDecomposition<Double>

inline fun <T : Comparable<T>, F : Field<T>> GenericMatrixContext<T, F, Matrix<T>>.lup(matrix: Matrix<T>, noinline checkSingular: (T) -> Boolean): LupDecomposition<T>

fun <T : Comparable<T>> MatrixContext<T, Matrix<T>>.lup(factory: MutableBufferFactory<T>, elementContext: Field<T>, matrix: Matrix<T>, checkSingular: (T) -> Boolean): LupDecomposition<T>

Create a lup decomposition of generic matrix.

one

common

fun <T : Any, R : Ring<T>> GenericMatrixContext<T, R, *>.one(rows: Int, columns: Int): Matrix<T>

Diagonal matrix of ones.

plus

common

operator fun <T : Any> Matrix<T>.plus(newFeatures: Collection<MatrixFeature>): MatrixWrapper<T>

Add a collection of features to a Matrix

operator fun <T : Any> Matrix<T>.plus(newFeature: MatrixFeature): MatrixWrapper<T>

Add a single feature to a Matrix

row

common

fun <T : Any> Structure2D.Companion.row(vararg values: T): Matrix<T>

inline fun <T : Any> Structure2D.Companion.row(size: Int, factory: BufferFactory<T> = Buffer.Companion::auto, noinline builder: (Int) -> T): Matrix<T>

solveWithLup

common