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

the type of element of this field.

Functions

add

common

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

Addition of two elements.

binaryOperation

common

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

Dynamically invokes a binary operation with the certain name.

binaryOperationFunction

common

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

Dynamically dispatches a binary operation with the certain name.

bindSymbol

common

open fun bindSymbol(value: String): T

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

bindSymbolOrNull

common

open fun bindSymbolOrNull(value: String): T?

Wraps a raw string to T object.

div

common

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

Division of two elements.

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

Division of this element by scalar.

divide

common

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

Division of two elements.

leftSideNumberOperation

common

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

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

leftSideNumberOperationFunction

common

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

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

minus

common

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

Subtraction of two elements.

multiply

common

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

Multiplies two elements.

number

common

open override fun number(value: Number): T

Wraps a number to T object.

plus

common

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

Addition of two elements.

rightSideNumberOperation

common

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

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

rightSideNumberOperationFunction

common

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

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

scale

common

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

Scaling an element by a scalar.

times

common

open operator fun T.times(other: 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(other: T): T

Multiplication of this number by element.

unaryMinus

common

abstract operator fun T.unaryMinus(): T

The negation of this element.

unaryOperation

common

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

Dynamically invokes a unary operation with the certain name.

unaryOperationFunction

common

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

Dynamically dispatches a unary operation with the certain name.

unaryPlus

common

open operator fun T.unaryPlus(): T

Returns this value.

Properties

one

common

abstract val one: T

The neutral element of multiplication

zero

common

abstract val zero: T

The neutral element of addition.

Inheritors

FunctionalExpressionField

MstField

SimpleAutoDiffField

FieldND

BigIntField

BufferField

ExtendedField

JBigDecimalFieldBase

Extensions

power

common

fun <T> Field<T>.power(arg: T, exponent: Int): T

Raises arg to the integer power exponent.

Sources

common source