Package space.kscience.kmath.memory

Types

Memory

common

interface Memory

Represents a display of certain memory structure.

MemoryReader

common

interface MemoryReader

The interface to read primitive types in this memory.

MemorySpec

common

interface MemorySpec<T : Any>

A specification to read or write custom objects with fixed size in bytes.

MemoryWriter

common

interface MemoryWriter

The interface to write primitive types into this memory.

Functions

allocate

common

fun Memory.Companion.allocate(length: Int): Memory

Allocates the most effective platform-specific memory.

fun Memory.Companion.allocate(length: Int): Memory

Allocates memory based on a DataView.

jvm

fun Memory.Companion.allocate(length: Int): Memory

Allocates memory based on a ByteBuffer.

native

fun Memory.Companion.allocate(length: Int): Memory

Allocates the most effective platform-specific memory.

asMemory

jvm

fun ByteBuffer.asMemory(startOffset: Int = 0, size: Int = limit()): Memory

Wraps this ByteBuffer to Memory object.

read

common

inline fun <R> Memory.read(block: MemoryReader.() -> R): R

Uses the memory for read then releases the reader.

fun <T : Any> MemoryReader.read(spec: MemorySpec<T>, offset: Int): T

Reads the object with spec starting from offset.

readArray

common

inline fun <T : Any> MemoryReader.readArray(spec: MemorySpec<T>, offset: Int, size: Int): Array<T>

Reads array of size objects mapped by spec at certain offset.

readAsMemory

jvm

inline fun <R> Path.readAsMemory(position: Long = 0, size: Long = Files.size(this), block: Memory.() -> R): R

Uses direct memory-mapped buffer from file to read something and close it afterwards.

wrap

common

fun Memory.Companion.wrap(array: ByteArray): Memory

Wraps a Memory around existing ByteArray.

fun Memory.Companion.wrap(array: ByteArray): Memory

Wraps a Memory around existing ByteArray.

jvm

fun Memory.Companion.wrap(array: ByteArray): Memory

Wraps a Memory around existing ByteArray.

native

fun Memory.Companion.wrap(array: ByteArray): Memory

Wraps a Memory around existing ByteArray.

write

common

inline fun Memory.write(block: MemoryWriter.() -> Unit)

Uses the memory for write then releases the writer.

fun <T : Any> MemoryWriter.write(spec: MemorySpec<T>, offset: Int, value: T)

Writes the object value with spec starting from offset.

writeArray

common

fun <T : Any> MemoryWriter.writeArray(spec: MemorySpec<T>, offset: Int, array: Array<T>)

Writes array of objects mapped by spec at certain offset.