Struct takuzu::Grid

pub struct Grid { /* fields omitted */ }

An opaque container for manipulating takuzu grids.

It provides the internal logic and other convenience functions. To create a Grid you can:

• create an empty one yourself with Grid::new.
• use the FromStr trait, e.g. by calling parse on a string.

You can modify the cells as you like. Grids that break the rules will not be solved.

Implementations

impl Grid

pub fn new(size: usize) -> Result<Self, GridSizeError>

Creates an new empty grid of a given size.

Errors

Returns an error if the size is an odd number or 0.

pub fn size(&self) -> usize

Returns the number of rows/columns of the array.

pub fn as_slice(&self) -> &[Cell]

Extracts a slice containing the entire underlying array.

pub fn as_mut_slice(&mut self) -> &mut [Cell]

Extracts a mutable slice of the entire underlying array.

pub fn is_filled(&self) -> bool

Returns true if the grid contains no Empty cell.

pub fn is_legal(&self) -> bool

Verifies that the grid does not currently violate any of the rules.

Returns true if the grid is legal.

pub fn is_cell_legal(&self, coord: (usize, usize)) -> bool

Verifies that a certain cell does not violate any of the rules.

Returns true if the value is legal.

pub fn next_empty(&self) -> Option<(usize, usize)>

Returns the coordinates of the first Empty cell or None if the grid is filled.

pub fn solve(&self) -> Result<Vec<Self>, GridError>

Solves the grid using both rules logic and a backtracking algorithm.

Returns an array containing the solution(s), or an empty array if there are none.

Errors

Returns an error before any attempt at solving if the grid breaks any of the rules (i.e. if is_legal returns false).

Trait Implementations

impl Clone for Grid

fn clone(&self) -> Grid

Returns a copy of the value.

pub 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 Display for Grid

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

Formats the value using the given formatter.

impl Eq for Grid

impl FromStr for Grid

type Err = GridParseError

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.

impl Hash for Grid

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl Index<(usize, usize)> for Grid

type Output = Cell

The returned type after indexing.

fn index(&self, (i, j): (usize, usize)) -> &Self::Output

Performs the indexing (container[index]) operation.

impl IndexMut<(usize, usize)> for Grid

fn index_mut(&mut self, (i, j): (usize, usize)) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl PartialEq<Grid> for Grid

fn eq(&self, other: &Grid) -> bool

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

fn ne(&self, other: &Grid) -> bool

This method tests for !=.

impl StructuralEq for Grid

impl StructuralPartialEq for Grid