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

MutableStructure2D

interface MutableStructure2D<T> : Structure2D<T> , MutableStructureND<T>

Represents mutable Structure2D.

Functions

elements

@PerformancePitfall

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

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

get

open operator override fun get(index: IntArray): T

Returns the value at the specified indices.

abstract operator fun get(i: Int, j: Int): T

Retrieves an element from the structure by two 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)

abstract operator fun set(i: Int, j: Int, value: T)

Inserts an item at the specified indices.

Properties

colNum

abstract val colNum: Int

The number of columns in this structure.

columns

@PerformancePitfall

open override val columns: List<MutableStructure1D<T>>

The buffer of columns of this structure. It gets elements from the structure dynamically.

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

rowNum

abstract val rowNum: Int

The number of rows in this structure.

rows

@PerformancePitfall

open override val rows: List<MutableStructure1D<T>>

The buffer of rows of this structure. It gets elements from the structure dynamically.

shape

open override val shape: IntArray

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

Sources

common source