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<Short>, 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 (Short) -> Short.invoke(structure: StructureND<Short>): StructureND<Short>

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

leftSideNumberOperation

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

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

leftSideNumberOperationFunction

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

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<Short>.map(transform: ShortRing.(Short) -> Short): StructureND<Short>

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<Short>.mapIndexed(transform: ShortRing.(index: IntArray, Short) -> Short): StructureND<Short>

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 Short.minus(arg: StructureND<Short>): StructureND<Short>

Subtracts an ND structure from an element of it.

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

Subtracts an element from ND structure of it.

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

Subtraction of two elements.

open operator fun Number.minus(other: StructureND<Short>): StructureND<Short>

Subtraction of number from element.

open operator fun StructureND<Short>.minus(other: Number): StructureND<Short>

Subtraction of element from number.

multiply

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

Element-wise multiplication.

number

open override fun number(value: Number): BufferND<Short>

Wraps a number to T object.

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 Short.plus(arg: StructureND<Short>): StructureND<Short>

Adds an element to ND structure of it.

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

Adds an ND structure to an element of it.

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

Addition of two elements.

open operator fun Number.plus(other: StructureND<Short>): StructureND<Short>

Addition of scalar and element.

open operator fun StructureND<Short>.plus(other: Number): StructureND<Short>

Addition of element and scalar.

power

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

Raises arg to the integer power pow.

rightSideNumberOperation

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

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

rightSideNumberOperationFunction

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

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

structureND

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

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>

sum

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.

times

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

Multiplies an element by a ND structure of it.

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

Multiplies an ND structure by an element of it.

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

Multiplies this element by scalar.

toBufferND

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

unaryMinus

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

The negation of this element.

unaryOperation

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

Dynamically invokes a unary operation with the certain name.

unaryOperationFunction

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

Dynamically dispatches a unary operation with the certain name.

unaryPlus

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

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<Short>, right: StructureND<Short>, transform: ShortRing.(Short, Short) -> Short): StructureND<Short>

Combines two structures into one.

Properties

bufferAlgebra

open override val bufferAlgebra: BufferAlgebra<Short, ShortRing>

bufferFactory

open val bufferFactory: MutableBufferFactory<StructureND<Short>>

Provide a factory for buffers, associated with this Algebra

val <T> NumericAlgebra<T>.e: T

The e mathematical constant.

elementAlgebra

abstract val elementAlgebra: ShortRing

The algebra over elements of ND structure.

indexerBuilder

open override val indexerBuilder: (ShapeND) -> ShapeIndexer

indices

open val indices: ShapeIndexer

one

open override val one: StructureND<Short>

The neutral element of multiplication

val <T> NumericAlgebra<T>.pi: T

The π mathematical constant.

shape

open override val shape: ShapeND

zero

abstract val zero: StructureND<Short>

The neutral element of addition.