kmath-core/space.kscience.kmath.operations/ExtendedField

ExtendedField

interface ExtendedField<T> : ExtendedFieldOps<T> , Field<T> , PowerOperations<T> , NumericAlgebra<T>

Advanced Number-like field that implements basic operations.

Functions

abstract fun acos(arg: T): T

Computes the inverse cosine of arg.

open override fun acosh(arg: T): T

Computes the inverse hyperbolic cosine of arg.

abstract fun add(left: T, right: T): T

Addition of two elements.

abstract fun asin(arg: T): T

Computes the inverse sine of arg.

open override fun asinh(arg: T): T

Computes the inverse hyperbolic sine of arg.

abstract fun atan(arg: T): T

Computes the inverse tangent of arg.

open override fun atanh(arg: T): T

Computes the inverse hyperbolic tangent of arg.

binaryOperation

open fun binaryOperation(operation: String, left: T, right: T): T

Dynamically invokes a binary operation with the certain name.

binaryOperationFunction

open override fun binaryOperationFunction(operation: String): (T, T) -> T

Dynamically dispatches a binary operation with the certain name.

open fun bindSymbol(value: String): T

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

bindSymbolOrNull

open fun bindSymbolOrNull(value: String): T?

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

abstract fun cos(arg: T): T

Computes the cosine of arg.

open override fun cosh(arg: T): T

Computes the hyperbolic cosine of arg.

open operator fun T.div(arg: T): T

Division of two elements.

open operator fun T.div(k: Number): T

Division of this element by scalar.

abstract fun divide(left: T, right: T): T

Division of two elements.

abstract fun exp(arg: T): T

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

@UnstableKMathAPI

open fun export(arg: T): T

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

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

leftSideNumberOperationFunction

open fun leftSideNumberOperationFunction(operation: String): (left: Number, T) -> T

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

abstract fun ln(arg: T): T

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

open operator fun T.minus(arg: T): T

Subtraction of two elements.

abstract fun multiply(left: T, right: T): T

Multiplies two elements.

open override fun number(value: Number): T

Wraps a number to T object.

open operator fun T.plus(arg: T): T

Addition of two elements.

open infix fun T.pow(pow: Number): T

Raises this value to the power pow.

open fun power(arg: T, pow: Int): T

abstract fun power(arg: T, pow: Number): 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: T, pow: UInt): T

Raises arg to the integer power pow.

rightSideNumberOperation

open fun rightSideNumberOperation(operation: String, left: T, right: Number): T

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

rightSideNumberOperationFunction

open override fun rightSideNumberOperationFunction(operation: String): (T, right: Number) -> T

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

abstract fun scale(a: T, value: Double): T

Scaling an element by a scalar.

abstract fun sin(arg: T): T

Computes the sine of arg.

open override fun sinh(arg: T): T

Computes the hyperbolic sine of arg.

open fun sqrt(arg: T): T

Computes the square root of the value arg.

open override fun tan(arg: T): T

Computes the tangent of arg.

open override fun tanh(arg: T): T

Computes the hyperbolic tangent of arg.

open operator fun T.times(arg: T): T

Multiplies this element by scalar.

open operator fun T.times(k: Number): T

Multiplication of this element by a scalar.

open operator fun Number.times(arg: T): T

Multiplication of this number by element.

abstract operator fun T.unaryMinus(): T

The negation of this element.

open fun unaryOperation(operation: String, arg: T): T

Dynamically invokes a unary operation with the certain name.

unaryOperationFunction

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

Dynamically dispatches a unary operation with the certain name.

open operator fun T.unaryPlus(): T

Returns this value.

Properties

abstract val one: T

The neutral element of multiplication

abstract val zero: T

The neutral element of addition.

Inheritors

FunctionalExpressionExtendedField

MstExtendedField

SimpleAutoDiffExtendedField

DoubleBufferField

Sources