class NDArray<T, D : Dimension>( data: ImmutableMemoryView<T>, val offset: Int = 0, val shape: IntArray, val strides: IntArray = computeStrides(shape), val dim: D, val base: MultiArray<T, out Dimension>? = null) : MutableMultiArray<T, D>

A class that implements multidimensional arrays. This implementation is based on primitive arrays. With the help of offset, shape, strides there is a multidimensionality representation over a sequential homogeneous array.

NDArrayIterator

class NDArrayIterator<T>( data: MemoryView<T>, offset: Int = 0, strides: IntArray, shape: IntArray) : Iterator<T>

Iterator over multidimensional arrays. Iterated taking into account the offset, strides and shape.

ReadableView

class ReadableView<T>(base: MultiArray<T, DN>)

RInt

@JvmInline

value class RInt(data: Int) : Indexing

Helper class for indexing. Since the standard rangeTo overrides the rangeTo for slices.

typealias sl = Slice.Companion

Alias name for Slice.

Slice

class Slice( start: Int, stop: Int, step: Int) : Indexing, ClosedRange<Int>

Slice class. An analogue of slices in python.

SliceEndStub

class SliceEndStub

Convenient Slice for stop stub.

SliceStartStub

class SliceStartStub

Convenient Slice for start stub.

WritableView

class WritableView<T>(base: MutableMultiArray<T, DN>)

Functions

asDNArray

fun <T, D : Dimension> MultiArray<T, D>.asDNArray(): NDArray<T, DN>

checkBounds

inline fun checkBounds( value: Boolean, index: Int, axis: Int, size: Int)

compareTo

operator fun <T : Number> Number.compareTo(other: T): Int

dimensionClassOf

inline fun <D : Dimension> dimensionClassOf(dim: Int = -1): D

dimensionOf

inline fun <D : Dimension> dimensionOf(dim: Int): D

Returns specific Dimension by integer dim.

downTo

infix fun IntArray.downTo(to: IntArray): MultiIndexProgression

Returns multidimensional index from highest to lowest in the step of -1.

get

@JvmName(name = "get0")

operator fun <T> MultiArray<T, D1>.get(index: Int): T

@JvmName(name = "get12")

operator fun <T> MultiArray<T, D1>.get(index: ClosedRange<Int>): MultiArray<T, D1>

@JvmName(name = "get1")

operator fun <T> MultiArray<T, D2>.get(index: Int): MultiArray<T, D1>

@JvmName(name = "get13")

operator fun <T> MultiArray<T, D2>.get(index: ClosedRange<Int>): MultiArray<T, D2>

@JvmName(name = "get3")

operator fun <T> MultiArray<T, D3>.get(index: Int): MultiArray<T, D2>

@JvmName(name = "get17")

operator fun <T> MultiArray<T, D3>.get(index: ClosedRange<Int>): MultiArray<T, D3>

@JvmName(name = "get6")

operator fun <T> MultiArray<T, D4>.get(index: Int): MultiArray<T, D3>

@JvmName(name = "get28")

operator fun <T> MultiArray<T, D4>.get(index: ClosedRange<Int>): MultiArray<T, D4>

@JvmName(name = "get10")

operator fun <T> MultiArray<T, DN>.get(vararg index: Int): T

@JvmName(name = "get11")

operator fun <T> MultiArray<T, DN>.get(index: IntArray): T

@JvmName(name = "get2")

operator fun <T> MultiArray<T, D2>.get(ind1: Int, ind2: Int): T

@JvmName(name = "get15")

operator fun <T> MultiArray<T, D2>.get(ind1: Int, ind2: ClosedRange<Int>): MultiArray<T, D1>

@JvmName(name = "get16")

operator fun <T> MultiArray<T, D2>.get(ind1: ClosedRange<Int>, ind2: Int): MultiArray<T, D1>

@JvmName(name = "get14")

operator fun <T> MultiArray<T, D2>.get(ind1: ClosedRange<Int>, ind2: ClosedRange<Int>): MultiArray<T, D2>

@JvmName(name = "get4")

operator fun <T> MultiArray<T, D3>.get(ind1: Int, ind2: Int): MultiArray<T, D1>

@JvmName(name = "get19")

operator fun <T> MultiArray<T, D3>.get(ind1: Int, ind2: ClosedRange<Int>): MultiArray<T, D2>

