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

FieldOps

interface FieldOps<T> : RingOps<T> (source)

Represents field without multiplicative and additive identities i.e., algebraic structure with associative, binary, commutative operations add and multiply; binary operation divide as multiplication of left operand by reciprocal of right one.

Parameters

the type of element of this semifield.

Inheritors

Types

Companion

object Companion

Functions

add

abstract fun add(left: T, right: T): T

Addition of two elements.

binaryOperation

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

Dynamically invokes a binary operation with the certain name.

binaryOperationFunction

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

Dynamically dispatches a binary operation with the certain name.

bindSymbol

open fun bindSymbol(value: String): T

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

bindSymbol

fun <T> Algebra<T>.bindSymbol(symbol: Symbol): T

bindSymbolOrNull

open fun bindSymbolOrNull(value: String): T?

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

bindSymbolOrNull

fun <T> Algebra<T>.bindSymbolOrNull(symbol: Symbol): T?

div

open operator fun T.div(arg: T): T

Division of two elements.

divide

abstract fun divide(left: T, right: T): T

Division of two elements.

export

@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.

minus