kmath-core/space.kscience.kmath.expressions/FunctionalExpressionRing

FunctionalExpressionRing

open class FunctionalExpressionRing<T, out A : Ring<T>>(algebra: A) : FunctionalExpressionGroup<T, A> , Ring<Expression<T>> (source)

Inheritors

FunctionalExpressionField

Constructors

FunctionalExpressionRing

constructor(algebra: A)

Functions

fun <T : Comparable<T>> Group<T>.abs(value: T): T

Absolute of the comparable value

open override fun add(left: Expression<T>, right: Expression<T>): Expression<T>

Builds an Expression of addition of two another expressions.

binaryOperation

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

Dynamically invokes a binary operation with the certain name.

binaryOperationFunction

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

Dynamically dispatches a binary operation with the certain name.

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

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

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

bindSymbolOrNull

open override fun bindSymbolOrNull(value: String): Expression<T>?

Builds an Expression to access a variable.

bindSymbolOrNull

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

open override fun const(value: T): Expression<T>

Builds an Expression of constant expression that does not depend on arguments.

@UnstableKMathAPI

open fun export(arg: Expression<T>): Expression<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.

operator fun T.minus(arg: Expression<T>): Expression<T>

operator fun Expression<T>.minus(arg: T): Expression<T>

open operator fun Expression<T>.minus(arg: Expression<T>): Expression<T>

Subtraction of two elements.

open override fun multiply(left: Expression<T>, right: Expression<T>): Expression<T>

Builds an Expression of multiplication of two expressions.

operator fun T.plus(arg: Expression<T>): Expression<T>

operator fun Expression<T>.plus(arg: T): Expression<T>

open operator fun Expression<T>.plus(arg: Expression<T>): Expression<T>

Addition of two elements.

open fun power(arg: Expression<T>, pow: UInt): Expression<T>

Raises arg to the integer power pow.

fun <T> Group<T>.sum(data: Iterable<T>): T

@PerformancePitfall(message = "Potential boxing access to buffer elements")

fun <T> Group<T>.sum(data: Buffer<T>): T

Returns the sum of all elements in the iterable in this Group.

fun <T> Group<T>.sum(data: Sequence<T>): T

Returns the sum of all elements in the sequence in this Group.

operator fun T.times(arg: Expression<T>): Expression<T>

operator fun Expression<T>.times(arg: T): Expression<T>

open operator fun Expression<T>.times(arg: Expression<T>): Expression<T>

Multiplies this element by scalar.

open operator override fun Expression<T>.unaryMinus(): Expression<T>

The negation of this element.

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

Dynamically invokes a unary operation with the certain name.

unaryOperationFunction

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

Dynamically dispatches a unary operation with the certain name.

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

Returns this value.

Properties

val <T, E> ExpressionAlgebra<T, E>.binding: ReadOnlyProperty<Any?, E>

Bind a symbol by name inside the ExpressionAlgebra

open val bufferFactory: MutableBufferFactory<Expression<T>>

Provide a factory for buffers, associated with this Algebra

open override val one: Expression<T>

The neutral element of multiplication

open override val zero: Expression<T>

The neutral element of addition.