SimpleAutoDiffExtendedField

Constructors

Link copied to clipboard
constructor(context: F, bindings: Map<Symbol, T>)

Functions

Link copied to clipboard
fun <T : Comparable<T>> Group<T>.abs(value: T): T

Absolute of the comparable value

Link copied to clipboard
open override fun acos(arg: AutoDiffValue<T>): AutoDiffValue<T>

Computes the inverse cosine of arg.

Link copied to clipboard
Link copied to clipboard
open override fun acosh(arg: AutoDiffValue<T>): AutoDiffValue<T>

Computes the inverse hyperbolic cosine of arg.

Link copied to clipboard
Link copied to clipboard
abstract fun add(left: AutoDiffValue<T>, right: AutoDiffValue<T>): AutoDiffValue<T>

Addition of two elements.

Link copied to clipboard
open override fun asin(arg: AutoDiffValue<T>): AutoDiffValue<T>

Computes the inverse sine of arg.

Link copied to clipboard
Link copied to clipboard
open override fun asinh(arg: AutoDiffValue<T>): AutoDiffValue<T>

Computes the inverse hyperbolic sine of arg.

Link copied to clipboard
Link copied to clipboard
open override fun atan(arg: AutoDiffValue<T>): AutoDiffValue<T>

Computes the inverse tangent of arg.

Link copied to clipboard
Link copied to clipboard
open override fun atanh(arg: AutoDiffValue<T>): AutoDiffValue<T>

Computes the inverse hyperbolic tangent of arg.

Link copied to clipboard
Link copied to clipboard
open fun binaryOperation(operation: String, left: AutoDiffValue<T>, right: AutoDiffValue<T>): AutoDiffValue<T>

Dynamically invokes a binary operation with the certain name.

Link copied to clipboard
open override fun binaryOperationFunction(operation: String): (left: AutoDiffValue<T>, right: AutoDiffValue<T>) -> AutoDiffValue<T>

Dynamically dispatches a binary operation with the certain name.

Link copied to clipboard
open fun bindSymbol(value: String): AutoDiffValue<T>

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

Link copied to clipboard
fun <T> Algebra<T>.bindSymbol(symbol: Symbol): T
Link copied to clipboard

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

Link copied to clipboard
fun <T> Algebra<T>.bindSymbolOrNull(symbol: Symbol): T?
Link copied to clipboard
open override fun const(value: T): AutoDiffValue<T>

A constant expression that does not depend on arguments.

Link copied to clipboard
inline fun <T : Any, F : Field<T>> SimpleAutoDiffField<T, F>.const(block: F.() -> T): AutoDiffValue<T>
Link copied to clipboard
open override fun cos(arg: AutoDiffValue<T>): AutoDiffValue<T>

Computes the cosine of arg.

Link copied to clipboard
Link copied to clipboard
open override fun cosh(arg: AutoDiffValue<T>): AutoDiffValue<T>

Computes the hyperbolic cosine of arg.

Link copied to clipboard
Link copied to clipboard
fun <R> derive(value: R, block: F.(R) -> Unit): R

Performs update of derivative after the rest of the formula in the back-pass.

Link copied to clipboard
open operator fun AutoDiffValue<T>.div(arg: AutoDiffValue<T>): AutoDiffValue<T>

Division of two elements.

open operator fun AutoDiffValue<T>.div(k: Number): AutoDiffValue<T>

Division of this element by scalar.

Link copied to clipboard
abstract fun divide(left: AutoDiffValue<T>, right: AutoDiffValue<T>): AutoDiffValue<T>

Division of two elements.

Link copied to clipboard
open override fun exp(arg: AutoDiffValue<T>): AutoDiffValue<T>

Computes Euler's number e raised to the power of the value arg.

Link copied to clipboard
Link copied to clipboard

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.

Link copied to clipboard
open fun leftSideNumberOperation(operation: String, left: Number, right: AutoDiffValue<T>): AutoDiffValue<T>

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

Link copied to clipboard
open fun leftSideNumberOperationFunction(operation: String): (left: Number, right: AutoDiffValue<T>) -> AutoDiffValue<T>

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

Link copied to clipboard
open override fun ln(arg: AutoDiffValue<T>): AutoDiffValue<T>

Computes the natural logarithm (base e) of the value arg.

Link copied to clipboard
Link copied to clipboard
open operator fun AutoDiffValue<T>.minus(arg: AutoDiffValue<T>): AutoDiffValue<T>

