kmath-core/space.kscience.kmath.operations/NumericAlgebra

NumericAlgebra

interface NumericAlgebra<T> : Algebra<T>

An algebraic structure where elements can have numeric representation.

Parameters

T

the type of element of this structure.

Functions

binaryOperation

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

Dynamically invokes a binary operation with the certain name.

binaryOperationFunction

open fun binaryOperationFunction(operation: String): (T, T) -> T

Dynamically dispatches a binary operation with the certain name.

open fun bindSymbol(value: String): T

The same as bindSymbolOrNull but throws an error if symbol could not be bound

bindSymbolOrNull

open override fun bindSymbolOrNull(value: String): T?

Wraps a raw string to T object. This method is designed for three purposes:

@UnstableKMathAPI

open fun export(arg: T): T

Export an algebra element, so it could be accessed even after algebra scope is closed. This method must be used on algebras where data is stored externally or any local algebra state is used. By default (if not overridden), exports the object itself.

leftSideNumberOperation

open fun leftSideNumberOperation(operation: String, left: Number, right: T): T

Dynamically invokes a binary operation with the certain name with numeric first argument.

leftSideNumberOperationFunction

open fun leftSideNumberOperationFunction(operation: String): (left: Number, T) -> T

Dynamically dispatches a binary operation with the certain name with numeric first argument.

abstract fun number(value: Number): T

Wraps a number to T object.

rightSideNumberOperation

open fun rightSideNumberOperation(operation: String, left: T, right: Number): T

Dynamically invokes a binary operation with the certain name with numeric second argument.

rightSideNumberOperationFunction

open fun rightSideNumberOperationFunction(operation: String): (T, right: Number) -> T

Dynamically dispatches a binary operation with the certain name with numeric first argument.

open fun unaryOperation(operation: String, arg: T): T

Dynamically invokes a unary operation with the certain name.

unaryOperationFunction

open fun unaryOperationFunction(operation: String): (T) -> T

Dynamically dispatches a unary operation with the certain name.

Inheritors

MstNumericAlgebra

MstExtendedField

JBigIntegerField

JBigDecimalFieldBase

Extensions

val <T> NumericAlgebra<T>.e: T

The e mathematical constant.

val <T> NumericAlgebra<T>.pi: T

The π mathematical constant.

Sources