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

common

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

the non-nullable type of value.

Functions

derivative

common

fun derivative(variable: Symbol): T

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

div

common

fun div(): T

Computes the divergence.

equals

common

open operator fun equals(other: Any?): Boolean

hashCode

common

open fun hashCode(): Int

toString

common

open fun toString(): String

Properties

context

common

val context: Field<T>

The field over T.

value

common

val value: T

the value of result.

Extensions

grad

common

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

Computes the gradient for variables in given order.