kpermute/com.eignex.kpermute

Top-level

Types

ArrayIntPermutation

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

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

ArrayLongPermutation

class ArrayLongPermutation(val size: Long, rng: Random) : LongPermutation

Finite in-memory long permutation backed by a LongArray lookup table.

FullIntPermutation

class FullIntPermutation(rng: Random = Random.Default, rounds: Int = 2, c1: Int = -2048144789, c2: Int = -1028477387) : IntPermutation

Full 32-bit integer permutation over the entire signed Int domain.

FullLongPermutation

class FullLongPermutation(rng: Random = Random.Default, rounds: Int = 2, c1: Long = -4658895280553007687, c2: Long = -7723592293110705685) : LongPermutation

Full 64-bit integer permutation over the entire signed Long domain.

HalfIntPermutation

class HalfIntPermutation(val size: Int = Int.MAX_VALUE, rng: Random = Random.Default, rounds: Int = 3, const: Int = -1640531535) : IntPermutation

Finite integer permutation using cycle-walking over a 2^k-sized block.

HalfLongPermutation

class HalfLongPermutation(val size: Long = Long.MAX_VALUE, rng: Random = Random.Default, rounds: Int = 3, const: Long = 5955220737039975883) : LongPermutation

Finite long permutation using cycle-walking over a 2^k-sized block.

IntPermutation

interface IntPermutation : Iterable<Int>

Reversible permutation over a 32-bit integer domain.

LongPermutation

interface LongPermutation : Iterable<Long>

Reversible permutation over a 64-bit integer domain.

UIntPermutation

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

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

ULongPermutation

class ULongPermutation(val size: Long, rng: Random = Random.Default, rounds: Int = 3, const: ULong) : LongPermutation

Finite permutation over an unsigned 64-bit-style domain encoded as Long.

Functions

intPermutation

@JvmOverloads

fun intPermutation(size: Int = Int.MAX_VALUE, seed: Long, rounds: Int = 0): IntPermutation

Creates an IntPermutation using a seed-based Random instance.

@JvmOverloads

fun intPermutation(size: Int = Int.MAX_VALUE, rng: Random = Random.Default, rounds: Int = 0): IntPermutation

Creates an IntPermutation for a contiguous integer domain.

fun intPermutation(range: IntRange, seed: Long, rounds: Int = 0): IntPermutation

Creates an IntPermutation for the given inclusive range using a seed-based Random instance.

@JvmOverloads

fun intPermutation(range: IntRange, rng: Random = Random.Default, rounds: Int = 0): IntPermutation

Creates an IntPermutation for values within the given inclusive range.

longPermutation

fun longPermutation(size: Long = Long.MAX_VALUE, seed: Long, rounds: Int = 0): LongPermutation

Creates a LongPermutation using a seed-based Random instance.

@JvmOverloads

fun longPermutation(size: Long = Long.MAX_VALUE, rng: Random = Random.Default, rounds: Int = 0): LongPermutation

Creates a LongPermutation for a contiguous long domain.

@JvmOverloads

fun longPermutation(range: LongRange, seed: Long, rounds: Int = 0): LongPermutation

Creates a LongPermutation for the given inclusive range using a seed-based Random instance.

@JvmOverloads

fun longPermutation(range: LongRange, rng: Random = Random.Default, rounds: Int = 0): LongPermutation

Creates a LongPermutation for values within the given inclusive range.

permuted

fun <T> List<T>.permuted(perm: IntPermutation = intPermutation(size)): List<T>

Returns a new list whose elements are permuted by perm. The original list is not modified.

range

fun IntPermutation.range(range: IntRange): IntPermutation

fun LongPermutation.range(range: LongRange): LongPermutation

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

unpermuted

fun <T> List<T>.unpermuted(perm: IntPermutation): List<T>

Applies the inverse of perm as a view, restoring the original order.