MatrixContext

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

Basic operations on matrices. Operates on Matrix.

Parameters

the type of items in the matrices.

the type of operated matrices.

Types

Companion

common

object Companion

Functions

add

common

abstract fun add(a: Matrix<T>, b: Matrix<T>): Matrix<T>

Addition of two elements.

binaryOperation

common

open fun binaryOperation(operation: String, left: Matrix<T>, right: Matrix<T>): Matrix<T>

Dynamically invokes a binary operation with the certain name.

binaryOperationFunction

common

open override fun binaryOperationFunction(operation: String): (Matrix<T>, Matrix<T>) -> M

Dynamically dispatches a binary operation with the certain name.

bindSymbol

common

open fun bindSymbol(value: String): Matrix<T>

Wraps a raw string to T object.

div

common

open operator fun Matrix<T>.div(k: Number): Matrix<T>

Division of this element by scalar.

dot

common

abstract infix fun Matrix<T>.dot(other: Matrix<T>): M

Computes the dot product of this matrix and another one.

abstract infix fun Matrix<T>.dot(vector: Point<T>): Point<T>

Computes the dot product of this matrix and a vector.

equals

common

open operator fun equals(other: Any?): Boolean

getFeature

common

open fun <F : Any> getFeature(m: Matrix<T>, type: KClass<F>): F?

Gets a feature from the matrix.

hashCode

common

open fun hashCode(): Int

minus

common

open operator fun Matrix<T>.minus(b: Matrix<T>): Matrix<T>

Subtraction of two elements.

multiply

common

abstract fun multiply(a: Matrix<T>, k: Number): Matrix<T>

Multiplication of element by scalar.

plus

common

open operator fun Matrix<T>.plus(b: Matrix<T>): Matrix<T>

Addition of two elements.

point

common

open fun point(size: Int, initializer: (Int) -> T): Point<T>

Produces a point compatible with matrix space (and possibly optimized for it).

produce

common

abstract fun produce(rows: Int, columns: Int, initializer: (i: Int, j: Int) -> T): M

Produces a matrix with this context and given dimensions.

times

common

open operator fun T.times(m: Matrix<T>): M

Multiplies an element by a matrix of it.

abstract operator fun Matrix<T>.times(value: T): M

Multiplies a matrix by its element.

open operator fun Number.times(b: Matrix<T>): Matrix<T>

Multiplication of this number by element.

open operator fun Matrix<T>.times(k: Number): Matrix<T>

Multiplication of this element by a scalar.

toString

common

open fun toString(): String

unaryMinus

common

open operator fun Matrix<T>.unaryMinus(): Matrix<T>

The negation of this element.

unaryOperation

common

open fun unaryOperation(operation: String, arg: Matrix<T>): Matrix<T>

Dynamically invokes an unary operation with the certain name.

unaryOperationFunction

common

open override fun unaryOperationFunction(operation: String): (Matrix<T>) -> Matrix<T>

Dynamically dispatches an unary operation with the certain name.

unaryPlus

common

open operator fun Matrix<T>.unaryPlus(): Matrix<T>

Returns this value.

Inheritors

GenericMatrixContext

RealMatrixContext

Extensions

getFeature

common

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

Gets a feature from the matrix.

lup

common

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.

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