kpermute/com.eignex.kpermute/ArrayIntPermutation

ArrayIntPermutation

class ArrayIntPermutation(val size: Int, rng: Random) : IntPermutation(source)

Finite in-memory integer permutation backed by an IntArray lookup table.

Builds a random bijection over [0, size) by shuffling the identity mapping and precomputing the inverse. Encode and decode are O(1) array lookups.

Parameters

rng

Random generator used to create the shuffled mapping.

Constructors

ArrayIntPermutation

constructor(size: Int, rng: Random)

Properties

size

open override val size: Int

Size of the permutation domain; valid inputs are [0, size).

Functions

decode

open fun decode(encoded: Int): Int

Decodes a previously encoded integer back to its original value.

decodeUnchecked

open override fun decodeUnchecked(encoded: Int): Int

Decodes a previously encoded value without range checks.

encode

open fun encode(value: Int): Int

Encodes an integer in the permutation domain into its permuted value.

encodeUnchecked

open override fun encodeUnchecked(value: Int): Int

Encodes a value without range checks.

iterator

open override fun iterator(offset: Int): IntIterator

Returns an iterator over encode(i) for indices in [offset, size).

open operator override fun iterator(): IntIterator

Returns an iterator over encode(i) for all i in [0, size) for finite domains, or over the full 32-bit space when size == -1.

range

fun IntPermutation.range(range: IntRange): IntPermutation

Returns a view of this permutation that operates on range instead of [0, size). Only valid for finite domains where range.count() == size.

toString

open override fun toString(): String