kmath-dimensions/space.kscience.kmath.dimensions

Package-level declarations

Types

object D1 : Dimension

Type representing 1 dimension.

object D2 : Dimension

Type representing 2 dimensions.

object D3 : Dimension

Type representing 3 dimensions.

interface Dimension

Represents a quantity of dimensions in certain structure. This interface must be implemented only by objects.

interface DMatrix<out T, R : Dimension, C : Dimension> : Structure2D<T>

A matrix with compile-time controlled dimension

value class DMatrixContext<T : Any, out A : Ring<T>>(val context: LinearSpace<T, A>)

Basic operations on dimension-safe matrices. Operates on Matrix

value class DMatrixWrapper<out T, R : Dimension, C : Dimension>(structure: Structure2D<T>) : DMatrix<T, R, C>

An inline wrapper for a Matrix

interface DPoint<out T, D : Dimension> : Buffer<T>

Dimension-safe point

value class DPointWrapper<out T, D : Dimension>(val point: Point<T>) : DPoint<T, D>

Dimension-safe point wrapper

Functions

fun <D : Dimension> KClass<D>.dim(): Int

inline fun <D : Dimension> Dimension.Companion.dim(): Int

Finds Dimension.dim of given type D.

expect fun Dimension.Companion.of(dim: Int): Dimension

Finds or creates Dimension with Dimension.dim equal to dim.

actual fun Dimension.Companion.of(dim: Int): Dimension

actual fun Dimension.Companion.of(dim: Int): Dimension

actual fun Dimension.Companion.of(dim: Int): Dimension

inline fun <D : Dimension> DMatrixContext<Double, DoubleField>.one(): DMatrix<Double, D, D>

A square unit matrix

expect fun <D : Dimension> Dimension.Companion.resolve(type: KClass<D>): D

actual fun <D : Dimension> Dimension.Companion.resolve(type: KClass<D>): D

actual fun <D : Dimension> Dimension.Companion.resolve(type: KClass<D>): D

actual fun <D : Dimension> Dimension.Companion.resolve(type: KClass<D>): D

inline fun <R : Dimension, C : Dimension> DMatrixContext<Double, DoubleField>.zero(): DMatrix<Double, R, C>