Package space.kscience.kmath.expressions

Types

AutoDiffProcessor

common

fun fun interface AutoDiffProcessor<T, I, out A : Algebra<I>>

A factory that converts an expression in autodiff variables to a DifferentiableExpression

AutoDiffValue

common

open class AutoDiffValue<out T>(value: T)

DerivationResult

common

class DerivationResult<T : Any>(value: T, derivativeValues: Map<String, T>, context: Field<T>)

Represents result of simpleAutoDiff call.

DifferentiableExpression

common

interface DifferentiableExpression<T> : Expression<T>

Represents expression, which structure can be differentiated.

Expression

common

fun fun interface Expression<T>

An elementary function that could be invoked on a map of arguments.

ExpressionAlgebra

common

interface ExpressionAlgebra<in T, E> : Algebra<E>

A context for expression construction

FirstDerivativeExpression

common

abstract class FirstDerivativeExpression<T> : DifferentiableExpression<T>

A DifferentiableExpression that defines only first derivatives

FunctionalExpressionAlgebra

common

abstract class FunctionalExpressionAlgebra<T, out A : Algebra<T>>(algebra: A) : ExpressionAlgebra<T, Expression<T>>

A context class for Expression construction.

FunctionalExpressionExtendedField

common

open class FunctionalExpressionExtendedField<T, out A : ExtendedField<T>>(algebra: A) : FunctionalExpressionField<T, A> , ExtendedField<Expression<T>>

FunctionalExpressionField

common

open class FunctionalExpressionField<T, out A : Field<T>>(algebra: A) : FunctionalExpressionRing<T, A> , Field<Expression<T>> , ScaleOperations<Expression<T>>

FunctionalExpressionGroup

common

open class FunctionalExpressionGroup<T, out A : Group<T>>(algebra: A) : FunctionalExpressionAlgebra<T, A> , Group<Expression<T>>

A context class for Expression construction for Ring algebras.

FunctionalExpressionRing

common

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

MST

common

interface MST

A Mathematical Syntax Tree (MST) node for mathematical expressions.

MstExtendedField

common

object MstExtendedField : ExtendedField<MST> , NumericAlgebra<MST>

ExtendedField over MST nodes.

MstField

common

object MstField : Field<MST> , NumbersAddOps<MST> , ScaleOperations<MST>

Field over MST nodes.

MstGroup

common

object MstGroup : Group<MST> , NumericAlgebra<MST> , ScaleOperations<MST>

Group over MST nodes.

MstLogicAlgebra

common

@UnstableKMathAPI()

object MstLogicAlgebra : LogicAlgebra<MST>

Logic algebra for MST

MstNumericAlgebra

common

object MstNumericAlgebra : NumericAlgebra<MST>

Algebra over MST nodes.

MstRing

common

object MstRing : Ring<MST> , NumbersAddOps<MST> , ScaleOperations<MST>

Ring over MST nodes.

SimpleAutoDiffExpression

common

class SimpleAutoDiffExpression<T : Any, F : Field<T>>(field: F, function: SimpleAutoDiffField<T, F>.() -> AutoDiffValue<T>) : FirstDerivativeExpression<T>

A constructs that creates a derivative structure with required order on-demand

SimpleAutoDiffExtendedField

common

class SimpleAutoDiffExtendedField<T : Any, F : ExtendedField<T>>(context: F, bindings: Map<Symbol, T>) : SimpleAutoDiffField<T, F> , ExtendedField<AutoDiffValue<T>> , ScaleOperations<AutoDiffValue<T>>

SimpleAutoDiffField

common

open class SimpleAutoDiffField<T : Any, F : Field<T>>(context: F, bindings: Map<Symbol, T>) : Field<AutoDiffValue<T>> , ExpressionAlgebra<T, AutoDiffValue<T>> , NumbersAddOps<AutoDiffValue<T>>

Represents field in context of which functions can be derived.

SimpleSymbolIndexer

common

@UnstableKMathAPI()

@JvmInline()

value class SimpleSymbolIndexer(symbols: List<Symbol>) : SymbolIndexer

SpecialDifferentiableExpression

common

interface SpecialDifferentiableExpression<T, out R : Expression<T>> : DifferentiableExpression<T>

A special type of DifferentiableExpression which returns typed expressions as derivatives.

Symbol

common

interface Symbol : MST

A marker interface for a symbol.

SymbolIndexer

common

@UnstableKMathAPI()

interface SymbolIndexer

An environment to easy transform indexed variables to symbols and back.

Functions

acos

common

