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

Structure1D

interface Structure1D<out T> : StructureND<T> , Buffer<T>
Content copied to clipboard

A structure that is guaranteed to be one-dimensional

Types

Link copied to clipboard
object Companion
Content copied to clipboard

Functions

Link copied to clipboard
@PerformancePitfall
open 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(index: Int): T
Content copied to clipboard

Gets element at given index.

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.

Link copied to clipboard
open operator override fun iterator(): Iterator<T>
Content copied to clipboard

Iterates over all elements.

Properties

Link copied to clipboard
open override 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 override val shape: Shape
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.

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

The size of this buffer.

Inheritors

Link copied to clipboard

Sources

Link copied to clipboard