Package space.kscience.kmath.nd

Types

AlgebraND

common

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

The base interface for all ND-algebra implementations.

BufferAlgebraND

common

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

BufferedFieldND

common

open class BufferedFieldND<T, out R : Field<T>>(shape: IntArray, elementContext: R, bufferFactory: BufferFactory<T>) : BufferedRingND<T, R> , FieldND<T, R>

BufferedGroupND

common

open class BufferedGroupND<T, out A : Group<T>>(shape: IntArray, elementContext: A, bufferFactory: BufferFactory<T>) : GroupND<T, A> , BufferAlgebraND<T, A>

BufferedRingND

common

open class BufferedRingND<T, out R : Ring<T>>(shape: IntArray, elementContext: R, bufferFactory: BufferFactory<T>) : BufferedGroupND<T, R> , RingND<T, R>

BufferND

common

open class BufferND<out T>(strides: Strides, buffer: Buffer<T>) : StructureND<T>

Represents StructureND over Buffer.

DefaultStrides

common

class DefaultStrides : Strides

Simple implementation of Strides.

DoubleFieldND

common

class DoubleFieldND(shape: IntArray) : BufferedFieldND<Double, DoubleField> , NumbersAddOperations<StructureND<Double>> , ScaleOperations<StructureND<Double>> , ExtendedField<StructureND<Double>>

FieldND

common

interface FieldND<T, out F : Field<T>> : Field<StructureND<T>> , RingND<T, F>

Field of StructureND.

GroupND

common

interface GroupND<T, out S : Group<T>> : Group<StructureND<T>> , AlgebraND<T, S>

Space of StructureND.

MutableBufferND

common

class MutableBufferND<T>(strides: Strides, mutableBuffer: MutableBuffer<T>) : BufferND<T> , MutableStructureND<T>

Represents MutableStructureND over MutableBuffer.

MutableStructure1D

common

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

A mutable structure that is guaranteed to be one-dimensional

MutableStructure2D

common

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

Represents mutable Structure2D.

MutableStructureND

common

interface MutableStructureND<T> : StructureND<T>

Represents mutable StructureND.

RingND

common

interface RingND<T, out R : Ring<T>> : Ring<StructureND<T>> , GroupND<T, R>

Ring of StructureND.

ShapeMismatchException

common

class ShapeMismatchException(expected: IntArray, actual: IntArray) : RuntimeException

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

ShortRingND

common

class ShortRingND(shape: IntArray) : BufferedRingND<Short, ShortRing> , NumbersAddOperations<StructureND<Short>>

Strides

common

interface Strides

A way to convert ND indices to linear one and back.

Structure1D

common

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

A structure that is guaranteed to be one-dimensional

Structure2D

common

interface Structure2D<out T> : StructureND<T>

A structure that is guaranteed to be two-dimensional.

StructureFeature

common

interface StructureFeature : Feature<StructureFeature>

StructureND

common

interface StructureND<out T> : Featured<StructureFeature>

Represents n-dimensional structure i.e., multidimensional container of items of the same type and size.

Functions

as1D

common

fun <T> MutableStructureND<T>.as1D(): MutableStructure1D<T>

fun <T> StructureND<T>.as1D(): Structure1D<T>

Represent a StructureND as Structure1D.

as2D

common

fun <T> MutableStructureND<T>.as2D(): MutableStructure2D<T>

Represents a StructureND as Structure2D.

fun <T> StructureND<T>.as2D(): Structure2D<T>

Represents a StructureND as Structure2D.

asND

common

fun <T> Buffer<T>.asND(): Structure1D<T>

Represent this buffer as 1D structure

autoNdAlgebra

common

@UnstableKMathAPI()

inline fun <T : Any, A : Field<T>> A.autoNdAlgebra(vararg shape: Int): FieldND<T, A>

Create a FieldND for this Field inferring proper buffer factory from the type

combine

common

inline fun <T : Any> StructureND<T>.combine(struct: StructureND<T>, crossinline block: (T, T) -> T): StructureND<T>

