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

Field

interface Field<T> : Ring<T> , FieldOps<T> , ScaleOperations<T> , NumericAlgebra<T>

Represents field i.e., algebraic structure with three operations: associative, commutative addition and multiplication, and division. This interface differs from the eponymous mathematical definition: fields in KMath also support associative multiplication by scalar.

Parameters

T

the type of element of this field.

Inheritors

FunctionalExpressionField

SimpleAutoDiffField

JBigDecimalFieldBase

Types

object Companion

Functions

fun <T : Comparable<T>> Group<T>.abs(value: T): T

Absolute of the comparable value

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

Addition of two elements.

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): (left: T, right: 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

fun <T> Algebra<T>.bindSymbol(symbol: Symbol): T

bindSymbolOrNull

open fun bindSymbolOrNull(value: String): T?

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

bindSymbolOrNull

fun <T> Algebra<T>.bindSymbolOrNull(symbol: Symbol): T?

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.

@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, right: T) -> T

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

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

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 fun rightSideNumberOperationFunction(operation: String): (left: 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.

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.

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

Dynamically dispatches a unary operation with the certain name.

open operator fun T.unaryPlus(): T

Returns this value.

Properties

open val bufferFactory: MutableBufferFactory<T>

Provide a factory for buffers, associated with this Algebra

val <T> NumericAlgebra<T>.e: T

The e mathematical constant.

abstract val one: T

The neutral element of multiplication

val <T> NumericAlgebra<T>.pi: T

The π mathematical constant.

abstract val zero: T

The neutral element of addition.