sudoklify-common/dev.teogor.sudoklify.components/Seed

Seed

Represents a seed value for generating randomization in various contexts.

Seed values are typically used to control the starting point of a random sequence, ensuring reproducibility and consistency across different runs. This sealed class provides a safe and structured way to handle different types of seeds.

Throws

InvalidSeedException

if the initial value is negative.

Inheritors

Random

Explicit

Types

Explicit

class Explicit(val value: Long) : Seed

Represents an explicit seed with a specific long value.

Random

class Random : Seed

Represents a random seed generated using the system's random number generator.

Properties

value

val value: Long

The underlying long value used for the seed. Must be non-negative.

Functions

compareTo

open operator override fun compareTo(other: Seed): Int

Compares this Seed object with another Seed object. Random seeds are considered equal to other Random seeds, while Explicit seeds are compared based on their values.

copy

fun copy(seed: Long? = null): Seed

Creates a copy of the Seed object with an optional new value. If no value is provided, the current value is used.

equals

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

hashCode

open override fun hashCode(): Int

nextSeed

open fun nextSeed(): Seed

Generates a new Seed object with an incremented value, if applicable. This is the default behavior for Explicit seeds, while Random seeds remain the same. Subclasses can override this method to provide different behavior.

toRandom

fun toRandom(): Random

Returns a kotlin.random.Random instance based on the value of this seed.

toString

open override fun toString(): String

Returns a string representation of the Seed object. It indicates the type (Random or Explicit) and the underlying value.