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

Structure2D

interface Structure2D<out T> : StructureND<T>
Content copied to clipboard

A structure that is guaranteed to be two-dimensional.

Parameters

T

the type of items.

Types

Link copied to clipboard
object Companion
Content copied to clipboard

Functions

Link copied to clipboard
@PerformancePitfall
open override fun elements(): Sequence<Pair<IntArray, T>>
Content copied to clipboard

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

Link copied to clipboard
open operator override fun get(index: IntArray): T
Content copied to clipboard

Returns the value at the specified indices.

abstract operator fun get(i: Int, j: Int): T
Content copied to clipboard

Retrieves an element from the structure by two indices.

Link copied to clipboard
open override fun <F : StructureFeature> getFeature(type: KClass<out F>): F?
Content copied to clipboard

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

Properties

Link copied to clipboard
abstract val colNum: Int
Content copied to clipboard

The number of columns in this structure.

Link copied to clipboard
@PerformancePitfall
open val columns: List<Buffer<T>>
Content copied to clipboard

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

Link copied to clipboard
open val dimension: Int
Content copied to clipboard

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

Link copied to clipboard
open val indices: ShapeIndexer
Content copied to clipboard
Link copied to clipboard
abstract val rowNum: Int
Content copied to clipboard

The number of rows in this structure.

Link copied to clipboard
@PerformancePitfall
open val rows: List<Buffer<T>>
Content copied to clipboard

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

Link copied to clipboard
open override val shape: IntArray
Content copied to clipboard

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

Inheritors

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Extensions

Link copied to clipboard
@UnstableKMathAPI
fun <T> Structure2D<T>.asColumnarData(mapping: Map<Symbol, Int>): ColumnarData<T>
Content copied to clipboard

A zero-copy method to represent a Structure2D as a two-column x-y data. There could more than two columns in the structure.

Link copied to clipboard
@UnstableKMathAPI
fun <T> Structure2D<T>.asXYData(xIndex: Int = 0, yIndex: Int = 1): XYColumnarData<T, T, T>
Content copied to clipboard

A zero-copy method to represent a Structure2D as a two-column x-y data. There could more than two columns in the structure.

Sources

Link copied to clipboard