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

DerivationResult

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

Represents result of simpleAutoDiff call.

Parameters

T

the non-nullable type of value.

value

the value of result.

Constructors

DerivationResult

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

Functions

fun derivative(variable: Symbol): T

Returns derivative of variable or returns Ring.zero in context.

fun div(): T

Computes the divergence.

Properties

val context: Field<T>

The field over T.

val value: T

Extensions

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

Computes the gradient for variables in given order.

Sources