Struct goban::pieces::goban::Goban

pub struct Goban { /* fields omitted */ }

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

Implementations

impl Goban

pub fn chains(&self) -> &Vec<Chain>

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 vec(&self) -> Vec<Color>

Returns the underlying goban in a vector with a RowMajor Policy, calculated on the fly.

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

Like vec but in a matrix shape.

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. 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_chain_from_id(&self, ren_idx: ChainIdx) -> &Chain

Get the chain from their id

pub fn get_chain_by_board_idx(&self, board_idx: BoardIdx) -> Option<&Chain>

pub fn get_chain_by_point(&self, point: Point) -> Option<&Chain>

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_chain_indexes(
    &self,
    coord: Point
) -> impl Iterator<Item = ChainIdx> + '_

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

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

Get all the chains adjacent to the point. The result iterator can contains duplicates.

pub fn get_neighbors_strings_indices_by_idx(
    &self,
    index: usize
) -> impl Iterator<Item = ChainIdx> + '_

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_chain(&mut self, ren_to_remove_idx: ChainIdx)

Remove a string from the game, it add liberties to all adjacent chains that aren’t the same color.

pub fn get_chain_it(
    &self,
    chain_idx: ChainIdx
) -> impl Iterator<Item = usize> + '_

pub fn get_chain_it_by_board_idx(
    &self,
    board_idx: BoardIdx
) -> impl Iterator<Item = usize> + '_

impl Goban

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

pub fn get_chain_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_chains_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 get_territories(
    &self
) -> (impl Iterator<Item = Stone>, impl Iterator<Item = Stone>)

Get two iterators of empty stones.

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)

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

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

This method tests for !=.

impl Eq for Goban