Struct sudoku::Sudoku

pub struct Sudoku {
    pub order: u8,
    pub elements: Vec<Option<Element>>,
}

A (partial) grid of elements.

Fields

order: u8

The order of this sudoku.

elements: Vec<Option<Element>>

The elements composing this sudoku.

Methods

impl Sudoku

pub fn new(order: u8) -> Self

Constructs a new sudoku of the specified order.

This method reserves space in memory for the puzzle's elements.

Notes

This method does not generate a valid, uniquely solvable sudoku. If you wish to generate such a sudoku (which you likely do), use Sudoku::generate.

pub fn is_complete(&self) -> bool

Returns whether the puzzle is completely full of values.

pub fn groups(&self, pos: Point) -> [Group; 3]

Returns the relevant groups for checking a given element in the grid.

The number of groups is always equal to the number of dimensions plus one.

pub fn substitute(&self, index: Point, value: Option<Element>) -> Self

Places the specified value (or lack thereof) at the specified index, returning an owned copy.

Trait Implementations

impl Generate for Sudoku

fn generate(order: u8, difficulty: Difficulty) -> Self

Generates a puzzle of the desired order and difficulty.

impl Clone for Sudoku

fn clone(&self) -> Sudoku

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Sudoku

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

impl PartialEq for Sudoku

fn eq(&self, __arg_0: &Sudoku) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, __arg_0: &Sudoku) -> bool

This method tests for !=.

impl Grid for Sudoku

fn points(&self) -> Vec<Point>

Returns all points in the grid.

impl Index<Point> for Sudoku

type Output = Option<Element>

The returned type after indexing.

fn index(&self, index: Point) -> &Self::Output

Performs the indexing (container[index]) operation.

impl Puzzle for Sudoku

fn order(&self) -> u8

The order of the puzzle.

impl Solve for Sudoku

fn solution(&self) -> Result<Self, SolveError>

Returns the puzzle's unique solution if it exists.

fn is_uniquely_solvable(&self) -> bool

Whether the puzzle has a unique solution.

impl Score for Sudoku

fn score(&self) -> Option<usize>

The raw difficulty score of this puzzle.

fn difficulty(&self) -> Option<Difficulty>

The graded difficulty score of this puzzle.

impl Display for Sudoku

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

Formats the value using the given formatter.

impl FromStr for Sudoku

type Err = ParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.