contentEquals

common

@PerformancePitfall()

fun <T : Comparable<T>> LinearSpace<T, Ring<T>>.contentEquals(st1: StructureND<T>, st2: StructureND<T>): Boolean

Indicates whether some StructureND is equal to another one.

@PerformancePitfall()

fun <T : Comparable<T>> AlgebraND<T, Ring<T>>.contentEquals(st1: StructureND<T>, st2: StructureND<T>): Boolean

Indicates whether some StructureND is equal to another one.

@PerformancePitfall()

fun <T : Comparable<T>> LinearSpace<T, Ring<T>>.contentEquals(st1: StructureND<T>, st2: StructureND<T>, absoluteTolerance: T): Boolean

Indicates whether some StructureND is equal to another one with absoluteTolerance.

@PerformancePitfall()

fun <T : Comparable<T>> GroupND<T, Ring<T>>.contentEquals(st1: StructureND<T>, st2: StructureND<T>, absoluteTolerance: T): Boolean

Indicates whether some StructureND is equal to another one with absoluteTolerance.

get

common

operator fun <T> StructureND<T>.get(vararg index: Int): T

Returns the value at the specified indices.

getFeature

common

@UnstableKMathAPI()

inline fun <T : Any, F : StructureFeature> AlgebraND<T, *>.getFeature(structure: StructureND<T>): F?

Get a feature of the structure in this scope.

mapInPlace

common

inline fun <T> MutableStructureND<T>.mapInPlace(action: (IntArray, T) -> T)

Transform a structure element-by element in place.

mapToBuffer

common

inline fun <T, R : Any> StructureND<T>.mapToBuffer(factory: BufferFactory<R> = Buffer.Companion::auto, crossinline transform: (T) -> R): BufferND<R>

Transform structure to a new structure using provided BufferFactory and optimizing if argument is BufferND

mapToMutableBuffer

common

inline fun <T, R : Any> MutableStructureND<T>.mapToMutableBuffer(factory: MutableBufferFactory<R> = MutableBuffer.Companion::auto, crossinline transform: (T) -> R): MutableBufferND<R>

Transform structure to a new structure using provided MutableBufferFactory and optimizing if argument is MutableBufferND

ndAlgebra

common

fun DoubleField.ndAlgebra(vararg shape: Int): DoubleFieldND

fun <T, A : Field<T>> A.ndAlgebra(bufferFactory: BufferFactory<T>, vararg shape: Int): BufferedFieldND<T, A>

fun <T, A : Group<T>> A.ndAlgebra(bufferFactory: BufferFactory<T>, vararg shape: Int): BufferedGroupND<T, A>

fun <T, A : Ring<T>> A.ndAlgebra(bufferFactory: BufferFactory<T>, vararg shape: Int): BufferedRingND<T, A>

produceInline

common

inline fun BufferedRingND<Short, ShortRing>.produceInline(crossinline initializer: ShortRing.(Int) -> Short): BufferND<Short>

Fast element production using function inlining.

withNdAlgebra

common

inline fun <R> DoubleField.withNdAlgebra(vararg shape: Int, action: DoubleFieldND.() -> R): R

Produce a context for n-dimensional operations inside this real field

inline fun <R> ShortRing.withNdAlgebra(vararg shape: Int, action: ShortRingND.() -> R): R

@JvmName(name = withNdField)

inline fun <T, A : Field<T>, R> A.withNdAlgebra(noinline bufferFactory: BufferFactory<T>, vararg shape: Int, action: BufferedFieldND<T, A>.() -> R): R

@JvmName(name = withNdGroup)

inline fun <T, A : Group<T>, R> A.withNdAlgebra(noinline bufferFactory: BufferFactory<T>, vararg shape: Int, action: BufferedGroupND<T, A>.() -> R): R

@JvmName(name = withNdRing)

inline fun <T, A : Ring<T>, R> A.withNdAlgebra(noinline bufferFactory: BufferFactory<T>, vararg shape: Int, action: BufferedRingND<T, A>.() -> R): R