Struct sudokugen::board::CellLoc

pub struct CellLoc { /* private fields */ }

Represents a cell location in the board.

CellLoc structures are a shallow abstraction of the indice of the cell in the board, using them allows access helper functions to navigate the board and access each cell by a more intuitive line/column pair

Implementations

impl CellLoc

pub fn at(l: usize, c: usize, board_size: BoardSize) -> Self

Returns a cell representing the location at line l and column c. The third argument represents the size of the board.

use sudokugen::BoardSize;
use sudokugen::board::CellLoc;

let cell = CellLoc::at(0, 0, BoardSize::NineByNine);
assert_eq!(cell.line(), 0);
assert_eq!(cell.col(), 0);

pub fn new(idx: usize, board_size: BoardSize) -> Self

Reference a new location in the board. idx is the 0 based flat ordering of all cells in the board.

use sudokugen::board::CellLoc;
use sudokugen::BoardSize;

let cell = CellLoc::new(9, BoardSize::NineByNine);
assert_eq!((cell.line(), cell.col()), (1, 0));

pub fn get_index(&self) -> usize

Returns the 0 based flat index of this cell location

use sudokugen::BoardSize;
use sudokugen::board::CellLoc;

let cell = CellLoc::new(9, BoardSize::NineByNine);
assert_eq!(cell.get_index(), 9);

pub fn get_possible_values(&self, board: &Board) -> Option<BTreeSet<u8>>

Given a board this returns all the possible values for this cell location within that board. If the cell is not empty then it returns None

use sudokugen::board::CellLoc;    
use sudokugen::{Board, BoardSize};

let cell = CellLoc::at(0, 1, BoardSize::FourByFour);
let board: Board = "
1 . | . .
. . | . .
---------
. 2 | . .
. . | . .
".parse().unwrap();
assert_eq!(cell.get_possible_values(&board), Some(vec![3, 4].into_iter().collect()));

pub fn line(&self) -> usize

Returns the 0 based line number for this cell location

use sudokugen::board::CellLoc;
use sudokugen::BoardSize;

let cell = CellLoc::at(0, 0, BoardSize::NineByNine);
assert_eq!(cell.line(), 0);

pub fn col(&self) -> usize

Returns the 0 based column number for this cell location

use sudokugen::BoardSize;
use sudokugen::board::CellLoc;

let cell = CellLoc::at(0, 0, BoardSize::NineByNine);
assert_eq!(cell.col(), 0);

pub fn square(&self) -> usize

Returns the 0 based square number for this cell location. Squares are numbered line first and then columns.

use sudokugen::BoardSize;
use sudokugen::board::CellLoc;

let cell = CellLoc::at(4, 3, BoardSize::NineByNine);
assert_eq!(cell.square(), 4);

pub fn iter_line(&self) -> impl Iterator<Item = CellLoc>

Iterates over all cells in the same line as this one.

use sudokugen::board::CellLoc;
use sudokugen::BoardSize;

let cell = CellLoc::at(0, 0, BoardSize::FourByFour);
assert_eq!(
    cell.iter_line().collect::<Vec<CellLoc>>(),
    vec![
        CellLoc::at(0, 0, BoardSize::FourByFour),
        CellLoc::at(0, 1, BoardSize::FourByFour),
        CellLoc::at(0, 2, BoardSize::FourByFour),
        CellLoc::at(0, 3, BoardSize::FourByFour),
    ]
);

pub fn iter_col(&self) -> impl Iterator<Item = CellLoc>

Iterates over all cells in the same column as this one.

use sudokugen::board::CellLoc;
use sudokugen::BoardSize;

let cell = CellLoc::at(0, 0, BoardSize::FourByFour);
assert_eq!(
    cell.iter_col().collect::<Vec<CellLoc>>(),
    vec![
        CellLoc::at(0, 0, BoardSize::FourByFour),
        CellLoc::at(1, 0, BoardSize::FourByFour),
        CellLoc::at(2, 0, BoardSize::FourByFour),
        CellLoc::at(3, 0, BoardSize::FourByFour),
    ]
);

pub fn iter_square(&self) -> impl Iterator<Item = CellLoc>

Iterates over all cells in the same square as this one.

use sudokugen::board::CellLoc;
use sudokugen::BoardSize;

let cell = CellLoc::at(0, 0, BoardSize::FourByFour);
assert_eq!(
    cell.iter_square().collect::<Vec<CellLoc>>(),
    vec![
        CellLoc::at(0, 0, BoardSize::FourByFour),
        CellLoc::at(0, 1, BoardSize::FourByFour),
        CellLoc::at(1, 0, BoardSize::FourByFour),
        CellLoc::at(1, 1, BoardSize::FourByFour),
    ]
);

Trait Implementations

impl Clone for CellLoc

fn clone(&self) -> CellLoc

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CellLoc

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

Formats the value using the given formatter.

impl Display for CellLoc

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

Formats the value using the given formatter.

impl Hash for CellLoc

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for CellLoc

fn cmp(&self, other: &CellLoc) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for CellLoc

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for CellLoc

fn partial_cmp(&self, other: &CellLoc) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for CellLoc

impl Eq for CellLoc

impl StructuralPartialEq for CellLoc