Represents n-dimensional structure i.e., multidimensional container of items of the same type and size. The number of dimensions and items in an array is defined by its shape, which is a sequence of non-negative integers that specify the sizes of each dimension.

WithShape

interface WithShape

Functions

as1D

fun <T> MutableStructureND<T>.as1D(): MutableStructure1D<T>

fun <T> StructureND<T>.as1D(): Structure1D<T>

Represent a StructureND as Structure1D. Throw error in case of dimension mismatch.

as2D

fun <T> MutableStructureND<T>.as2D(): MutableStructure2D<T>

fun <T> StructureND<T>.as2D(): Structure2D<T>

Represents a StructureND as Structure2D. Throws runtime error in case of dimension mismatch.

asND

fun <T> Buffer<T>.asND(): Structure1D<T>

Represent this buffer as 1D structure

contentEquals

@PerformancePitfall

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

@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>> LinearSpace<T, Ring<T>>.contentEquals(st1: StructureND<T>, st2: StructureND<T>, absoluteTolerance: T): Boolean

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

get

operator fun <T> StructureND<T>.get(vararg index: Int): T

Returns the value at the specified indices.

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.

mapInline

inline fun <T, A : Algebra<T>> BufferAlgebraND<T, A>.mapInline(arg: BufferND<T>, crossinline transform: A.(T) -> T): BufferND<T>

mapInPlace

inline fun <T> MutableStructureND<T>.mapInPlace(action: (index: IntArray, T) -> T)

Transform a structure element-by element in place.

mapToBuffer

inline fun <T, R : Any> StructureND<T>.mapToBuffer(crossinline transform: (T) -> R): BufferND<R>

Transform structure to a new structure using inferred BufferFactory

inline fun <T, R : Any> StructureND<T>.mapToBuffer(factory: BufferFactory<R>, crossinline transform: (T) -> R): BufferND<R>

Transform structure to a new structure using provided BufferFactory and optimizing if argument is BufferND

mapToMutableBuffer

inline fun <T, R : Any> MutableStructureND<T>.mapToMutableBuffer(factory: MutableBufferFactory<R> = MutableBuffer.Companion::auto, crossinline transform: (T) -> R): MutableBufferND<R>

Transform structure to a new structure using provided MutableBufferFactory and optimizing if argument is MutableBufferND

ndAlgebra

fun DoubleField.ndAlgebra(vararg shape: Int): DoubleFieldND

one

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>

Shape

fun Shape(shapeFirst: Int, vararg shapeRest: Int): Shape

structureND

fun <T, EA : Algebra<T>, A : BufferAlgebraND<T, EA>, WithShape> A.structureND(initializer: EA.(IntArray) -> T): BufferND<T>

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>

withNdAlgebra

@UnstableKMathAPI

inline fun <R> DoubleField.withNdAlgebra(vararg shape: Int, action: DoubleFieldND.() -> R): R

Produce a context for n-dimensional operations inside this real field

inline fun <R> ShortRing.withNdAlgebra(vararg shape: Int, action: ShortRingND.() -> R): R

zero

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>

zip

inline fun <T : Any> StructureND<T>.zip(struct: StructureND<T>, crossinline block: (T, T) -> T): StructureND<T>

Properties

val <T, A : Group<T>> BufferAlgebra<T, A>.nd: BufferedGroupNDOps<T, A>

val <T, A : Ring<T>> BufferAlgebra<T, A>.nd: BufferedRingOpsND<T, A>

val <T, A : Field<T>> BufferAlgebra<T, A>.nd: BufferedFieldOpsND<T, A>

ndAlgebra

val DoubleField.ndAlgebra: DoubleFieldOpsND