kitecore/io.github.yuroyami.kitecore.random

Package-level declarations

Types

RandomAlphabets

object RandomAlphabets

Predefined alphabet strings for random text generation.

Functions

gaussianSequence

fun Random.gaussianSequence(mean: Double = 0.0, standardDeviation: Double = 1.0): Sequence<Double>

Returns an infinite lazy sequence of normally distributed values.

nextAlphabetic

fun Random.nextAlphabetic(length: Int): String

Returns a random string of exactly length Latin letters (a-zA-Z).

nextAlphanumeric

fun Random.nextAlphanumeric(length: Int): String

Returns a random string of exactly length alphanumeric characters (a-zA-Z0-9).

nextBoolean

fun Random.nextBoolean(probability: Double): Boolean

Returns true with the given probability and false otherwise.

nextChar

fun Random.nextChar(alphabet: String): Char

Returns one character drawn uniformly at random from alphabet.

nextDigits

fun Random.nextDigits(length: Int): String

Returns a random string of exactly length decimal digits (0-9).

nextGaussian

fun Random.nextGaussian(mean: Double = 0.0, standardDeviation: Double = 1.0): Double

Returns a normally distributed value with the given mean and standardDeviation.

nextHexString

fun Random.nextHexString(length: Int): String

Returns a random string of exactly length lowercase hexadecimal digits (0-9a-f).

nextSign

fun Random.nextSign(): Int

Returns +1 or -1 with equal probability.

nextString

fun Random.nextString(length: Int, alphabet: String): String

Returns a random string of exactly length characters drawn from alphabet.

randomOf

fun <T> randomOf(vararg options: T, random: Random = Random.Default): T

Returns one of options chosen uniformly at random.

sample

fun <T> Collection<T>.sample(n: Int, random: Random = Random.Default): List<T>

Returns n elements sampled uniformly at random without replacement.

sampleOrNull

fun <T> Collection<T>.sampleOrNull(n: Int, random: Random = Random.Default): List<T>?

Returns n elements sampled without replacement, or null when n is out of range.

sampleWithReplacement

fun <T> Collection<T>.sampleWithReplacement(n: Int, random: Random = Random.Default): List<T>

Returns n elements sampled uniformly at random with replacement.

weightedRandom

fun <T> List<T>.weightedRandom(weights: List<Double>, random: Random = Random.Default): T

Returns a random element of this list chosen with probability proportional to weights.

weightedRandomIndex

fun <T> List<T>.weightedRandomIndex(weights: List<Double>, random: Random = Random.Default): Int

Returns a random index of this list chosen with probability proportional to weights.

weightedRandomOrNull

fun <T> List<T>.weightedRandomOrNull(weights: List<Double>, random: Random = Random.Default): T?

Returns a weighted random element, or null when the arguments are invalid.