kotlinx-datetime/kotlinx.datetime/random

random

fun LocalDateProgression.random(random: Random = Random): LocalDate(source)

Returns a random LocalDate within the bounds of the LocalDateProgression.

Takes the step into account; will not return any value within the range that would be skipped over by the progression.

Throws

if the progression is empty.

Samples

import kotlinx.datetime.*
import kotlin.random.Random
import kotlin.test.Test

fun main() { 
   //sampleStart 
   // Getting a random element from a LocalDateProgression
check((LocalDate(2000, 1, 1)..LocalDate(2000, 1, 5)).random() in LocalDate(2000, 1, 1)..LocalDate(2000, 1, 5))
check((LocalDate(2000, 1, 1)..LocalDate(2000, 1, 5)).random(Random(123456)) in LocalDate(2000, 1, 1)..LocalDate(2000, 1, 5))
check((LocalDate(2000, 1, 5)..LocalDate(2000, 1, 1)).randomOrNull() == null)
check((LocalDate(2000, 1, 5)..LocalDate(2000, 1, 1)).randomOrNull(Random(123456)) == null) 
   //sampleEnd
}
fun YearMonthProgression.random(random: Random = Random): YearMonth(source)

Returns a random YearMonth within the bounds of the YearMonthProgression.

Takes the step into account; will not return any value within the range that would be skipped over by the progression.

Throws

if the progression is empty.

Samples

import kotlinx.datetime.*
import kotlin.random.Random
import kotlin.test.Test

fun main() { 
   //sampleStart 
   // Getting a random element from a YearMonthProgression
check((YearMonth(2000, 1)..YearMonth(2000, 5)).random() in YearMonth(2000, 1)..YearMonth(2000, 5))
check((YearMonth(2000, 1)..YearMonth(2000, 5)).random(Random(123456)) in YearMonth(2000, 1)..YearMonth(2000, 5))
check((YearMonth(2000, 5)..YearMonth(2000, 1)).randomOrNull() == null)
check((YearMonth(2000, 5)..YearMonth(2000, 1)).randomOrNull(Random(123456)) == null) 
   //sampleEnd
}