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: AutoDiffValue<T>): AutoDiffValue<T>

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

leftSideNumberOperationFunction

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.

open override fun ln(arg: AutoDiffValue<T>): AutoDiffValue<T>

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

minus

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.

multiply

abstract fun multiply(left: AutoDiffValue<T>, right: AutoDiffValue<T>): AutoDiffValue<T>

Multiplies two elements.

number

open override fun number(value: Number): AutoDiffValue<T>

Wraps a number to T object.

plus

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.

pow

open infix fun AutoDiffValue<T>.pow(pow: Number): AutoDiffValue<T>

Raises this value to the power pow.

fun pow(x: AutoDiffValue<T>, y: AutoDiffValue<T>): AutoDiffValue<T>

power

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.

rightSideNumberOperation

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.

rightSideNumberOperationFunction

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.

scale

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

Scaling an element by a scalar.

sin

open override fun sin(arg: AutoDiffValue<T>): AutoDiffValue<T>

Computes the sine of arg.

sinh

open override fun sinh(arg: AutoDiffValue<T>): AutoDiffValue<T>

Computes the hyperbolic sine of arg.

sqr

fun sqr(x: AutoDiffValue<T>): AutoDiffValue<T>

sqrt

open override fun sqrt(arg: AutoDiffValue<T>): AutoDiffValue<T>

Computes the square root of the value arg.

tan

open override fun tan(arg: AutoDiffValue<T>): AutoDiffValue<T>

Computes the tangent of arg.

tanh

open override fun tanh(arg: AutoDiffValue<T>): AutoDiffValue<T>

Computes the hyperbolic tangent of arg.

times

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.

unaryMinus

abstract operator fun AutoDiffValue<T>.unaryMinus(): AutoDiffValue<T>

The negation of this element.

unaryOperation

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

Dynamically invokes a unary operation with the certain name.

unaryOperationFunction

open override fun unaryOperationFunction(operation: String): (arg: AutoDiffValue<T>) -> AutoDiffValue<T>

Dynamically dispatches a unary operation with the certain name.

unaryPlus

open operator fun AutoDiffValue<T>.unaryPlus(): AutoDiffValue<T>

Returns this value.

Properties

context

val context: F

var AutoDiffValue<T>.d: T

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

one

abstract val one: AutoDiffValue<T>

The neutral element of multiplication

zero

abstract val zero: AutoDiffValue<T>

The neutral element of addition.

Sources

common source