Struct Grid

pub struct Grid {
    pub empty_cell_count: usize,
    pub solved: bool,
    /* private fields */
}

Struct to represent a Sudoku grid, with fields for the representation as rows, columns and boxes, as well as the candidate matrix, an empty cell count field, and a boolean representing whether the puzzle has been solved.

Fields

empty_cell_count: usize

solved: bool

Implementations

impl Grid

pub fn new() -> Grid

Construct a new grid.

pub fn rows(&self) -> &GridArray

Return a reference to the rows field.

pub fn candidate_matrix(&self) -> &CandidateMatrix

Return a reference to the candidate_matrix field.

pub fn get_cell(&self, cell: Coord) -> &Cell

Return a reference to the cell at cell.

pub fn clear(&mut self, cell: Coord) -> Result<(), GridError>

Set cell to empty. Returns an error if called on a clue.

pub fn update(&mut self, cell: Coord, val: u8) -> Result<(), GridError>

Update the value at cell to val. Returns an error if cell is a clue, or the update would result in another cell having zero valid candidates.

pub fn remove_candidate(&mut self, cell: Coord, val: u8) -> bool

Remove candidate val from the set at cell.

pub fn get_min_candidates_cell(&self) -> Coord

Returns the coordinates of the cell with the least valid candidates.

pub fn candidates_at(&self, cell: Coord) -> Vec<u8>

Gets the candidates at cell as a vector.

pub fn from_rows(rows: GridArray) -> Self

Constructs a Grid from a 2D array of Cells.

pub fn set_clues(&mut self)

Set all Filled cells to Clues of the same value. Used in puzzle generation.

pub fn reset_candidate_matrix(&mut self)

Trait Implementations

impl Clone for Grid

fn clone(&self) -> Grid

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Grid

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

Formats the value using the given formatter.

impl Default for Grid

fn default() -> Self

Returns the “default value” for a type.

impl Display for Grid

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

Formats the value using the given formatter.

impl From<[[Cell; 9]; 9]> for Grid

Enable conversion from 2D array of cells into Grid.

fn from(rows: GridArray) -> Grid

Converts to this type from the input type.

impl From<DisplayableGrid<Cell>> for Grid

Enable conversion from DisplayableGrid into Grid.

fn from(dg: DisplayableGrid<Cell>) -> Self

Converts to this type from the input type.