@JvmName(name = "get20")

operator fun <T> MultiArray<T, D3>.get(ind1: ClosedRange<Int>, ind2: Int): MultiArray<T, D2>

@JvmName(name = "get18")

operator fun <T> MultiArray<T, D3>.get(ind1: ClosedRange<Int>, ind2: ClosedRange<Int>): MultiArray<T, D3>

@JvmName(name = "get7")

operator fun <T> MultiArray<T, D4>.get(ind1: Int, ind2: Int): MultiArray<T, D2>

@JvmName(name = "get30")

operator fun <T> MultiArray<T, D4>.get(ind1: Int, ind2: ClosedRange<Int>): MultiArray<T, D3>

@JvmName(name = "get31")

operator fun <T> MultiArray<T, D4>.get(ind1: ClosedRange<Int>, ind2: Int): MultiArray<T, D3>

@JvmName(name = "get29")

operator fun <T> MultiArray<T, D4>.get(ind1: ClosedRange<Int>, ind2: ClosedRange<Int>): MultiArray<T, D4>

@JvmName(name = "get1")

operator fun <T> MutableMultiArray<T, D2>.get(write: WritableView.Companion, index: Int): MutableMultiArray<T, D1>

@JvmName(name = "get3")

operator fun <T> MutableMultiArray<T, D3>.get(write: WritableView.Companion, index: Int): MutableMultiArray<T, D2>

@JvmName(name = "get6")

operator fun <T> MutableMultiArray<T, D4>.get(write: WritableView.Companion, index: Int): MutableMultiArray<T, D3>

@JvmName(name = "get5")

operator fun <T> MultiArray<T, D3>.get( ind1: Int, ind2: Int, ind3: Int): T

@JvmName(name = "get22")

operator fun <T> MultiArray<T, D3>.get( ind1: Int, ind2: Int, ind3: ClosedRange<Int>): MultiArray<T, D1>

@JvmName(name = "get23")

operator fun <T> MultiArray<T, D3>.get( ind1: Int, ind2: ClosedRange<Int>, ind3: Int): MultiArray<T, D1>

@JvmName(name = "get25")

operator fun <T> MultiArray<T, D3>.get( ind1: Int, ind2: ClosedRange<Int>, ind3: ClosedRange<Int>): MultiArray<T, D2>

@JvmName(name = "get24")

operator fun <T> MultiArray<T, D3>.get( ind1: ClosedRange<Int>, ind2: Int, ind3: Int): MultiArray<T, D1>

@JvmName(name = "get27")

operator fun <T> MultiArray<T, D3>.get( ind1: ClosedRange<Int>, ind2: Int, ind3: ClosedRange<Int>): MultiArray<T, D2>

@JvmName(name = "get26")

operator fun <T> MultiArray<T, D3>.get( ind1: ClosedRange<Int>, ind2: ClosedRange<Int>, ind3: Int): MultiArray<T, D2>

@JvmName(name = "get21")

operator fun <T> MultiArray<T, D3>.get( ind1: ClosedRange<Int>, ind2: ClosedRange<Int>, ind3: ClosedRange<Int>): MultiArray<T, D3>

@JvmName(name = "get8")

operator fun <T> MultiArray<T, D4>.get( ind1: Int, ind2: Int, ind3: Int): MultiArray<T, D1>

@JvmName(name = "get33")

operator fun <T> MultiArray<T, D4>.get( ind1: Int, ind2: Int, ind3: ClosedRange<Int>): MultiArray<T, D2>

@JvmName(name = "get34")

operator fun <T> MultiArray<T, D4>.get( ind1: Int, ind2: ClosedRange<Int>, ind3: Int): MultiArray<T, D2>

@JvmName(name = "get36")

operator fun <T> MultiArray<T, D4>.get( ind1: Int, ind2: ClosedRange<Int>, ind3: ClosedRange<Int>): MultiArray<T, D3>

@JvmName(name = "get35")

operator fun <T> MultiArray<T, D4>.get( ind1: ClosedRange<Int>, ind2: Int, ind3: Int): MultiArray<T, D2>

@JvmName(name = "get38")

operator fun <T> MultiArray<T, D4>.get( ind1: ClosedRange<Int>, ind2: Int, ind3: ClosedRange<Int>): MultiArray<T, D3>

@JvmName(name = "get37")

