com.eignex.kpermute/BoundedIntPermutation

BoundedIntPermutation

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

Permutation over [0, size) that mixes within the enclosing power-of-two block and cycle-walks until the output lands in range. size is read as unsigned, so -1 means 2^32 - 1 values. const must be odd.

Constructors

BoundedIntPermutation

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

Properties

size

open override val size: Int(source)

Domain size, read as unsigned; -1 means all 32-bit values.

Functions

decode

open override fun decode(encoded: Int): Int(source)

Inverse of encode; throws if encoded is outside the domain.

decodeUnchecked

open override fun decodeUnchecked(encoded: Int): Int(source)

decode without range checks. Out-of-domain input is unspecified and may not terminate.

encode

open override fun encode(value: Int): Int(source)

Maps value to its permuted position; throws if value is outside the domain.

encodeUnchecked

open override fun encodeUnchecked(value: Int): Int(source)

encode without range checks. Out-of-domain input is unspecified and may not terminate.

iterator

open override fun iterator(offset: Int): IntIterator(source)

Iterates encode(i) for unsigned indices i from offset, which must be in 0..size.

toString

open override fun toString(): String(source)

range

fun IntPermutation.range(range: IntRange): IntPermutation

Returns a view of this permutation shifted onto range, which must hold exactly IntPermutation.size values. On an existing range view, replaces its range.