kmath-core/space.kscience.kmath.structures

Package-level declarations

Types

class ArrayBuffer<T>(array: Array<T>) : MutableBuffer<T>

MutableBuffer implementation over Array.

interface Buffer<out T> : WithSize

A generic read-only random-access structure for both primitives and objects.

class BufferExpanded<T>(val origin: Buffer<T>, defaultValue: T, val offset: Int = 0, val size: Int = origin.size) : BufferView<T>

An expanded buffer that could include the whole initial buffer or its part and fills all space beyond it borders with defaultValue.

fun interface BufferFactory<T>

Function that produces Buffer from its size and function that supplies values.

class BufferSlice<T>(val origin: Buffer<T>, val offset: Int = 0, val size: Int) : BufferView<T>

A zero-copy buffer that "sees" only part of original buffer. Slice can't go beyond original buffer borders.

interface BufferView<T> : Buffer<T>

A buffer that wraps an original buffer

value class ByteBuffer(val array: ByteArray) : MutableBuffer<Byte>

Specialized MutableBuffer implementation over ByteArray.

value class DoubleBuffer(val array: DoubleArray) : PrimitiveBuffer<Double>

Specialized MutableBuffer implementation over DoubleArray.

DoubleBufferTransform

fun interface DoubleBufferTransform : BufferTransform<Double, Double>

interface FlaggedBuffer<out T> : Buffer<T>

A buffer with flagged values.

FlaggedDoubleBuffer

class FlaggedDoubleBuffer(val values: DoubleArray, val flags: ByteArray) : FlaggedBuffer<Double?> , Buffer<Double?>

A Double buffer that supports flags for each value like NaN or Missing.

typealias Float32 = Float

typealias Float64 = Double

value class FloatBuffer(val array: FloatArray) : PrimitiveBuffer<Float>

Specialized MutableBuffer implementation over FloatArray.

typealias Int16 = Short

typealias Int32 = Int

typealias Int64 = Long

typealias Int8 = Byte

value class IntBuffer(val array: IntArray) : PrimitiveBuffer<Int>

Specialized MutableBuffer implementation over IntArray.

class ListBuffer<T>(val list: List<T>) : Buffer<T>

Buffer implementation over List.

value class LongBuffer(val array: LongArray) : PrimitiveBuffer<Long>

Specialized MutableBuffer implementation over LongArray.

open class MemoryBuffer<T : Any>(memory: Memory, spec: MemorySpec<T>) : Buffer<T>

A non-boxing buffer over Memory object.

interface MutableBuffer<T> : Buffer<T>

A generic mutable random-access structure for both primitives and objects.

MutableBufferFactory

fun interface MutableBufferFactory<T> : BufferFactory<T>

Function that produces MutableBuffer from its size and function that supplies values.

MutableListBuffer

value class MutableListBuffer<T>(val list: MutableList<T>) : MutableBuffer<T>

MutableBuffer implementation over MutableList.

MutableMemoryBuffer

class MutableMemoryBuffer<T : Any>(memory: Memory, spec: MemorySpec<T>) : MemoryBuffer<T> , MutableBuffer<T>

A mutable non-boxing buffer over Memory object.

class PermutedBuffer<T>(val origin: Buffer<T>, permutations: IntArray) : BufferView<T>

A BufferView that overrides indexing of the original buffer

PermutedMutableBuffer

class PermutedMutableBuffer<T>(val origin: MutableBuffer<T>, permutations: IntArray) : BufferView<T> , MutableBuffer<T>

A BufferView that overrides indexing of the original buffer

PrimitiveBuffer

interface PrimitiveBuffer<T> : MutableBuffer<T>

value class ReadOnlyBuffer<T>(val buffer: MutableBuffer<T>) : Buffer<T>

Immutable wrapper for MutableBuffer.

value class ShortBuffer(val array: ShortArray) : MutableBuffer<Short>

Specialized MutableBuffer implementation over ShortArray.

typealias UInt16 = UShort

typealias UInt32 = UInt

typealias UInt64 = ULong

typealias UInt8 = UByte

enum ValueFlag : Enum<ValueFlag>

Represents flags to supply additional info about values of buffer.

class VirtualBuffer<out T>(val size: Int, generator: (Int) -> T) : Buffer<T>

A buffer with content calculated on-demand. The calculated content is not stored, so it is recalculated on each call. Useful when one needs single element from the buffer.

Functions

fun <T> Array<T>.asBuffer(): ArrayBuffer<T>

Returns an ArrayBuffer that wraps the original array.

fun ByteArray.asBuffer(): ByteBuffer

Returns ByteBuffer over this array.

fun DoubleArray.asBuffer(): DoubleBuffer

Returns DoubleBuffer over this array.

fun FloatArray.asBuffer(): FloatBuffer

Returns FloatBuffer over this array.

fun IntArray.asBuffer(): IntBuffer

Returns IntBuffer over this array.

