kmath-core/space.kscience.kmath.nd/BufferedRingOpsND

BufferedRingOpsND

open class BufferedRingOpsND<T, out A : Ring<T>>(bufferAlgebra: BufferAlgebra<T, A>, indexerBuilder: (ShapeND) -> ShapeIndexer = BufferAlgebraND.defaultIndexerBuilder) : BufferedGroupNDOps<T, A> , RingOpsND<T, A> (source)

Inheritors

BufferedFieldOpsND

IntRingOpsND

ShortRingOpsND

Constructors

BufferedRingOpsND

constructor(bufferAlgebra: BufferAlgebra<T, A>, indexerBuilder: (ShapeND) -> ShapeIndexer = BufferAlgebraND.defaultIndexerBuilder)

Functions

add

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

Element-wise addition.

binaryOperation

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

Dynamically invokes a binary operation with the certain name.

binaryOperationFunction

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

Dynamically dispatches a binary operation with the certain name.

bindSymbol

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

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

bindSymbol

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

bindSymbolOrNull

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

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

bindSymbolOrNull

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

contentEquals

@PerformancePitfall

fun <T : Comparable<T>> AlgebraND<T, Ring<T>>.contentEquals(st1: StructureND<T>, st2: StructureND<T>): Boolean

Indicates whether some StructureND is equal to another one.

@PerformancePitfall

fun <T : Comparable<T>> GroupOpsND<T, Ring<T>>.contentEquals(st1: StructureND<T>, st2: StructureND<T>, absoluteTolerance: T): Boolean

Indicates whether some StructureND is equal to another one with absoluteTolerance.

export

@UnstableKMathAPI

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

getFeature

@UnstableKMathAPI

open fun <F : StructureFeature> getFeature(structure: StructureND<T>, type: KClass<out F>): F?

Get a feature of the structure in this scope. Structure features take precedence other context features.

getFeature

@UnstableKMathAPI

inline fun <T : Any, F : StructureFeature> AlgebraND<T, *>.getFeature(structure: StructureND<T>): F?

Get a feature of the structure in this scope. Structure features take precedence other context features.

invoke

@PerformancePitfall

open operator fun (T) -> T.invoke(structure: StructureND<T>): StructureND<T>

Element-wise invocation of function working on T on a StructureND.

map

@PerformancePitfall(message = "Very slow on remote execution algebras")

open fun StructureND<T>.map(transform: A.(T) -> T): StructureND<T>

Maps elements from one structure to another one by applying transform to them.

mapIndexed

@PerformancePitfall(message = "Very slow on remote execution algebras")

open fun StructureND<T>.mapIndexed(transform: A.(index: IntArray, T) -> T): StructureND<T>

Maps elements from one structure to another one by applying transform to them alongside with their indices.

mapInline

inline fun <T, A : Algebra<T>> BufferAlgebraND<T, A>.mapInline(arg: BufferND<T>, crossinline transform: A.(T) -> T): BufferND<T>

minus

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

Subtracts an ND structure from an element of it.

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

Subtracts an element from ND structure of it.

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

Subtraction of two elements.

multiply

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

Element-wise multiplication.

one

fun <T, A : Ring<T>> AlgebraND<T, A>.one(shape: ShapeND): StructureND<T>

@JvmName(name = "oneVarArg")

fun <T, A : Ring<T>> AlgebraND<T, A>.one(shapeFirst: Int, vararg shapeRest: Int): StructureND<T>

plus

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

Adds an element to ND structure of it.

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

Adds an ND structure to an element of it.

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

Addition of two elements.

structureND

abstract fun structureND(shape: ShapeND, initializer: A.(IntArray) -> T): StructureND<T>

Produces a new StructureND using given initializer function.

structureND

fun <T, A : Algebra<T>> BufferAlgebraND<T, A>.structureND(vararg shape: Int, initializer: A.(IntArray) -> T): BufferND<T>

fun <T, A : Algebra<T>> AlgebraND<T, A>.structureND(shapeFirst: Int, vararg shapeRest: Int, initializer: A.(IntArray) -> T): StructureND<T>

times

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

Multiplies an element by a ND structure of it.

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

Multiplies an ND structure by an element of it.

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

Multiplies this element by scalar.

toBufferND

open fun StructureND<T>.toBufferND(): BufferND<T>

unaryMinus

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

The negation of this element.

unaryOperation

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

Dynamically invokes a unary operation with the certain name.

unaryOperationFunction

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

Dynamically dispatches a unary operation with the certain name.

unaryPlus

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

Returns this value.

zero

fun <T, A : Group<T>> AlgebraND<T, A>.zero(shape: ShapeND): StructureND<T>

@JvmName(name = "zeroVarArg")

fun <T, A : Group<T>> AlgebraND<T, A>.zero(shapeFirst: Int, vararg shapeRest: Int): StructureND<T>

zip

@PerformancePitfall(message = "Very slow on remote execution algebras")

open fun zip(left: StructureND<T>, right: StructureND<T>, transform: A.(T, T) -> T): StructureND<T>

Combines two structures into one.

Properties

bufferAlgebra

open override val bufferAlgebra: BufferAlgebra<T, A>

bufferFactory

open val bufferFactory: MutableBufferFactory<StructureND<T>>

Provide a factory for buffers, associated with this Algebra

elementAlgebra

abstract val elementAlgebra: A

The algebra over elements of ND structure.

indexerBuilder

open override val indexerBuilder: (ShapeND) -> ShapeIndexer