kpermute/com.eignex.kpermute/UIntPermutation

UIntPermutation

class UIntPermutation(val size: Int, rng: Random = Random.Default, rounds: Int = 3, const: UInt) : IntPermutation(source)

Finite permutation over an unsigned 32-bit-style domain encoded as Int.

Interprets values as UInt and permutes [0, size) using reversible affine steps and XOR-shift mixing within a 2^k block. Cycle walking ensures that all outputs stay inside the unsigned domain.

Parameters

rng

Random generator used to derive per-round keys.

rounds

Number of mixing rounds; higher values increase dispersion.

const

Odd multiplicative constant used in each affine step.

Constructors

UIntPermutation

constructor(size: Int, rng: Random = Random.Default, rounds: Int = 3, const: UInt)

Properties

size

open override val size: Int

Size of the unsigned domain encoded as an Int.

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

open override fun iterator(offset: Int): IntIterator

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

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