rustoku-lib 0.15.0

Lightning-fast Sudoku solving and generation
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83

# Rustoku

[![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/huangsam/rustoku/ci.yml)](https://github.com/huangsam/rustoku/actions)
[![docs.rs](https://img.shields.io/docsrs/rustoku-lib)](https://docs.rs/crate/rustoku-lib/latest)
[![License](https://img.shields.io/github/license/huangsam/rustoku)](https://github.com/huangsam/rustoku/blob/main/LICENSE)

**Lightning-fast Sudoku solving and generation, crafted in Rust.**

Rustoku is a highly optimized Sudoku puzzle solver and generator built with a focus on speed and clarity. It leverages [bitmasking] for constraint tracking and a backtracking algorithm with [MRV] for puzzle navigation. Try the [demo](https://sambyte.net/rustoku/) in your browser, or install the Rust [library] and [CLI] crates.

- **Fast solving with clear solve paths:** Rustoku can find solutions in microseconds, even for the most complex puzzles. Plus, it shows you the step-by-step solve path for understanding how the solution was reached
- **Unique and configurable puzzle generation:** Create Sudoku puzzles that are guaranteed to have only one solution. You can also customize the difficulty of the puzzle to your liking
- **Human-like puzzle solving:** Beyond raw speed, it mimics human expertise, employing a full range of techniques from Naked Singles to X-Wing to solve puzzles with precision
- **Multi-platform access:** Use Rustoku as a Rust library or CLI, run it in the browser via the `rustoku-wasm` crate or call it from Python via `rustoku-py`, or try the live demo

[bitmasking]: https://www.geeksforgeeks.org/what-is-bitmasking/
[MRV]: https://www.alooba.com/skills/concepts/data-science-6/minimum-remaining-values/
[library]: https://crates.io/crates/rustoku-lib
[CLI]: https://crates.io/crates/rustoku-cli

## Documentation

Comprehensive guides are available for all distribution channels:

- [**CLI User Guide**](https://github.com/huangsam/rustoku/blob/main/docs/cli.md) - Reference for terminal usage.
- [**Library User Guide**](https://github.com/huangsam/rustoku/blob/main/docs/library.md) - For Rust developers using `rustoku-lib`.
- [**WebAssembly Guide**](https://github.com/huangsam/rustoku/blob/main/docs/wasm.md) - Browser-side integration.
- [**Python Guide**](https://github.com/huangsam/rustoku/blob/main/docs/python.md) - Using the engine from Python.

## Getting Started

Commands to get you going:

```bash
# This installs the binary at $HOME/.cargo/bin
cargo install rustoku-cli

# Generate puzzles
rustoku-cli generate
rustoku-cli generate --clues 45
rustoku-cli generate --difficulty expert

# Solve puzzles
rustoku-cli solve any 530070000600195000098000060800060003400803001700020006060000280000419005000080079
rustoku-cli solve any --human --verbose 801027003000600080005040010000070809900000050600900200000230160570160000000000000
rustoku-cli solve all 295743001431865900876192543387459216612387495549216738763500000000000000000000000
rustoku-cli solve all --until 5 000000500080760092001005470056309000009001004320500010000200700700000000000000000
rustoku-cli solve csv sudoku.csv

# Check solutions
rustoku-cli check 295743861431865927876192543387459216612387495549216738763524189154938672928671354

# Display puzzle
rustoku-cli show 900507400007080000830401006402000300090000065000050080200908000080074000700210803
```

Example output from the `show` command:

```
+-------+-------+-------+
| 9 . . | 5 . 7 | 4 . . |
| . . 7 | . 8 . | . . . |
| 8 3 . | 4 . 1 | . . 6 |
+-------+-------+-------+
| 4 . 2 | . . . | 3 . . |
| . 9 . | . . . | . 6 5 |
| . . . | . 5 . | . 8 . |
+-------+-------+-------+
| 2 . . | 9 . 8 | . . . |
| . 8 . | . 7 4 | . . . |
| 7 . . | 2 1 . | 8 . 3 |
+-------+-------+-------+
Line format: 900507400007080000830401006402000300090000065000050080200908000080074000700210803
```

Try some more examples from these sites:

- [HoDoKu](https://hodoku.sourceforge.net/en/index.php)
- [heetbeet/purge-and-merge](https://github.com/heetbeet/purge-and-merge)
- [ruohanrao/sudoku](https://www.kaggle.com/datasets/rohanrao/sudoku)
- [Ritvik19/Sudoku-Dataset](https://huggingface.co/datasets/Ritvik19/Sudoku-Dataset)

Dive into the world of high-performance Sudoku today!