coenmooij/sudoku

Sudoku package for generating, validating and solving sudoku puzzles

, _(*1)

sudoku

Library for generating, validating, solving sudoku puzzles, _(*2)

Composer

To use this package, simply run composer require coenmooij/sudoku., _(*3)

Usage

SudokuService

Exposes the main functionality of the library in a service., _(*4)

Solvers

BacktrackSolver

Solves any solvable grid using an informed backtrack algorithm. Throws an UnsolvableException if it fails., _(*5)

SimpleSolver

Solves the grid using only row, column and block checks. Will return the (partially) completed Grid., _(*6)

Generators

SolutionGenerator

Generates a complete Grid, _(*7)

PuzzleGenerator

Creates a puzzle based on a complete Grid and a Difficulty Difficulty ranges from 1-5 and can be accessed by a constant. e.g. Difficulty::EASY., _(*8)

HintGenerator

From a grid it creates hints. It returns locations which can be solved by row, column & block checks. You can either get a random one or all of them., _(*9)

GridSerializer

GridSerializer is a simple serializer that turns a 81 character string into a Grid and back. e.g. 642957138719843652538126794483712569976538421125694387294361875357489216861275943 Empty values will be serialized to 0 but the deserializer also accepts alphabetical characters as empty values., _(*10)

Validator

DigValidator

Helper class to see if it is 'safe' to dig out the value at a certain Location. It checks whether the Grid is still uniquely solvable., _(*11)

GridValidator

Simple utility class to check if all (row, column and block) constraints are still met., _(*12)