operator fun <T> MultiArray<T, D4>.get( ind1: ClosedRange<Int>, ind2: ClosedRange<Int>, ind3: Int): MultiArray<T, D3>

@JvmName(name = "get32")

operator fun <T> MultiArray<T, D4>.get( ind1: ClosedRange<Int>, ind2: ClosedRange<Int>, ind3: ClosedRange<Int>): MultiArray<T, D4>

@JvmName(name = "get4")

operator fun <T> MutableMultiArray<T, D3>.get( write: WritableView.Companion, ind1: Int, ind2: Int): MultiArray<T, D1>

@JvmName(name = "get7")

operator fun <T> MutableMultiArray<T, D4>.get( write: WritableView.Companion, ind1: Int, ind2: Int): MultiArray<T, D2>

@JvmName(name = "get9")

operator fun <T> MultiArray<T, D4>.get( ind1: Int, ind2: Int, ind3: Int, ind4: Int): T

@JvmName(name = "get39")

operator fun <T> MultiArray<T, D4>.get( ind1: Int, ind2: Int, ind3: Int, ind4: ClosedRange<Int>): MultiArray<T, D1>

@JvmName(name = "get40")

operator fun <T> MultiArray<T, D4>.get( ind1: Int, ind2: Int, ind3: ClosedRange<Int>, ind4: Int): MultiArray<T, D1>

@JvmName(name = "get43")

operator fun <T> MultiArray<T, D4>.get( ind1: Int, ind2: Int, ind3: ClosedRange<Int>, ind4: ClosedRange<Int>): MultiArray<T, D2>

@JvmName(name = "get41")

operator fun <T> MultiArray<T, D4>.get( ind1: Int, ind2: ClosedRange<Int>, ind3: Int, ind4: Int): MultiArray<T, D1>

@JvmName(name = "get46")

operator fun <T> MultiArray<T, D4>.get( ind1: Int, ind2: ClosedRange<Int>, ind3: Int, ind4: ClosedRange<Int>): MultiArray<T, D2>

@JvmName(name = "get44")

operator fun <T> MultiArray<T, D4>.get( ind1: Int, ind2: ClosedRange<Int>, ind3: ClosedRange<Int>, ind4: Int): MultiArray<T, D2>

@JvmName(name = "get49")

operator fun <T> MultiArray<T, D4>.get( ind1: Int, ind2: ClosedRange<Int>, ind3: ClosedRange<Int>, ind4: ClosedRange<Int>): MultiArray<T, D3>

@JvmName(name = "get42")

operator fun <T> MultiArray<T, D4>.get( ind1: ClosedRange<Int>, ind2: Int, ind3: Int, ind4: Int): MultiArray<T, D1>

@JvmName(name = "get47")

operator fun <T> MultiArray<T, D4>.get( ind1: ClosedRange<Int>, ind2: Int, ind3: Int, ind4: ClosedRange<Int>): MultiArray<T, D2>

@JvmName(name = "get48")

operator fun <T> MultiArray<T, D4>.get( ind1: ClosedRange<Int>, ind2: Int, ind3: ClosedRange<Int>, ind4: Int): MultiArray<T, D2>

@JvmName(name = "get50")

operator fun <T> MultiArray<T, D4>.get( ind1: ClosedRange<Int>, ind2: Int, ind3: ClosedRange<Int>, ind4: ClosedRange<Int>): MultiArray<T, D3>

@JvmName(name = "get45")

operator fun <T> MultiArray<T, D4>.get( ind1: ClosedRange<Int>, ind2: ClosedRange<Int>, ind3: Int, ind4: Int): MultiArray<T, D2>

@JvmName(name = "get51")

operator fun <T> MultiArray<T, D4>.get( ind1: ClosedRange<Int>, ind2: ClosedRange<Int>, ind3: Int, ind4: ClosedRange<Int>): MultiArray<T, D3>

@JvmName(name = "get52")

operator fun <T> MultiArray<T, D4>.get( ind1: ClosedRange<Int>, ind2: ClosedRange<Int>, ind3: ClosedRange<Int>, ind4: Int): MultiArray<T, D3>

@JvmName(name = "get39")

operator fun <T> MultiArray<T, D4>.get( ind1: ClosedRange<Int>, ind2: ClosedRange<Int>, ind3: ClosedRange<Int>, ind4: ClosedRange<Int>): MultiArray<T, D4>

