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

MstRing

object MstRing : Ring<MST> , NumbersAddOps<MST> , ScaleOperations<MST> (source)

Ring over MST nodes.

Functions

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

Absolute of the comparable value

open override fun add(left: MST, right: MST): MST.Binary

Addition of two elements.

binaryOperation

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

Dynamically invokes a binary operation with the certain name.

binaryOperationFunction

open override fun binaryOperationFunction(operation: String): (left: MST, right: MST) -> MST.Binary

Dynamically dispatches a binary operation with the certain name.

open fun bindSymbol(value: String): MST

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): Symbol

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

bindSymbolOrNull

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

open operator fun MST.div(k: Number): MST

Division of this element by scalar.

@UnstableKMathAPI

open fun export(arg: MST): MST

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: MST): MST

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

leftSideNumberOperationFunction

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

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

open operator override fun MST.minus(arg: MST): MST.Binary

Subtraction of two elements.

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

Subtraction of number from element.

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

Subtraction of element from number.

open override fun multiply(left: MST, right: MST): MST.Binary

Multiplies two elements.

open override fun number(value: Number): MST.Numeric

Wraps a number to T object.

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

Addition of two elements.

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

Addition of scalar and element.

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

Addition of element and scalar.

open fun power(arg: MST, pow: UInt): MST

Raises arg to the integer power pow.

rightSideNumberOperation

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

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

rightSideNumberOperationFunction

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

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

open override fun scale(a: MST, value: Double): MST.Binary

Scaling an element by a scalar.

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.

open operator fun MST.times(arg: MST): MST

Multiplies this element by scalar.

open operator fun Number.times(arg: MST): MST

Multiplication of this number by element.

open operator fun MST.times(k: Number): MST

Multiplication of this element by a scalar.

open operator override fun MST.unaryMinus(): MST.Unary

The negation of this element.

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

Dynamically invokes a unary operation with the certain name.

unaryOperationFunction

open override fun unaryOperationFunction(operation: String): (arg: MST) -> MST.Unary

Dynamically dispatches a unary operation with the certain name.

open operator override fun MST.unaryPlus(): MST.Unary

Returns this value.

Properties

open val bufferFactory: MutableBufferFactory<MST>

Provide a factory for buffers, associated with this Algebra

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

The e mathematical constant.

open override val one: MST.Numeric

The neutral element of multiplication

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

The π mathematical constant.

open override val zero: MST.Numeric

The neutral element of addition.