Struct goban::pieces::goban::Goban

pub struct Goban { /* fields omitted */ }

Represents a Goban. With an array with the stones encoded in u8. and the size.

Methods

impl Goban

pub fn tab(&self) -> &Vec<u8>

The values are stored in a one dimension vector. Using the RowMajor Policy.

pub fn b_stones(&self) -> &Vec<bool>

For future repr

pub fn w_stones(&self) -> &Vec<bool>

pub fn size(&self) -> &usize

impl Goban

pub fn new(size: usize) -> Self

pub fn new_with_order(size: usize, order: Order) -> Self

pub fn from_array(stones: &[u8], order: Order) -> Self

Creates a goban from an array of stones.

pub fn clear(&mut self)

Removes all the stones from the goban.

pub fn push(
    &mut self,
    coord: &Coord,
    color: Color
) -> Result<&mut Goban, String>

Put a stones in the goban. The coord depends on the order choose. default (line, colomn) the (0,0) coord is in the top left.

pub fn push_many<'a>(
    &'a mut self,
    coords: impl Iterator<Item = &'a Coord>,
    value: Color
)

Put many stones.

pub fn push_stone(&mut self, stone: &Stone) -> Result<&mut Goban, String>

pub fn get(&self, coord: &Coord) -> Color

pub fn get_neighbors(&self, coord: &Coord) -> impl Iterator<Item = Stone> + '_

Get all the neighbors to the coordinate

pub fn get_neighbors_stones(
    &self,
    coord: &Coord
) -> impl Iterator<Item = Stone> + '_

Get all the stones that are neighbor to the coord except empty intersections

pub fn get_stones(&self) -> impl Iterator<Item = Stone> + '_

Get all the stones except "Empty stones"

pub fn get_stones_by_color(
    &self,
    color: Color
) -> impl Iterator<Item = Stone> + '_

Get stones by their color.

pub fn get_liberties(&self, point: &Stone) -> impl Iterator<Item = Stone> + '_

Returns the empty stones connected to the point

pub fn get_nb_liberties(&self, point: &Stone) -> u8

Returns the number of liberties. of the stone

pub fn has_liberties(&self, point: &Stone) -> bool

Returns true if the stone has liberties.

pub fn raw_string(&self) -> String

Get a string for printing the goban in the memory shape (0,0) right top

pub fn pretty_string(&self) -> String

Get a string for printing the goban in normal shape (0,0 ) left bottom

impl Goban

pub fn are_dead(&self, stones: &HashSet<Stone>) -> bool

Test if a group of stones is dead.

"a group of stones is dead if it doesn't have liberties"

pub fn get_connected_stones(&self) -> Vec<HashSet<Stone>>

Get all the groups of connected stones, who has at least one stones without liberties.

pub fn get_connected_stones_color(&self, color: Color) -> Vec<HashSet<Stone>>

Get all the groups of connected stones of a color, who has at leart one stone without liberties.

if the color is empty it's an undefined behaviour

pub fn bfs(&self, point: &Stone) -> HashSet<Stone>

Can get a group of stones and his neighbors with a Breadth First Search, works for Empty stones too.

pub fn get_strongly_connected_stones(
    &self,
    stones: impl Iterator<Item = Stone>
) -> Vec<HashSet<Stone>>

Use a breadth first search to deduce the groups of connected stones. Get stones connected. [[x,y,z],[a,e,r]] example of return.

Trait Implementations

impl PartialEq<Goban> for Goban

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

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

#[must_use]

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

This method tests for !=.

impl Clone for Goban

fn clone(&self) -> Goban

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Eq for Goban

impl Display for Goban

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

Formats the value using the given formatter.

impl Debug for Goban

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

Formats the value using the given formatter.