kmath-core/space.kscience.kmath.nd/MutableStructureND

MutableStructureND

interface MutableStructureND<T> : StructureND<T>

Represents mutable StructureND.

Functions

elements

@PerformancePitfall

open fun elements(): Sequence<Pair<IntArray, T>>

Returns the sequence of all the elements associated by their indices.

get

abstract operator fun get(index: IntArray): T

Returns the value at the specified indices.

getFeature

open override fun <F : StructureFeature> getFeature(type: KClass<out F>): F?

Feature is some additional structure information that allows to access it special properties or hints. If the feature is not present, null is returned.

set

abstract operator fun set(index: IntArray, value: T)

Inserts an item at the specified indices.

Properties

dimension

open val dimension: Int

The count of dimensions in this structure. It should be equal to size of shape.

indices

open val indices: ShapeIndexer

shape

abstract override val shape: Shape

The shape of structure i.e., non-empty sequence of non-negative integers that specify sizes of dimensions of this structure.

Inheritors

MutableBufferND

MutableStructure1D

MutableStructure2D

Extensions

as1D

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

as2D

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

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

mapInPlace

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

Transform a structure element-by element in place.

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

Sources

common source