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

DSAlgebra

@UnstableKMathAPI

abstract class DSAlgebra<T, A : Ring<T>>(val algebra: A, val order: Int, bindings: Map<Symbol, T>) : ExpressionAlgebra<T, DS<T, A>> , SymbolIndexer(source)

Inheritors

Constructors

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

Types

@UnstableKMathAPI

inner class DSSymbol : Symbol, DS<T, A>

A class implementing both DS and Symbol.

Functions

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

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

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

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

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

@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

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

Build an instance from all its derivatives.

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

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

open override val symbols: List<Symbol>