Field

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

Types

Link copied to clipboard
object Companion

Functions

Link copied to clipboard
fun <T : Comparable<T>> Group<T>.abs(value: T): T

Absolute of the comparable value

Link copied to clipboard
abstract fun add(left: T, right: T): T

Addition of two elements.

Link copied to clipboard
open fun binaryOperation(operation: String, left: T, right: T): T

Dynamically invokes a binary operation with the certain name.

Link copied to clipboard
open override fun binaryOperationFunction(operation: String): (left: T, right: T) -> T

Dynamically dispatches a binary operation with the certain name.

Link copied to clipboard
open fun bindSymbol(value: String): T

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

Link copied to clipboard
fun <T> Algebra<T>.bindSymbol(symbol: Symbol): T
Link copied to clipboard
open fun bindSymbolOrNull(value: String): T?

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

Link copied to clipboard
fun <T> Algebra<T>.bindSymbolOrNull(symbol: Symbol): T?
Link copied to clipboard
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.

Link copied to clipboard
abstract fun divide(left: T, right: T): T

Division of two elements.

Link copied to clipboard
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.

Link copied to clipboard
open fun leftSideNumberOperation(operation: String, left: Number, right: T): T

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

Link copied to clipboard
open fun leftSideNumberOperationFunction(operation: String): (left: Number, right: T) -> T

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

Link copied to clipboard
open operator fun T.minus(arg: T): T

Subtraction of two elements.

Link copied to clipboard
abstract fun multiply(left: T, right: T): T

Multiplies two elements.

Link copied to clipboard
open override fun number(value: Number): T

Wraps a number to T object.

Link copied to clipboard
open operator fun T.plus(arg: T): T

Addition of two elements.

Link copied to clipboard
open fun power(arg: T, pow: Int): T

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

Raises arg to the integer power pow.

Link copied to clipboard
open fun rightSideNumberOperation(operation: String, left: T, right: Number): T

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

Link copied to clipboard
open fun rightSideNumberOperationFunction(operation: String): (left: T, right: Number) -> T

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

Link copied to clipboard
abstract fun scale(a: T, value: Double): T

Scaling an element by a scalar.

Link copied to clipboard
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.

Link copied to clipboard
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.

Link copied to clipboard
abstract operator fun T.unaryMinus(): T

The negation of this element.

Link copied to clipboard
open fun unaryOperation(operation: String, arg: T): T

Dynamically invokes a unary operation with the certain name.

Link copied to clipboard
open override fun unaryOperationFunction(operation: String): (arg: T) -> T

Dynamically dispatches a unary operation with the certain name.

Link copied to clipboard
open operator fun T.unaryPlus(): T

Returns this value.

Properties

Link copied to clipboard

Provide a factory for buffers, associated with this Algebra

Link copied to clipboard
val <T> NumericAlgebra<T>.e: T

The e mathematical constant.

Link copied to clipboard
abstract val one: T

The neutral element of multiplication

Link copied to clipboard

The π mathematical constant.

Link copied to clipboard
abstract val zero: T

The neutral element of addition.