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

DSRing

@UnstableKMathAPI

open class DSRing<T, A : Ring<T>, NumericAlgebra<T>, ScaleOperations<T>>(algebra: A, order: Int, bindings: Map<Symbol, T>) : DSAlgebra<T, A> , Ring<DS<T, A>> , ScaleOperations<DS<T, A>> , NumericAlgebra<DS<T, A>> , NumbersAddOps<DS<T, A>> (source)

A ring over DS.

Parameters

bindings

The map of bindings values. All bindings are considered free parameters.

Inheritors

Constructors

constructor(algebra: A, order: Int, bindings: Map<Symbol, T>)

Functions

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

Absolute of the comparable value

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

Addition of two elements.

binaryOperation

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

Dynamically invokes a binary operation with the certain name.

binaryOperationFunction

open fun binaryOperationFunction(operation: String): (left: DS<T, A>, right: DS<T, A>) -> DS<T, A>

Dynamically dispatches a binary operation with the certain name.

open override fun bindSymbol(value: String): DSAlgebra.DSSymbol<T, A>

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

fun bindSymbol(symbol: Symbol): DSAlgebra.DSSymbol<T, A>

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

bindSymbolOrNull

fun bindSymbolOrNull(symbol: Symbol): DSAlgebra.DSSymbol<T, A>?

open override fun bindSymbolOrNull(value: String): DSAlgebra.DSSymbol<T, A>?

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

bindSymbolOrNull

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

open override fun const(value: T): DS<T, A>

A constant expression that does not depend on arguments.

fun DS<T, A>.derivative(vararg symbols: Symbol): T

fun DS<T, A>.derivative(symbols: List<Symbol>): T

open operator fun DS<T, A>.div(k: Number): DS<T, A>

Division of this element by scalar.

@UnstableKMathAPI

open fun export(arg: DS<T, A>): DS<T, A>

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.

open operator fun <T> Array<T>.get(symbol: Symbol): T

open operator fun DoubleArray.get(symbol: Symbol): Double

open operator fun <T> List<T>.get(symbol: Symbol): T

open operator fun <T> Point<T>.get(symbol: Symbol): T

open operator fun <T> Structure2D<T>.get(rowSymbol: Symbol, columnSymbol: Symbol): T

open fun indexOf(symbol: Symbol): Int

leftSideNumberOperation

open fun leftSideNumberOperation(operation: String, left: Number, right: DS<T, A>): DS<T, A>

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

leftSideNumberOperationFunction

open fun leftSideNumberOperationFunction(operation: String): (left: Number, right: DS<T, A>) -> DS<T, A>

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

open operator override fun Number.minus(other: DS<T, A>): DS<T, A>

Subtraction of number from element.

open operator fun DS<T, A>.minus(arg: DS<T, A>): DS<T, A>

Subtraction of two elements.

open operator fun DS<T, A>.minus(other: Number): DS<T, A>

Subtraction of element from number.

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

Multiplies two elements.

open override fun number(value: Number): DS<T, A>

Wraps a number to T object.

fun ofDerivatives(vararg derivatives: T): DS<T, A>

Build an instance from all its derivatives.

open operator override fun Number.plus(other: DS<T, A>): DS<T, A>

Addition of scalar and element.

open operator override fun DS<T, A>.plus(other: Number): DS<T, A>

Addition of element and scalar.

open operator fun DS<T, A>.plus(arg: DS<T, A>): DS<T, A>

Addition of two elements.

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

Raises arg to the integer power pow.

rightSideNumberOperation

open fun rightSideNumberOperation(operation: String, left: DS<T, A>, right: Number): DS<T, A>

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

rightSideNumberOperationFunction

open fun rightSideNumberOperationFunction(operation: String): (left: DS<T, A>, right: Number) -> DS<T, A>

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

open override fun scale(a: DS<T, A>, value: Double): DS<T, A>

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 DS<T, A>.times(arg: DS<T, A>): DS<T, A>

Multiplies this element by scalar.

open operator fun Number.times(arg: DS<T, A>): DS<T, A>

Multiplication of this number by element.

open operator fun DS<T, A>.times(k: Number): DS<T, A>

Multiplication of this element by a scalar.

open fun Map<Symbol, Double>.toDoubleArray(): DoubleArray

open fun <T> Map<Symbol, T>.toList(): List<T>

open fun DoubleArray.toMap(): Map<Symbol, Double>

open fun <T> Point<T>.toMap(): Map<Symbol, T>

open fun Map<Symbol, Double>.toPoint(): DoubleBuffer

open fun <T> Map<Symbol, T>.toPoint(bufferFactory: BufferFactory<T>): Point<T>

open operator override fun DS<T, A>.unaryMinus(): DS<T, A>

The negation of this element.

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

Dynamically invokes a unary operation with the certain name.

unaryOperationFunction

open fun unaryOperationFunction(operation: String): (arg: DS<T, A>) -> DS<T, A>

Dynamically dispatches a unary operation with the certain name.

open operator fun DS<T, A>.unaryPlus(): DS<T, A>

Returns this value.

fun variable(index: Int, value: T): DS<T, A>

Build an instance representing a variable.

Properties

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

Bind a symbol by name inside the ExpressionAlgebra

open val bufferFactory: MutableBufferFactory<DS<T, A>>

Provide a factory for buffers, associated with this Algebra

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

The e mathematical constant.

elementBufferFactory

val elementBufferFactory: MutableBufferFactory<T>

open override val one: DS<T, A>

The neutral element of multiplication

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

The π mathematical constant.

open override val symbols: List<Symbol>

open override val zero: DS<T, A>

The neutral element of addition.