Sudoku-plus: An Expandable Sudoku Library

sudoku-plus is a versatile Rust library designed for generating and solving various Sudoku structures, including Plane, Multi-plane, and Cubic Sudoku.

Roadmap for Version 1.0

The following features are planned for the sudoku-plus ecosystem.

• Completed: Implementation and documentation are at least 95% complete.
• In Progress: Implementation or documentation is below 95%, or work has not yet begun.

1. 2D Sudoku

• PlaneSudoku: A generic 2D Sudoku with a (N^{2 X N}2) grid. You can define the size by choosing the constant N. -- PlaneSudoku

2. 3D Sudoku

• Multi-plane Sudoku: A 3D Sudoku structure with dimensions of (N^{2 X N}2 X N^2). The size is determined by the constant N. -- MultiplaneSudoku

• Cubic Sudoku: A 3D Sudoku structure with dimensions of (N^{3 X N}3 X N^3). The size is determined by the constant N. -- CubicSudoku

3. Sudoku Elements

• Sudoku Element: A generic Sudoku component designed for building complex applications, such as academic timetable generators powered by Sudoku algorithms. -- SudokuElement.

Versioning Policy

The project will reach Version 1.0.0 once all functional areas listed above are fully implemented.

• Pre-v1.0: Versions will range up to 0.3.x based on the progress of the listed functionalities.
• Post-v1.0: New features and stable releases will follow standard semantic versioning beyond 1.0.0.

Note: Version numbers like 0.2.0 indicate progress through the functionality list, not necessarily a 20% completion of the entire codebase.

Breaking Changes

For a detailed history of API changes and migration guides, please refer to BreakingChanges.md for a detailed history of API changes.