Struct sudoku_variants::generator::Generator

pub struct Generator<R: Rng> { /* fields omitted */ }

A generator randomly generates a full Sudoku, that is, a Sudoku with no missing digits. It uses a random number generator to decide the content. For most cases, sensible defaults are provided by Generator::new_default.

Implementations

impl Generator<ThreadRng>

pub fn new_default() -> Generator<ThreadRng>

Creates a new generator that uses a ThreadRng to generate the random digits.

impl<R: Rng> Generator<R>

pub fn new(rng: R) -> Generator<R>

Creates a new generator that uses the given random number generator to generate random digits.

pub fn generate<C: Constraint + Clone>(
    &mut self,
    block_width: usize,
    block_height: usize,
    constraint: C
) -> SudokuResult<Sudoku<C>>

Generates a new random Sudoku with all digits that matches the given parameters. If it is not possible, an error will be returned.

It is guaranteed that Sudoku::is_valid on the result returns true.

Arguments

• block_width: The horizontal dimension of one sub-block of the grid. To ensure a square grid, this is also the number of blocks that compose the grid vertically. For an ordinary Sudoku grid, this is 3. Must be greater than 0.
• block_height: The vertical dimension of one sub-block of the grid. To ensure a square grid, this is also the number of blocks that compose the grid horizontally. For an ordinary Sudoku grid, this is 3. Must be greater than 0.
• constraint: The constraint which will be matched by the generated Sudoku, which will also be contained and checked by the output Sudoku.

Errors

• SudokuError::InvalidDimensions If block_width or block_height is invalid (zero).
• SudokuError::UnsatisfiableConstraint If there are no grids with the given dimensions that match the provided constraint.