@JvmName(name = "get8")

operator fun <T> MutableMultiArray<T, D4>.get( write: WritableView.Companion, ind1: Int, ind2: Int, ind3: Int): MutableMultiArray<T, D1>

initMemoryView

inline fun <T : Any> initMemoryView(size: Int): MemoryView<T>

fun <T> initMemoryView(size: Int, dataType: DataType): MemoryView<T>

Creates a MemoryView based size and dataType.

fun <T> initMemoryView( size: Int, dataType: DataType, init: (Int) -> T): MemoryView<T>

Create a MemoryView based size and dataType, where each elements will be initialized according to the given init function.

mutableView

inline fun <T, D : Dimension, M : Dimension> MutableMultiArray<T, D>.mutableView(index: Int, axis: Int = 0): MutableMultiArray<T, M>

inline fun <T, D : Dimension, M : Dimension> MutableMultiArray<T, D>.mutableView(index: IntArray, axes: IntArray): MutableMultiArray<T, M>

@JvmName(name = "mutableViewD2")

fun <T> MutableMultiArray<T, D2>.mutableView(index: Int, axis: Int = 0): MutableMultiArray<T, D1>

@JvmName(name = "mutableViewD3")

fun <T> MutableMultiArray<T, D3>.mutableView(index: Int, axis: Int = 0): MutableMultiArray<T, D2>

@JvmName(name = "mutableViewD4")

fun <T> MutableMultiArray<T, D4>.mutableView(index: Int, axis: Int = 0): MutableMultiArray<T, D3>

@JvmName(name = "mutableViewDN")

fun <T> MutableMultiArray<T, DN>.mutableView(index: Int, axis: Int = 0): MutableMultiArray<T, DN>

@JvmName(name = "mutableViewDN")

fun <T> MutableMultiArray<T, DN>.mutableView(index: IntArray, axes: IntArray): MutableMultiArray<T, DN>

@JvmName(name = "mutableViewD3toD1")

fun <T> MutableMultiArray<T, D3>.mutableView( ind1: Int, ind2: Int, axis1: Int = 0, axis2: Int = 1): MutableMultiArray<T, D1>

@JvmName(name = "mutableViewD4toD2")

fun <T> MutableMultiArray<T, D4>.mutableView( ind1: Int, ind2: Int, axis1: Int = 0, axis2: Int = 1): MutableMultiArray<T, D2>

@JvmName(name = "mutableViewD4toD1")

fun <T> MutableMultiArray<T, D4>.mutableView( ind1: Int, ind2: Int, ind3: Int, axis1: Int = 0, axis2: Int = 1, axis3: Int = 2): MutableMultiArray<T, D1>

rangeTo

operator fun Int.rangeTo(that: RInt): Slice

Returns Slice where stop from RInt.

operator fun Int.rangeTo(that: SliceEndStub): Slice

Returns Slice with stub of the stop.

operator fun IntArray.rangeTo(other: IntArray): MultiIndexProgression

Returns a multidimensional index based on given arrays.

operator fun IntRange.rangeTo(step: Int): Slice

Returns a slice at a specified step.

operator fun SliceStartStub.rangeTo(that: Int): Slice

Returns Slice with stub of the start.

requireElementsWithShape

inline fun requireElementsWithShape(elementSize: Int, shapeSize: Int)

set

@JvmName(name = "set0")

operator fun <T> MutableMultiArray<T, D1>.set(index: Int, value: T)

@JvmName(name = "set1")

operator fun <T> MutableMultiArray<T, D2>.set(index: Int, value: MultiArray<T, D1>)

@JvmName(name = "set3")

operator fun <T> MutableMultiArray<T, D3>.set(index: Int, value: MultiArray<T, D2>)

@JvmName(name = "set6")

operator fun <T> MutableMultiArray<T, D4>.set(index: Int, value: MultiArray<T, D3>)

@JvmName(name = "set10")

operator fun <T> MutableMultiArray<T, DN>.set(vararg index: Int, value: T)

@JvmName(name = "set11")

operator fun <T> MutableMultiArray<T, DN>.set(index: IntArray, value: T)

@JvmName(name = "set2")

operator fun <T> MutableMultiArray<T, D2>.set( ind1: Int, ind2: Int, value: T)

@JvmName(name = "set4")