fun LongArray.asBuffer(): LongBuffer

Returns LongBuffer over this array.

fun ShortArray.asBuffer(): ShortBuffer

Returns ShortBuffer over this array.

fun <T> List<T>.asBuffer(): ListBuffer<T>

Returns an ListBuffer that wraps the original list.

asMutableBuffer

fun <T> MutableList<T>.asMutableBuffer(): MutableListBuffer<T>

Returns an MutableListBuffer that wraps the original list.

fun <T> Buffer<T>.asReadOnly(): Buffer<T>

Convert this buffer to read-only buffer.

fun ByteBuffer(vararg bytes: Byte): ByteBuffer

Returns a new ByteBuffer of given elements.

inline fun ByteBuffer(size: Int, init: (Int) -> Byte): ByteBuffer

Creates a new ByteBuffer with the specified size, where each element is calculated by calling the specified init function.

fun DoubleBuffer(vararg doubles: Double): DoubleBuffer

Returns a new DoubleBuffer of given elements.

inline fun DoubleBuffer(size: Int, init: (Int) -> Double): DoubleBuffer

Creates a new DoubleBuffer with the specified size, where each element is calculated by calling the specified init function.

fun <T> Buffer<T>.expand(range: IntRange, defaultValue: T): BufferView<T>

Resize original buffer to a given range using given range, filling additional segments with defaultValue. Range left border could be negative to designate adding new blank segment to the beginning of the buffer

fun <T> Buffer<T>.first(): T

fun FloatBuffer(vararg floats: Float): FloatBuffer

Returns a new FloatBuffer of given elements.

inline fun FloatBuffer(size: Int, init: (Int) -> Float): FloatBuffer

Creates a new FloatBuffer with the specified size, where each element is calculated by calling the specified init function.

inline fun FlaggedDoubleBuffer.forEachValid(block: (Double) -> Unit)

operator fun <T> Buffer<T>.get(index: UInt): T

@UnstableKMathAPI

fun Buffer<Double>.getDouble(index: Int): Double

Non-boxing access to primitive Double

@UnstableKMathAPI

fun Buffer<Int>.getInt(index: Int): Int

Non-boxing access to primitive Int

fun <T> Buffer<T>.getOrNull(index: Int): T?

if index is in range of buffer, return the value. Otherwise, return null.

fun FlaggedBuffer<*>.hasFlag(index: Int, flag: ValueFlag): Boolean

fun IntBuffer(vararg ints: Int): IntBuffer

Returns a new IntBuffer of given elements.

inline fun IntBuffer(size: Int, init: (Int) -> Int): IntBuffer

Creates a new IntBuffer with the specified size, where each element is calculated by calling the specified init function.

fun FlaggedBuffer<*>.isMissing(index: Int): Boolean

fun FlaggedBuffer<*>.isValid(index: Int): Boolean

The value is valid if all flags are down

fun <T> Buffer<T>.last(): T

fun LongBuffer(vararg longs: Long): LongBuffer

Returns a new LongBuffer of given elements.

inline fun LongBuffer(size: Int, init: (Int) -> Long): LongBuffer

Creates a new LongBuffer with the specified size, where each element is calculated by calling the specified init function.

fun <T> Buffer<T>.permute(indices: IntArray): PermutedBuffer<T>

Created a permuted view of given buffer using provided indices

fun <T> MutableBuffer<T>.permute(indices: IntArray): PermutedMutableBuffer<T>

Created a permuted mutable view of given buffer using provided indices

fun ShortBuffer(vararg shorts: Short): ShortBuffer

Returns a new ShortBuffer of given elements.

inline fun ShortBuffer(size: Int, init: (Int) -> Short): ShortBuffer

Creates a new ShortBuffer with the specified size, where each element is calculated by calling the specified init function.

fun <T> Buffer<T>.slice(range: IntRange): BufferView<T>

Zero-copy select a slice inside the original buffer

fun Buffer<Byte>.toByteArray(): ByteArray

Returns a new ByteArray containing all the elements of this Buffer.

fun Buffer<Double>.toDoubleArray(): DoubleArray

Returns a new DoubleArray containing all the elements of this Buffer.

fun Buffer<Double>.toDoubleBuffer(): DoubleBuffer

Represent this buffer as DoubleBuffer. Does not guarantee that changes in the original buffer are reflected on this buffer.

fun Buffer<Float>.toFloatArray(): FloatArray

Returns a new FloatArray containing all the elements of this Buffer.

fun Buffer<Int>.toIntArray(): IntArray

Returns a new IntArray containing all the elements of this Buffer.

fun Buffer<Long>.toLongArray(): LongArray

Returns a new LongArray containing all the elements of this Buffer.

fun Buffer<Short>.toShortArray(): ShortArray

Returns a new ShortArray containing all the elements of this Buffer.

Properties

val <T> Buffer<T>.indices: IntRange

Returns an IntRange of the valid indices for this Buffer.