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

NumbersAddOps

@UnstableKMathAPI

interface NumbersAddOps<T> : RingOps<T> , NumericAlgebra<T>

A combination of NumericAlgebra and Ring that adds intrinsic simple operations on numbers like T+1 TODO to be removed and replaced by extensions after multiple receivers are there

Functions

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): (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 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.

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

Subtraction of two elements.

open operator fun T.minus(other: Number): T

Subtraction of element from number.

open operator fun Number.minus(other: T): T

Subtraction of number from element.

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

Multiplies two elements.

abstract fun number(value: Number): T

Wraps a number to T object.

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

Addition of two elements.

open operator fun T.plus(other: Number): T

Addition of element and scalar.

open operator fun Number.plus(other: T): T

Addition of scalar and element.

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 operator fun T.times(arg: T): T

Multiplies this element by scalar.

abstract operator fun T.unaryMinus(): T

The negation of this element.

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

Dynamically invokes a unary operation with the certain name.

unaryOperationFunction

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

Dynamically dispatches a unary operation with the certain name.

open operator fun T.unaryPlus(): T

Returns this value.

Inheritors

SimpleAutoDiffField

Sources