operator fun <T> MutableMultiArray<T, D3>.set( ind1: Int, ind2: Int, value: MultiArray<T, D1>)

@JvmName(name = "set7")

operator fun <T> MutableMultiArray<T, D4>.set( ind1: Int, ind2: Int, value: MultiArray<T, D2>)

@JvmName(name = "set5")

operator fun <T> MutableMultiArray<T, D3>.set( ind1: Int, ind2: Int, ind3: Int, value: T)

@JvmName(name = "set8")

operator fun <T> MutableMultiArray<T, D4>.set( ind1: Int, ind2: Int, ind3: Int, value: MultiArray<T, D1>)

@JvmName(name = "set9")

operator fun <T> MutableMultiArray<T, D4>.set( ind1: Int, ind2: Int, ind3: Int, ind4: Int, value: T)

slice

fun <T, D : Dimension, O : Dimension> MultiArray<T, D>.slice(indexing: Map<Int, Indexing>): NDArray<T, O>

fun <T> MultiArray<T, DN>.slice(map: Map<Int, Indexing>): MultiArray<T, DN>

fun <T, D : Dimension, O : Dimension> MultiArray<T, D>.slice(inSlice: ClosedRange<Int>, axis: Int = 0): NDArray<T, O>

step

infix fun MultiIndexProgression.step(step: Int): MultiIndexProgression

Returns a multidimensional index with a given step.

toPrimitiveType

fun <T : Number> Number.toPrimitiveType(dtype: DataType): T

toSlice

fun ClosedRange<Int>.toSlice(): Slice

fun IntRange.toSlice(): Slice

Returns Slice containing the first, the last with a step of 1.

toViewPrimitiveArray

fun <T> List<T>.toViewPrimitiveArray(dataType: DataType): MemoryView<T>

view

fun <T, D : Dimension, M : Dimension> MultiArray<T, D>.view(index: Int, axis: Int = 0): MultiArray<T, M>

fun <T, D : Dimension, M : Dimension> MultiArray<T, D>.view(indices: IntArray, axes: IntArray): MultiArray<T, M>

@JvmName(name = "viewD2")

fun <T> MultiArray<T, D2>.view(index: Int, axis: Int = 0): MultiArray<T, D1>

@JvmName(name = "viewD3")

fun <T> MultiArray<T, D3>.view(index: Int, axis: Int = 0): MultiArray<T, D2>

@JvmName(name = "viewD4")

fun <T> MultiArray<T, D4>.view(index: Int, axis: Int = 0): MultiArray<T, D3>

@JvmName(name = "viewDN")

fun <T> MultiArray<T, DN>.view(index: Int, axis: Int = 0): MultiArray<T, DN>

@JvmName(name = "viewDN")

fun <T> MultiArray<T, DN>.view(index: IntArray, axes: IntArray): MultiArray<T, DN>

@JvmName(name = "viewD3toD1")

fun <T> MultiArray<T, D3>.view( ind1: Int, ind2: Int, axis1: Int = 0, axis2: Int = 1): MultiArray<T, D1>

@JvmName(name = "viewD4toD2")

fun <T> MultiArray<T, D4>.view( ind1: Int, ind2: Int, axis1: Int = 0, axis2: Int = 1): MultiArray<T, D2>

@JvmName(name = "viewD4toD1")

fun <T> MultiArray<T, D4>.view( ind1: Int, ind2: Int, ind3: Int, axis1: Int = 0, axis2: Int = 1, axis3: Int = 2): MultiArray<T, D1>

writableView

inline fun <T, D : Dimension, M : Dimension> MultiArray<T, D>.writableView(index: Int, axis: Int = 0): MutableMultiArray<T, M>

inline fun <T, D : Dimension, M : Dimension> MultiArray<T, D>.writableView(indices: IntArray, axes: IntArray): MutableMultiArray<T, M>

zeroNumber

inline fun zeroNumber(dtype: DataType): Any

Properties

bounds

val sl.bounds: Slice

Returns Slice with stubs the start and the stop.

first

val sl.first: SliceStartStub

Stub start.

last

val sl.last: SliceEndStub

Stub stop.

val Int.r: RInt

Returns RInt.

val <T> MultiArray<T, DN>.V: ReadableView<T>

val <T> MutableMultiArray<T, DN>.W: WritableView<T>