kmath-core/space.kscience.kmath.nd

Package-level declarations

Types

interface AlgebraND<T, out C : Algebra<T>> : Algebra<StructureND<T>>

The base interface for all ND-algebra implementations.

interface BufferAlgebraND<T, out A : Algebra<T>> : AlgebraND<T, A>

open class BufferedFieldOpsND<T, out A : Field<T>>(bufferAlgebra: BufferAlgebra<T, A>, indexerBuilder: (ShapeND) -> ShapeIndexer = BufferAlgebraND.defaultIndexerBuilder) : BufferedRingOpsND<T, A> , FieldOpsND<T, A>

BufferedGroupNDOps

open class BufferedGroupNDOps<T, out A : Group<T>>(val bufferAlgebra: BufferAlgebra<T, A>, val indexerBuilder: (ShapeND) -> ShapeIndexer = BufferAlgebraND.defaultIndexerBuilder) : GroupOpsND<T, A> , BufferAlgebraND<T, A>

BufferedRingOpsND

open class BufferedRingOpsND<T, out A : Ring<T>>(bufferAlgebra: BufferAlgebra<T, A>, indexerBuilder: (ShapeND) -> ShapeIndexer = BufferAlgebraND.defaultIndexerBuilder) : BufferedGroupNDOps<T, A> , RingOpsND<T, A>

BufferND

open class BufferND<out T>(val indices: ShapeIndexer, val buffer: Buffer<T>) : StructureND<T>

Represents StructureND over Buffer.

ColumnStrides

class ColumnStrides(val shape: ShapeND) : Strides

Column-first Strides. Columns are represented as continuous arrays

DoubleBufferND

class DoubleBufferND(indexes: ShapeIndexer, val buffer: DoubleBuffer) : MutableBufferND<Double> , MutableStructureNDOfDouble

A simple mutable StructureND of doubles

DoubleFieldND

class DoubleFieldND(val shape: ShapeND) : DoubleFieldOpsND, FieldND<Double, DoubleField> , NumbersAddOps<StructureND<Double>> , ExtendedField<StructureND<Double>>

DoubleFieldOpsND

sealed class DoubleFieldOpsND : BufferedFieldOpsND<Double, DoubleField> , ScaleOperations<StructureND<Double>> , ExtendedFieldOps<StructureND<Double>>

FieldND

interface FieldND<T, out A : Field<T>> : Field<StructureND<T>> , FieldOpsND<T, A> , RingND<T, A> , WithShape

FieldOpsND

interface FieldOpsND<T, out A : Field<T>> : FieldOps<StructureND<T>> , RingOpsND<T, A> , ScaleOperations<StructureND<T>>

Field of StructureND.

GroupND

interface GroupND<T, out A : Group<T>> : Group<StructureND<T>> , GroupOpsND<T, A> , WithShape

GroupOpsND

interface GroupOpsND<T, out A : GroupOps<T>> : GroupOps<StructureND<T>> , AlgebraND<T, A>

Space of StructureND.

IndexOutOfShapeException

class IndexOutOfShapeException(val shape: ShapeND, val index: IntArray) : RuntimeException

IntBufferND

class IntBufferND(indexes: ShapeIndexer, val buffer: IntBuffer) : MutableBufferND<Int>

IntRingND

class IntRingND(val shape: ShapeND) : IntRingOpsND, RingND<Int, IntRing> , NumbersAddOps<StructureND<Int>>

IntRingOpsND

sealed class IntRingOpsND : BufferedRingOpsND<Int, IntRing>

MutableBufferND

open class MutableBufferND<T>(strides: ShapeIndexer, val buffer: MutableBuffer<T>) : BufferND<T> , MutableStructureND<T>

Represents MutableStructureND over MutableBuffer.

MutableStructure1D

interface MutableStructure1D<T> : Structure1D<T> , MutableStructureND<T> , MutableBuffer<T>

A mutable structure that is guaranteed to be one-dimensional

MutableStructure2D

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

Represents mutable Structure2D.

MutableStructureND

interface MutableStructureND<T> : StructureND<T>

Represents mutable StructureND.

MutableStructureNDOfDouble

interface MutableStructureNDOfDouble : StructureNDOfDouble, MutableStructureND<Double>

PermutedMutableStructureND

class PermutedMutableStructureND<T>(val origin: MutableStructureND<T>, val shape: ShapeND = origin.shape, val permutation: (IntArray) -> IntArray) : MutableStructureND<T>

PermutedStructureND

class PermutedStructureND<T>(val origin: StructureND<T>, val permutation: (IntArray) -> IntArray) : StructureND<T>

RingND

interface RingND<T, out A : Ring<T>> : Ring<StructureND<T>> , RingOpsND<T, A> , GroupND<T, A> , WithShape

RingOpsND

interface RingOpsND<T, out A : RingOps<T>> : RingOps<StructureND<T>> , GroupOpsND<T, A>

Ring of StructureND.

RowStrides

class RowStrides(val shape: ShapeND) : Strides

This Strides implementation follows the last dimension first convention For more information: https://numpy.org/doc/stable/reference/generated/numpy.ndarray.strides.html

ShapeIndexer

interface ShapeIndexer : Iterable<IntArray>

A converter from linear index to multivariate index

ShapeMismatchException

class ShapeMismatchException(val expected: ShapeND, val actual: ShapeND) : RuntimeException

An exception is thrown when the expected and actual shape of NDArray differ.

ShapeND

@JvmInline

value class ShapeND(array: IntArray)

A read-only ND shape

ShortRingND

class ShortRingND(val shape: ShapeND) : ShortRingOpsND, RingND<Short, ShortRing> , NumbersAddOps<StructureND<Short>>

ShortRingOpsND

sealed class ShortRingOpsND : BufferedRingOpsND<Short, ShortRing>

Strides

abstract class Strides : ShapeIndexer

Linear transformation of indexes

Structure1D

interface Structure1D<out T> : StructureND<T> , Buffer<T>

A structure that is guaranteed to be one-dimensional

Structure2D

interface Structure2D<out T> : StructureND<T>

A structure that is guaranteed to be two-dimensional.

StructureFeature

interface StructureFeature : Feature<StructureFeature>

StructureND

interface StructureND<out T> : Featured<StructureFeature> , WithShape

Represents n-dimensional structure i.e., multidimensional container of items of the same type and size. The number of dimensions and items in an array is defined by its shape, which is a sequence of non-negative integers that specify the sizes of each dimension.

StructureNDOfDouble

interface StructureNDOfDouble : StructureND<Double>

StructureNDOfInt

interface StructureNDOfInt : StructureND<Int>

VirtualDoubleStructureND

@UnstableKMathAPI