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

RingND

interface RingND<T, out A : Ring<T>> : Ring<StructureND<T>> , RingOpsND<T, A> , GroupND<T, A> , WithShape(source)

Inheritors

Functions

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

Absolute of the comparable value

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

Addition of two elements.

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.

open fun bindSymbol(value: String): StructureND<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): 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?

@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.

@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.

@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.

@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.

@PerformancePitfall

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

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

@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.

@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.

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.

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

Multiplies two elements.

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>

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.

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

Raises arg to the integer power pow.

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

Produces a new StructureND using given initializer function.

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

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: 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.

abstract operator fun StructureND<T>.unaryMinus(): StructureND<T>

The negation of this element.

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.

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

Returns this value.

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>

@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

open val bufferFactory: MutableBufferFactory<StructureND<T>>

Provide a factory for buffers, associated with this Algebra

abstract val elementAlgebra: A

The algebra over elements of ND structure.

open val indices: ShapeIndexer

open override val one: StructureND<T>

The neutral element of multiplication

abstract val shape: ShapeND

abstract val zero: StructureND<T>

The neutral element of addition.