RandomGenerator

interface RandomGenerator

An interface that is implemented by random number generator algorithms.

Types

Companion

common

object Companion

Functions

equals

common

open operator fun equals(other: Any?): Boolean

fillBytes

common

abstract fun fillBytes(array: ByteArray, fromIndex: Int = 0, toIndex: Int = array.size)

Fills a subrange of the specified byte array starting from fromIndex inclusive and ending toIndex exclusive with random bytes.

fork

common

abstract fun fork(): RandomGenerator

Create a new generator which is independent from current generator (operations on new generator do not affect this one and vise versa).

hashCode

common

open fun hashCode(): Int

nextBoolean

common

abstract fun nextBoolean(): Boolean

Gets the next random Boolean value.

nextBytes

common

open fun nextBytes(size: Int): ByteArray

Creates a byte array of the specified size, filled with random bytes.

nextDouble

common

abstract fun nextDouble(): Double

Gets the next random Double value uniformly distributed between 0 (inclusive) and 1 (exclusive).

nextInt

common

abstract fun nextInt(): Int

Gets the next random Int from the random number generator.

abstract fun nextInt(until: Int): Int

Gets the next random non-negative Int from the random number generator less than the specified until bound.

nextLong

common

abstract fun nextLong(): Long

Gets the next random Long from the random number generator.

abstract fun nextLong(until: Long): Long

Gets the next random non-negative Long from the random number generator less than the specified until bound.

toString

common

open fun toString(): String

Inheritors

DefaultGenerator

RandomSourceGenerator

Extensions

asUniformRandomProvider

jvm

fun RandomGenerator.asUniformRandomProvider(): UniformRandomProvider

Represent this RandomGenerator as commons-rng UniformRandomProvider preserving and mirroring its current state.

chain

common

fun <R> RandomGenerator.chain(gen: suspend RandomGenerator.() -> R): RandomChain<R>