sudoklify-core/dev.teogor.sudoklify.schema/SudokuSchemas

SudokuSchemas

class SudokuSchemas(schemas: List<SudokuSchema>) : Collection<SudokuSchema>

Represents a set of Sudoku schemas.

This class encapsulates a collection of SudokuSchema objects. It allows iteration over the schemas, copying the set with modified schemas, and provides standard methods for equality and string representation.

Example:

val schema1 = SudokuSchema(
    puzzle = SudokuString("A1B2..."),
    solution = SudokuString("1A2B..."),
    difficulty = Difficulty.MEDIUM,
    sudokuType = SudokuType.Sudoku4x4
)

val schema2 = SudokuSchema(
    puzzle = SudokuString("B1C2..."),
    solution = SudokuString("2B3C..."),
    difficulty = Difficulty.HARD,
    sudokuType = SudokuType.Sudoku4x4
)

// Create a SudokuSchemas with the schemas
val schemaSet = SudokuSchemas(listOf(schema1, schema2))

// Iterate over the schemas
for (schema in schemaSet) {
    println(schema)
}

// Create a copy of the schema set
val copiedSchemaSet = schemaSet.copy()

See also

Constructors

constructor(schemas: List<SudokuSchema>)

Creates a new instance of SudokuSchemas with the provided list of schemas.

Types

Builder class for constructing a SudokuSchemas with a DSL-style configuration.

Properties

open override val size: Int

Returns the number of schemas in this collection.

Functions

open operator override fun contains(element: SudokuSchema): Boolean

Checks if the specified SudokuSchema is present in the collection.

open override fun containsAll(elements: Collection<SudokuSchema>): Boolean

Checks if all specified SudokuSchema instances are present in the collection.

fun copy(schemas: List<SudokuSchema> = this.schemas): SudokuSchemas

Creates a copy of this SudokuSchemas with an optional new list of schemas.

countByDifficulty

fun countByDifficulty(): Map<Difficulty, Int>

Counts the number of schemas for each difficulty level.

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

Compares this SudokuSchemas to another object for equality.

findByDifficulty

fun findByDifficulty(difficulty: Difficulty): SudokuSchemas

Finds all SudokuSchema instances with the specified difficulty.

findBySudokuType

fun findBySudokuType(dimension: Dimension): SudokuSchemas

Finds all SudokuSchema instances with the specified Sudoku dimension.

getSeedsByDifficulty

fun getSeedsByDifficulty(difficulty: Difficulty): SudokuSchemas

Filters the schemas by difficulty.

fun getSeedsBySize(type: Dimension): SudokuSchemas

Filters the schemas by size (dimension).

getUniqueSudokuTypes

fun getUniqueSudokuTypes(): Set<Dimension>

Gets all unique Sudoku dimensions present in this set.

open override fun hashCode(): Int

Computes a hash code for this SudokuSchemas.

open override fun isEmpty(): Boolean

Checks if the Sudoku schemas set is empty.

open operator override fun iterator(): Iterator<SudokuSchema>

Returns an iterator over the SudokuSchema objects in this set.

mapToSudokuString

fun Iterable<Iterable<Int>>.mapToSudokuString(): String

inline fun <T> Iterable<Iterable<T>>.mapToSudokuString(crossinline valueMapper: T.() -> Int): String

Converts an Iterable of elements to a String representation using toJEncodedCell for mapping.

operator fun plus(schema: SudokuSchema): SudokuSchemas

Adds a single SudokuSchema to this SudokuSchemas collection.

operator fun plus(other: SudokuSchemas): SudokuSchemas

Adds another SudokuSchemas collection to this SudokuSchemas collection.

operator fun plus(other: Collection<SudokuSchema>): SudokuSchemas

Adds a collection of SudokuSchema objects to this SudokuSchemas collection.

fun <T> Iterable<T>.randomItem(random: Random): T

requireSchemasForDifficulty

fun SudokuSchemas.requireSchemasForDifficulty(difficulty: Difficulty)

Requires that there are Sudoku schemas for the given difficulty.

requireSchemasForType

fun SudokuSchemas.requireSchemasForType(type: Dimension)

Requires that there are Sudoku schemas for the given type.

fun toBuilder(): SudokuSchemas.Builder

Converts this SudokuSchemas instance into a Builder object.

open override fun toString(): String

Returns a string representation of this SudokuSchemas.