Struct goban::pieces::goban::Goban

pub struct Goban { /* fields omitted */ }

Represents a Goban. the stones are stored in ROW MAJOR (row, colum)

Implementations

impl Goban

pub fn go_strings(&self) -> &Vec<Option<ByAddress<Rc<GoString>>>>

impl Goban

pub fn size(&self) -> (usize, usize)

pub fn zobrist_hash(&self) -> u64

impl Goban

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

Creates a Goban

Arguments

• (height, width) a tuple with the height and the width of the desired goban.

pub fn from_array(stones: &[Color]) -> Self

Creates a Goban from an array of stones.

pub fn raw(&self) -> Vec<Color>

Returns the underlying goban in a vector with a RowMajor Policy

pub fn number_of_stones(&self) -> (u32, u32)

Get number of stones on the goban. (number of black stones, number of white stones)

pub fn push(&mut self, point: Point, color: Color) -> &mut Self

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

Panics

if the point is out of bounds

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

Helper function to put a stone.

pub fn push_many(&mut self, points: &[Point], value: Color)

Put many stones.

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

Get all the neighbors to the coordinate including empty intersections.

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

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

pub fn get_neighbors_strings(
    &self,
    coord: Point
) -> impl Iterator<Item = ByAddress<Rc<GoString>>> + '_

Get all the neighbors go strings to the point. Only return point with a color.

pub fn get_neighbors_strings_index(
    &self,
    index: usize
) -> impl Iterator<Item = ByAddress<Rc<GoString>>> + '_

pub fn get_stone(&self, point: Point) -> Color

Function for getting the stone in the goban.

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_points_by_color(&self, color: Color) -> impl Iterator<Item = Point>

Get points by their color.

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

Returns the empty stones connected to the stone

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

Returns true if the stone has liberties.

pub fn pretty_string(&self) -> String

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

pub fn remove_go_string(&mut self, go_string_to_remove: ByAddress<Rc<GoString>>)

Remove a string from the game, it add liberties to all adjacent string of not the same color.

pub fn remove_captured_stones_turn(
    &mut self,
    color: Color
) -> (u32, Option<Point>)

Removes the dead stones from the goban by specifying a color stone. If there is only one stone captured, then update self.ko_point. Returns the number of stones removed from the goban.

impl Goban

pub fn get_strings_of_stones_without_liberties_by_color(
    &self,
    color: Color
) -> impl Iterator<Item = ByAddress<Rc<GoString>>> + '_

pub fn get_string_from_stone(&self, stone: Stone) -> HashSet<Stone>

Get the chain of stones connected to a stone. with a Breadth First Search, works for Empty stones too.

Ex: Passing a stone 'a' it will return and HashSet [a,b,t,z] with the string where the stone is. It will return the stone alone if it's lonely

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

Pass a iterator of stones [x,a] and It will compute the string of each stone stones. Use a breadth first search to deduce the groups of connected stones. Get stones connected. [[x,y,z],[a,e,r]] example of return.

pub fn calculate_territories(&self) -> (usize, usize)

Calculates a score for the endgame. It's a naive implementation, it counts only territories with the same color surrounding them.

Returns (black territory, white territory)

pub fn get_territories(
    &self
) -> (impl Iterator<Item = Stone>, impl Iterator<Item = Stone>)

Get two iterators of empty stones.

Trait Implementations

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 Debug for Goban

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

Formats the value using the given formatter.

impl Default for Goban

fn default() -> Self

Returns the "default value" for a type.

impl Display for Goban

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

Formats the value using the given formatter.

impl Eq for Goban

impl Hash for Goban

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, 

Feeds a slice of this type into the given [Hasher].

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 !=.