GroupND

interface GroupND<T, out S : Group<T>> : Group<StructureND<T>> , AlgebraND<T, S>

Space of StructureND.

Parameters

the type of the element contained in ND structure.

the type of group over structure elements.

Types

Companion

common

object Companion

Functions

add

common

open override fun add(a: StructureND<T>, b: StructureND<T>): StructureND<T>

Element-wise addition.

binaryOperation

common

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

Dynamically invokes a binary operation with the certain name.

binaryOperationFunction

common

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

Dynamically dispatches a binary operation with the certain name.

bindSymbol

common

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

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

bindSymbolOrNull

common

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

Wraps a raw string to T object.

combine

common

abstract fun combine(a: StructureND<T>, b: StructureND<T>, transform: S.(T, T) -> T): StructureND<T>

Combines two structures into one.

getFeature

common

@UnstableKMathAPI()

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

Get a feature of the structure in this scope.

invoke

common

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

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

map

common

abstract fun StructureND<T>.map(transform: S.(T) -> T): StructureND<T>

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

mapIndexed

common

abstract fun StructureND<T>.mapIndexed(transform: S.(index: IntArray, T) -> T): StructureND<T>

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

minus

common

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(b: StructureND<T>): StructureND<T>

Subtraction of two elements.

plus

common

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(b: StructureND<T>): StructureND<T>

Addition of two elements.

produce

common

abstract fun produce(initializer: S.(IntArray) -> T): StructureND<T>

Produces a new NDStructure using given initializer function.

unaryMinus

common

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

The negation of this element.

unaryOperation

common

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

Dynamically invokes a unary operation with the certain name.

unaryOperationFunction

common

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

Dynamically dispatches a unary operation with the certain name.

unaryPlus

common

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

Returns this value.

Properties

elementContext

common

abstract val elementContext: S

The algebra over elements of ND structure.

shape

common

abstract val shape: IntArray

The shape of ND-structures this algebra operates on.

zero

common

abstract val zero: StructureND<T>

The neutral element of addition.

Inheritors

RingND

BufferedGroupND

Extensions

contentEquals

common

@PerformancePitfall()

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

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

Sources

common source