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

BufferField

class BufferField<T, A : Field<T>>(elementAlgebra: A, bufferFactory: BufferFactory<T>, size: Int) : BufferFieldOps<T, A> , Field<Buffer<T>> , WithSize

Functions

open override fun add(left: Buffer<T>, right: Buffer<T>): Buffer<T>

Addition of two elements.

binaryOperation

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

Dynamically invokes a binary operation with the certain name.

binaryOperationFunction

open override fun binaryOperationFunction(operation: String): (left: Buffer<T>, right: Buffer<T>) -> Buffer<T>

Dynamically dispatches a binary operation with the certain name.

open fun bindSymbol(value: String): Buffer<T>

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

bindSymbolOrNull

open fun bindSymbolOrNull(value: String): Buffer<T>?

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

open fun buffer(size: Int, vararg elements: T): Buffer<T>

open operator fun Buffer<T>.div(arg: Buffer<T>): Buffer<T>

Division of two elements.

open operator fun Buffer<T>.div(k: Number): Buffer<T>

Division of this element by scalar.

open override fun divide(left: Buffer<T>, right: Buffer<T>): Buffer<T>

Division of two elements.

@UnstableKMathAPI

open fun export(arg: Buffer<T>): Buffer<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: Buffer<T>): Buffer<T>

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

leftSideNumberOperationFunction

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

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

open fun Buffer<T>.map(block: A.(T) -> T): Buffer<T>

open fun Buffer<T>.mapIndexed(block: A.(index: Int, T) -> T): Buffer<T>

open operator fun Buffer<T>.minus(arg: Buffer<T>): Buffer<T>

Subtraction of two elements.

open override fun multiply(left: Buffer<T>, right: Buffer<T>): Buffer<T>

Multiplies two elements.

open override fun number(value: Number): Buffer<T>

Wraps a number to T object.

open operator fun Buffer<T>.plus(arg: Buffer<T>): Buffer<T>

Addition of two elements.

open fun power(arg: Buffer<T>, pow: Int): Buffer<T>

open fun power(arg: Buffer<T>, pow: UInt): Buffer<T>

Raises arg to the integer power pow.

rightSideNumberOperation

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

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

rightSideNumberOperationFunction

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

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

open override fun scale(a: Buffer<T>, value: Double): Buffer<T>

Scaling an element by a scalar.

open operator fun Buffer<T>.times(arg: Buffer<T>): Buffer<T>

Multiplies this element by scalar.

open operator fun Number.times(arg: Buffer<T>): Buffer<T>

Multiplication of this number by element.

open operator fun Buffer<T>.times(k: Number): Buffer<T>

Multiplication of this element by a scalar.

open operator override fun Buffer<T>.unaryMinus(): Buffer<T>

The negation of this element.

open fun unaryOperation(operation: String, arg: Buffer<T>): Buffer<T>

Dynamically invokes a unary operation with the certain name.

unaryOperationFunction

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

Dynamically dispatches a unary operation with the certain name.

open operator fun Buffer<T>.unaryPlus(): Buffer<T>

Returns this value.

open fun Buffer<T>.zip(other: Buffer<T>, block: A.(T, T) -> T): Buffer<T>

Properties

open override val bufferFactory: BufferFactory<T>

open override val elementAlgebra: A

open override val one: Buffer<T>

The neutral element of multiplication

open override val size: Int

open override val zero: Buffer<T>

The neutral element of addition.

Extensions

fun BufferField<Double, *>.buffer(vararg elements: Number): Buffer<Double>

Sources