AlgebraND

interface AlgebraND<T, out C : Algebra<T>>

The base interface for all ND-algebra implementations.

Parameters

the type of ND-structure element.

the type of the element context.

Types

Companion

common

object Companion

Functions

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: C.(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: C.(index: IntArray, T) -> T): StructureND<T>

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

structureND

common

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

Produces a new StructureND using given initializer function.

zip

common

abstract fun zip(left: StructureND<T>, right: StructureND<T>, transform: C.(T, T) -> T): StructureND<T>

Combines two structures into one.

Properties

elementAlgebra

common

abstract val elementAlgebra: C

The algebra over elements of ND structure.

Inheritors

GroupOpsND

BufferAlgebraND

Extensions

contentEquals

common

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

getFeature

common

@UnstableKMathAPI()

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

Get a feature of the structure in this scope.

one

common

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

@JvmName(name = oneVarArg)

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

structureND

common

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

zero

common

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

@JvmName(name = zeroVarArg)

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

Sources

common source