kmath-core/space.kscience.kmath.linear/MatrixWrapper

MatrixWrapper

class MatrixWrapper<out T : Any> : Structure2D<T>

A Matrix that holds MatrixFeature objects.

Parameters

the type of items.

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.

open operator override 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?

Get the first feature matching given class. Does not guarantee that matrix has only one feature matching the criteria.

toString

open override fun toString(): String

Properties

colNum

open override val colNum: Int

The number of columns in this structure.

columns

@PerformancePitfall

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

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

dimension

open override val dimension: Int

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

features

val features: FeatureSet<StructureFeature>

indices

open override val indices: ShapeIndexer

origin

val origin: Matrix<T>

rowNum

open override val rowNum: Int

The number of rows in this structure.

rows

@PerformancePitfall

open override val rows: List<Buffer<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