Struct Point

pub struct Point(/* private fields */);

Specifies a sudoku element’s location in space.

The point is fully specified in DIMENSIONS dimensions.

Coordinate System

The coordinate system used in this library sets the origin in the top-left corner, with increasing x to the right and increasing y downward.

Additional axes (if applicable) follow the right-hand rule.

Implementations

impl Point

pub fn fold(&self, order: u8) -> usize

Compresses an n-dimensional point to a single coordinate.

Inverse of Point::unfold.

pub fn unfold(value: usize, order: u8) -> Self

Decompresses a single coordinate into an n-dimensional point.

Inverse of Point::fold.

pub fn snap(self, order: u8) -> Self

Snaps a point to the grid (returns the upper-left corner of the box).

pub fn with_x(value: u8) -> Self

Creates a point with the given x-coordinate and all other coordinates zero.

pub fn with_y(value: u8) -> Self

Creates a point with the given y-coordinate and all other coordinates zero.

pub fn origin() -> Self

The point with all coordinates identically zero.

Trait Implementations

impl Clone for Point

fn clone(&self) -> Point

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Point

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

Formats the value using the given formatter.

impl Display for Point

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

Formats the value using the given formatter.

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 Index<usize> for Point

type Output = u8

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl IndexMut<usize> for Point

fn index_mut(&mut self, index: usize) -> &mut u8

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

impl PartialEq for Point

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Copy for Point

impl StructuralPartialEq for Point