fun <T : Any, F : ExtendedField<T>> SimpleAutoDiffField<T, F>.acos(x: AutoDiffValue<T>): AutoDiffValue<T>

acosh

common

fun <T : Any, F : ExtendedField<T>> SimpleAutoDiffField<T, F>.acosh(x: AutoDiffValue<T>): AutoDiffValue<T>

asin

common

fun <T : Any, F : ExtendedField<T>> SimpleAutoDiffField<T, F>.asin(x: AutoDiffValue<T>): AutoDiffValue<T>

asinh

common

fun <T : Any, F : ExtendedField<T>> SimpleAutoDiffField<T, F>.asinh(x: AutoDiffValue<T>): AutoDiffValue<T>

atan

common

fun <T : Any, F : ExtendedField<T>> SimpleAutoDiffField<T, F>.atan(x: AutoDiffValue<T>): AutoDiffValue<T>

atanh

common

fun <T : Any, F : ExtendedField<T>> SimpleAutoDiffField<T, F>.atanh(x: AutoDiffValue<T>): AutoDiffValue<T>

chiSquaredExpression

common

@JvmName(name = genericChiSquaredExpression)

fun <T : Comparable<T>, I : Any, A : ExtendedField<I>, ExpressionAlgebra<T, I>> AutoDiffProcessor<T, I, A>.chiSquaredExpression(x: Buffer<T>, y: Buffer<T>, yErr: Buffer<T>, model: A.(I) -> I): DifferentiableExpression<T>

Generate a chi squared expression from given x-y-sigma data and inline model.

fun <I : Any, A : ExtendedField<I>, ExpressionAlgebra<Double, I>> AutoDiffProcessor<Double, I, A>.chiSquaredExpression(x: Buffer<Double>, y: Buffer<Double>, yErr: Buffer<Double>, model: A.(I) -> I): DifferentiableExpression<Double>

const

common

inline fun <T : Any, F : Field<T>> SimpleAutoDiffField<T, F>.const(block: F.() -> T): AutoDiffValue<T>

cos

common

fun <T : Any, F : ExtendedField<T>> SimpleAutoDiffField<T, F>.cos(x: AutoDiffValue<T>): AutoDiffValue<T>

cosh

common

fun <T : Any, F : ExtendedField<T>> SimpleAutoDiffField<T, F>.cosh(x: AutoDiffValue<T>): AutoDiffValue<T>

derivative

common

fun <T> DifferentiableExpression<T>.derivative(vararg symbols: Symbol): Expression<T>

fun <T> DifferentiableExpression<T>.derivative(name: String): Expression<T>

fun <T> DifferentiableExpression<T>.derivative(symbols: List<Symbol>): Expression<T>

fun <T, R : Expression<T>> SpecialDifferentiableExpression<T, R>.derivative(vararg symbols: Symbol): R

fun <T, R : Expression<T>> SpecialDifferentiableExpression<T, R>.derivative(name: String): R

fun <T, R : Expression<T>> SpecialDifferentiableExpression<T, R>.derivative(symbols: List<Symbol>): R

evaluate

common

fun <T> Algebra<T>.evaluate(node: MST): T

Interprets the MST node with this Algebra.

exp

common

fun <T : Any, F : ExtendedField<T>> SimpleAutoDiffField<T, F>.exp(x: AutoDiffValue<T>): AutoDiffValue<T>

expression

common

inline fun DoubleField.expression(block: FunctionalExpressionExtendedField<Double, DoubleField>.() -> Expression<Double>): Expression<Double>

expressionInExtendedField

common

inline fun <T, A : ExtendedField<T>> A.expressionInExtendedField(block: FunctionalExpressionExtendedField<T, A>.() -> Expression<T>): Expression<T>

expressionInField

common

inline fun <T, A : Field<T>> A.expressionInField(block: FunctionalExpressionField<T, A>.() -> Expression<T>): Expression<T>

expressionInGroup

common

inline fun <T, A : Group<T>> A.expressionInGroup(block: FunctionalExpressionGroup<T, A>.() -> Expression<T>): Expression<T>

expressionInRing

common

inline fun <T, A : Ring<T>> A.expressionInRing(block: FunctionalExpressionRing<T, A>.() -> Expression<T>): Expression<T>

get

common

operator fun <T> Map<String, T>.get(symbol: Symbol): T?

Ger a value from a String-keyed map by a Symbol

operator fun <T> Map<Symbol, T>.get(string: String): T?

Get a value from a Symbol-keyed map by a String

grad

common

fun <T : Any> DerivationResult<T>.grad(vararg variables: Symbol): Point<T>

