Struct Rustoku

pub struct Rustoku {
    pub board: Board,
    pub masks: Masks,
    pub candidates: Candidates,
    pub techniques: TechniqueFlags,
}

Solver primitive that uses backtracking and bitmasking for constraints.

This struct supports the ability to:

• Initialize from a 2D array, a flat byte array, or a string representation
• Solve a Sudoku puzzle using backtracking with Minimum Remaining Values (MRV)
• Generate a Sudoku puzzle with a unique solution based on the number of clues specified
• Check if a Sudoku puzzle is solved correctly

Examples

Solve a Sudoku puzzle:

use rustoku_lib::Rustoku;
let puzzle = "530070000600195000098000060800060003400803001700020006060000280000419005000080079";
let mut rustoku = Rustoku::new_from_str(puzzle).unwrap();
assert!(rustoku.solve_any().is_some());

Generate a Sudoku puzzle:

use rustoku_lib::{Rustoku, generate_board};
let board = generate_board(30).unwrap();
let solution = Rustoku::new(board).unwrap().solve_all();
assert_eq!(solution.len(), 1);

Check if a Sudoku puzzle is solved:

use rustoku_lib::Rustoku;
let puzzle = "534678912672195348198342567859761423426853791713924856961537284287419635345286179";
let rustoku = Rustoku::new_from_str(puzzle).unwrap();
assert!(rustoku.is_solved());

Fields

board: Board

The current state of the Sudoku board.

masks: Masks

Bitmasks that check if a cell is safe in a row, column and box.

candidates: Candidates

Candidate cache from computing the bitmasks.

techniques: TechniqueFlags

Techniques used during the initial phase of solving.

Implementations

impl Rustoku

pub fn new(initial_board: Board) -> Result<Self, RustokuError>

Constructs a new Rustoku instance from an initial Board.

pub fn new_from_str(s: &str) -> Result<Self, RustokuError>

Constructs a new Rustoku instance from a string representation of the board.

pub fn with_techniques(self, techniques: TechniqueFlags) -> Self

Returns the existing Rustoku instance, with modified techniques.

pub fn solve_until(&mut self, bound: usize) -> Vec<Solution>

Solves the Sudoku puzzle up to a certain bound, returning solutions with their solve paths.

pub fn solve_any(&mut self) -> Option<Solution>

Attempts to solve the Sudoku puzzle using backtracking with MRV (Minimum Remaining Values).

pub fn solve_all(&mut self) -> Vec<Solution>

Finds all possible solutions for the Sudoku puzzle.

pub fn is_solved(&self) -> bool

Checks if the Sudoku puzzle is solved correctly.

Trait Implementations

impl Clone for Rustoku

fn clone(&self) -> Rustoku

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Rustoku

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Copy for Rustoku