Struct spacebattleship::board::rectangular::RectDimensions

pub struct RectDimensions { /* fields omitted */ }

Simple rectangular dimensions. Optionally supports wrapping.

Implementations

impl RectDimensions

pub fn new(width: usize, height: usize) -> Self

Create new RectDimensions with the specified width and height. Defaults to no wrapping. Panics if width * height exceeds usize::max_value() or if width or height is 0.

pub fn new_wrapping<B: Into<BitFlags<Wrapping>>>(
    width: usize,
    height: usize,
    wrapping: B
) -> Self

Create new RectDimensions with the specified width and height, wrapping on the specified axes. Panics if width * height exceeds usize::max_value() or if width or height is 0.

pub fn try_new(width: usize, height: usize) -> Option<Self>

Create new RectDimensions with the specified width and height. Defaults to no wrapping. Returns None if width * height exceeds usize::max_value() or if width or height is 0.

pub fn try_new_wrapping<B: Into<BitFlags<Wrapping>>>(
    width: usize,
    height: usize,
    wrapping: B
) -> Option<Self>

Create new RectDimensions with the specified width and height. Returns None if width * height exceeds usize::max_value() or if width or height is 0.

pub fn width(&self) -> usize

Get the width of these RectDimensions.

pub fn height(&self) -> usize

Get the height of these RectDimensions.

pub fn wrapping(&self) -> BitFlags<Wrapping>

Get the wrapping modes of these RectDimensions.

pub fn wrap_x(&self) -> bool

Whether the grid wraps along the x direciton.

pub fn wrap_y(&self) -> bool

Whether the grid wraps along the y direciton.

pub fn iter_coordinates(
    &self
) -> impl Iterator<Item = impl Iterator<Item = Coordinate>>

Get an iterator over rows of this grid. Each row is an iterator over the coordinates of that row.

Trait Implementations

impl Clone for RectDimensions

fn clone(&self) -> RectDimensions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl ColinearCheck for RectDimensions

fn is_colinear(&self, c1: &Coordinate, c2: &Coordinate, c3: &Coordinate) -> bool

Returns true if the 3 coordinates are colinear.

impl Copy for RectDimensions

impl Debug for RectDimensions

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

Formats the value using the given formatter.

impl Default for RectDimensions

fn default() -> Self

Construct the default rectangular dimensions, a 10x10 board with no wrapping.

impl Dimensions for RectDimensions

type Coordinate = Coordinate

The type used to identify cells on the board.

type NeighborIterState = RectNeighbors

Type used in the neighbor iterator.

fn total_size(&self) -> usize

Compute the linear total size of these Dimensions.

fn try_linearize(&self, coord: &Self::Coordinate) -> Option<usize>

Convert a coordinate to a linear index within this dimension. Returns None if the coordinate is out of range for the dimension.

fn linearize(&self, coord: &Self::Coordinate) -> usize

Convert a coordinate to a linear index within this dimension. Panics if the coordinate is out of range for the dimension.

fn neighbors(
    &self,
    coord: Self::Coordinate
) -> NeighborIter<Self::NeighborIterState>

Iterate the neighbors of the given coordinate.

fn is_neighbor(&self, c1: &Self::Coordinate, c2: &Self::Coordinate) -> bool

Return true if the given coordinates are neighbors. Defeault implemntation checks the neighbors iter. A board may wish to provide a more efficient implementation.

impl Eq for RectDimensions

impl PartialEq<RectDimensions> for RectDimensions

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

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

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

This method tests for !=.

impl StructuralEq for RectDimensions

impl StructuralPartialEq for RectDimensions