Computes the gradient for variables in given order.

interpret

common

fun <T> MST.interpret(algebra: Algebra<T>, vararg arguments: Pair<Symbol, T>): T

Interprets the MST node with this Algebra and optional arguments

fun <T> MST.interpret(algebra: Algebra<T>, arguments: Map<Symbol, T>): T

Interprets the MST node with this Algebra and optional arguments

invoke

common

operator fun <T> Expression<T>.invoke(): T

Calls this expression without providing any arguments.

@JvmName(name = callByString)

operator fun <T> Expression<T>.invoke(vararg pairs: Pair<String, T>): T

Calls this expression from arguments.

@JvmName(name = callBySymbol)

operator fun <T> Expression<T>.invoke(vararg pairs: Pair<Symbol, T>): T

Calls this expression from arguments.

common

fun <T : Any, F : ExtendedField<T>> SimpleAutoDiffField<T, F>.ln(x: AutoDiffValue<T>): AutoDiffValue<T>

pow

common

fun <T : Any, F : ExtendedField<T>> SimpleAutoDiffField<T, F>.pow(x: AutoDiffValue<T>, y: Double): AutoDiffValue<T>

fun <T : Any, F : ExtendedField<T>> SimpleAutoDiffField<T, F>.pow(x: AutoDiffValue<T>, y: Int): AutoDiffValue<T>

fun <T : Any, F : ExtendedField<T>> SimpleAutoDiffField<T, F>.pow(x: AutoDiffValue<T>, y: AutoDiffValue<T>): AutoDiffValue<T>

set

common

operator fun <T> MutableMap<String, T>.set(symbol: Symbol, value: T)

Set a value of String-keyed map by a Symbol

operator fun <T> MutableMap<Symbol, T>.set(string: String, value: T)

Set a value of String-keyed map by a Symbol

simpleAutoDiff

common

fun <T : Any, F : Field<T>> simpleAutoDiff(field: F): AutoDiffProcessor<T, AutoDiffValue<T>, SimpleAutoDiffField<T, F>>

Generate AutoDiffProcessor for SimpleAutoDiffExpression

fun <T : Any, F : Field<T>> F.simpleAutoDiff(vararg bindings: Pair<Symbol, T>, body: SimpleAutoDiffField<T, F>.() -> AutoDiffValue<T>): DerivationResult<T>

fun <T : Any, F : Field<T>> F.simpleAutoDiff(bindings: Map<Symbol, T>, body: SimpleAutoDiffField<T, F>.() -> AutoDiffValue<T>): DerivationResult<T>

Runs differentiation and establishes SimpleAutoDiffField context inside the block of code.

sin

common

fun <T : Any, F : ExtendedField<T>> SimpleAutoDiffField<T, F>.sin(x: AutoDiffValue<T>): AutoDiffValue<T>

sinh

common

fun <T : Any, F : ExtendedField<T>> SimpleAutoDiffField<T, F>.sinh(x: AutoDiffValue<T>): AutoDiffValue<T>

sqr

common

fun <T : Any, F : ExtendedField<T>> SimpleAutoDiffField<T, F>.sqr(x: AutoDiffValue<T>): AutoDiffValue<T>

sqrt

common

fun <T : Any, F : ExtendedField<T>> SimpleAutoDiffField<T, F>.sqrt(x: AutoDiffValue<T>): AutoDiffValue<T>

Symbol

common

fun Symbol(identity: String): Symbol

Create s Symbols with a string identity

tan

common

fun <T : Any, F : ExtendedField<T>> SimpleAutoDiffField<T, F>.tan(x: AutoDiffValue<T>): AutoDiffValue<T>

tanh

common

fun <T : Any, F : ExtendedField<T>> SimpleAutoDiffField<T, F>.tanh(x: AutoDiffValue<T>): AutoDiffValue<T>

toExpression

common

fun <T : Any> MST.toExpression(algebra: Algebra<T>): Expression<T>

Interpret this MST as expression.

withSymbols

common

@UnstableKMathAPI()

inline fun <R> withSymbols(vararg symbols: Symbol, block: SymbolIndexer.() -> R): R

Execute the block with symbol indexer based on given symbol order

@UnstableKMathAPI()

inline fun <R> withSymbols(symbols: Collection<Symbol>, block: SymbolIndexer.() -> R): R

Properties

binding

common

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

Bind a symbol by name inside the ExpressionAlgebra

symbol

common

val symbol: ReadOnlyProperty<Any?, Symbol>

A delegate to create a symbol with a string identity in this scope