Subtraction of two elements.

open operator fun Number.minus(other: AutoDiffValue<T>): AutoDiffValue<T>

Subtraction of number from element.

open operator fun AutoDiffValue<T>.minus(other: Number): AutoDiffValue<T>

Subtraction of element from number.

Link copied to clipboard
abstract fun multiply(left: AutoDiffValue<T>, right: AutoDiffValue<T>): AutoDiffValue<T>

Multiplies two elements.

Link copied to clipboard
open override fun number(value: Number): AutoDiffValue<T>

Wraps a number to T object.

Link copied to clipboard
open operator fun AutoDiffValue<T>.plus(arg: AutoDiffValue<T>): AutoDiffValue<T>

Addition of two elements.

open operator fun Number.plus(other: AutoDiffValue<T>): AutoDiffValue<T>

Addition of scalar and element.

open operator fun AutoDiffValue<T>.plus(other: Number): AutoDiffValue<T>

Addition of element and scalar.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
open override fun power(arg: AutoDiffValue<T>, pow: Number): AutoDiffValue<T>

Raises arg to a power if possible (negative number could not be raised to a fractional power). Throws IllegalArgumentException if not possible.

open fun power(arg: AutoDiffValue<T>, pow: Int): AutoDiffValue<T>

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

Raises arg to the integer power pow.

Link copied to clipboard
open fun rightSideNumberOperation(operation: String, left: AutoDiffValue<T>, right: Number): AutoDiffValue<T>

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

Link copied to clipboard
open override fun rightSideNumberOperationFunction(operation: String): (left: AutoDiffValue<T>, right: Number) -> AutoDiffValue<T>

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

Link copied to clipboard
open override fun scale(a: AutoDiffValue<T>, value: Double): AutoDiffValue<T>

Scaling an element by a scalar.

Link copied to clipboard
open override fun sin(arg: AutoDiffValue<T>): AutoDiffValue<T>

Computes the sine of arg.

Link copied to clipboard
Link copied to clipboard
open override fun sinh(arg: AutoDiffValue<T>): AutoDiffValue<T>

Computes the hyperbolic sine of arg.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
open override fun sqrt(arg: AutoDiffValue<T>): AutoDiffValue<T>

Computes the square root of the value arg.

Link copied to clipboard
Link copied to clipboard
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.

Link copied to clipboard
open override fun tan(arg: AutoDiffValue<T>): AutoDiffValue<T>

Computes the tangent of arg.

Link copied to clipboard
Link copied to clipboard
open override fun tanh(arg: AutoDiffValue<T>): AutoDiffValue<T>

Computes the hyperbolic tangent of arg.

Link copied to clipboard
Link copied to clipboard
open operator fun AutoDiffValue<T>.times(arg: AutoDiffValue<T>): AutoDiffValue<T>

Multiplies this element by scalar.

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

Multiplication of this number by element.

open operator fun AutoDiffValue<T>.times(k: Number): AutoDiffValue<T>

Multiplication of this element by a scalar.

Link copied to clipboard
abstract operator fun AutoDiffValue<T>.unaryMinus(): AutoDiffValue<T>

The negation of this element.

Link copied to clipboard
open fun unaryOperation(operation: String, arg: AutoDiffValue<T>): AutoDiffValue<T>

Dynamically invokes a unary operation with the certain name.

Link copied to clipboard
open override fun unaryOperationFunction(operation: String): (arg: AutoDiffValue<T>) -> AutoDiffValue<T>

Dynamically dispatches a unary operation with the certain name.

Link copied to clipboard
open operator fun AutoDiffValue<T>.unaryPlus(): AutoDiffValue<T>

Returns this value.

Properties

Link copied to clipboard

Bind a symbol by name inside the ExpressionAlgebra

Link copied to clipboard

Provide a factory for buffers, associated with this Algebra

Link copied to clipboard
val context: F
Link copied to clipboard

A variable accessing inner state of derivatives. Use this value in inner builders to avoid creating additional derivative bindings.

Link copied to clipboard
val <T> NumericAlgebra<T>.e: T

The e mathematical constant.

Link copied to clipboard
abstract val one: AutoDiffValue<T>

The neutral element of multiplication

Link copied to clipboard

The π mathematical constant.

Link copied to clipboard
abstract val zero: AutoDiffValue<T>

The neutral element of addition.