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.

invoke

@PerformancePitfall

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

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

leftSideNumberOperation

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

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

leftSideNumberOperationFunction

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

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

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.

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

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

Multiplies two elements.

number

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

Wraps a number to T object.

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.

power

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

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

Raises arg to the integer power pow.

rightSideNumberOperation

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

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

rightSideNumberOperationFunction

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

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

scale

abstract fun scale(a: StructureND<T>, value: Double): StructureND<T>

Scaling an element by a scalar.

structureND

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

Produces a new StructureND using given initializer function.

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.

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

Multiplication of this number by element.

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

Multiplication of this element by a scalar.

unaryMinus

abstract operator 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.

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

elementAlgebra

abstract val elementAlgebra: A

The algebra over elements of ND structure.

indices

open val indices: ShapeIndexer

one

open override val one: StructureND<T>

The neutral element of multiplication

shape

abstract val shape: Shape

zero

abstract val zero: StructureND<T>

The neutral element of addition.

Inheritors

DoubleFieldND

Sources

common source