Struct sudokugen::solver::generator::Puzzle

source ·
pub struct Puzzle { /* private fields */ }
Expand description

This structure represents a generated board and its solution

This struct can only be created by calling the generate function, which will create a random board with a unique solution.

Implementations§

source§

impl Puzzle

source

pub fn generate(board_size: BoardSize) -> Puzzle

Generate a new sudoku puzzle with a unique solution.

The generate function creates a random board with a unique solution. It does this by “solving” the empty board using random guesses whenever it cannot find the correct solution. Once the empty board is solved, it iterates over each of the guesses and removes it if that guess is the only valid option for that cell.

use sudokugen::{Puzzle, BoardSize};

let puzzle = Puzzle::generate(BoardSize::NineByNine);

println!("{}", puzzle.board());
println!("{}", puzzle.solution());
source

pub fn board(&self) -> &Board

Returns the minimal board generated

use sudokugen::{Puzzle, BoardSize};

let gen = Puzzle::generate(BoardSize::NineByNine);
println!("{}", gen.board());
source

pub fn solution(&self) -> &Board

Returns the solution for the generated board

use sudokugen::{Puzzle, BoardSize};

let gen = Puzzle::generate(BoardSize::NineByNine);
println!("{}", gen.solution());
source

pub fn is_solution_unique(&self) -> bool

Verify that the solution for the generated board is unique.

use sudokugen::{Puzzle, BoardSize};

let gen = Puzzle::generate(BoardSize::NineByNine);
assert!(gen.is_solution_unique());

Auto Trait Implementations§

§

impl Freeze for Puzzle

§

impl RefUnwindSafe for Puzzle

§

impl Send for Puzzle

§

impl Sync for Puzzle

§

impl Unpin for Puzzle

§

impl UnwindSafe for Puzzle

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> IntoEither for T

source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

impl<T> Pointable for T

source§

const ALIGN: usize = _

The alignment of pointer.
§

type Init = T

The type for initializers.
source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

source§

fn vzip(self) -> V