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>

BufferedFieldOpsND

common

open class BufferedFieldOpsND<T, out A : Field<T>>(bufferAlgebra: BufferAlgebra<T, A>, indexerBuilder: (IntArray) -> ShapeIndex) : BufferedRingOpsND<T, A> , FieldOpsND<T, A>

BufferedGroupNDOps

common

open class BufferedGroupNDOps<T, out A : Group<T>>(bufferAlgebra: BufferAlgebra<T, A>, indexerBuilder: (IntArray) -> ShapeIndex) : GroupOpsND<T, A> , BufferAlgebraND<T, A>

BufferedRingOpsND

common

open class BufferedRingOpsND<T, out A : Ring<T>>(bufferAlgebra: BufferAlgebra<T, A>, indexerBuilder: (IntArray) -> ShapeIndex) : BufferedGroupNDOps<T, A> , RingOpsND<T, A>

BufferND

common

open class BufferND<out T>(indexes: ShapeIndex, buffer: Buffer<T>) : StructureND<T>

Represents StructureND over Buffer.

DefaultStrides

common

class DefaultStrides : Strides

Simple implementation of Strides.

DoubleBufferND

common

class DoubleBufferND(indexes: ShapeIndex, buffer: DoubleBuffer) : BufferND<Double>

DoubleFieldND

common

class DoubleFieldND(shape: Shape) : DoubleFieldOpsND, FieldND<Double, DoubleField> , NumbersAddOps<StructureND<Double>>

DoubleFieldOpsND

common

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

FieldND

common

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

FieldOpsND

common

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

Field of StructureND.

GroupND

common

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

GroupOpsND

common

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

Space of StructureND.

MutableBufferND

common

class MutableBufferND<T>(strides: ShapeIndex, buffer: 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 A : Ring<T>> : Ring<StructureND<T>> , RingOpsND<T, A> , GroupND<T, A> , WithShape

RingOpsND

common

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

Ring of StructureND.

Shape

common

typealias Shape = IntArray

ShapeIndex

common

interface ShapeIndex

A converter from linear index to multivariate index

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: Shape) : ShortRingOpsND, RingND<Short, ShortRing> , NumbersAddOps<StructureND<Short>>

ShortRingOpsND

common

sealed class ShortRingOpsND : BufferedRingOpsND<Short, ShortRing>

Strides

common

abstract class Strides : ShapeIndex

Linear transformation of indexes

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.

WithShape

common

interface WithShape

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

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>> GroupOpsND<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.

mapInline

common

inline fun <T, A : Algebra<T>> BufferAlgebraND<T, A>.mapInline(arg: BufferND<T>, crossinline transform: A.(T) -> T): BufferND<T>

mapInPlace

common

inline fun <T> MutableStructureND<T>.mapInPlace(action: (index: 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

one

common

fun <T, A : Ring<T>> AlgebraND<T, A>.one(shape: Shape): StructureND<T>

@JvmName(name = oneVarArg)

fun <T, A : Ring<T>> AlgebraND<T, A>.one(shapeFirst: Int, vararg shapeRest: Int): StructureND<T>

Shape

common

fun Shape(shapeFirst: Int, vararg shapeRest: Int): Shape

structureND

common

fun <T, EA : Algebra<T>, A : BufferAlgebraND<T, EA>, WithShape> A.structureND(initializer: EA.(IntArray) -> T): BufferND<T>

fun <T, A : Algebra<T>> BufferAlgebraND<T, A>.structureND(vararg shape: Int, initializer: A.(IntArray) -> T): BufferND<T>

fun <T, A : Algebra<T>> AlgebraND<T, A>.structureND(shapeFirst: Int, vararg shapeRest: Int, initializer: A.(IntArray) -> T): StructureND<T>

withNdAlgebra

common

@UnstableKMathAPI()

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

zero

common

fun <T, A : Group<T>> AlgebraND<T, A>.zero(shape: Shape): StructureND<T>

@JvmName(name = zeroVarArg)

fun <T, A : Group<T>> AlgebraND<T, A>.zero(shapeFirst: Int, vararg shapeRest: Int): StructureND<T>

zip

common

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

Properties

common

val <T, A : Group<T>> BufferAlgebra<T, A>.nd: BufferedGroupNDOps<T, A>

common

val <T, A : Ring<T>> BufferAlgebra<T, A>.nd: BufferedRingOpsND<T, A>

common

val <T, A : Field<T>> BufferAlgebra<T, A>.nd: BufferedFieldOpsND<T, A>

ndAlgebra

common

val DoubleField.ndAlgebra: DoubleFieldOpsND