Struct Game

pub struct Game<const N: usize, const HALF_KOMI: i8> {
    pub board: Board<N>,
    pub to_move: Color,
    pub white_reserves: Reserves<N>,
    pub black_reserves: Reserves<N>,
    pub ply: u16,
    pub reversible_plies: u16,
}

Fields

board: Board<N>

to_move: Color

white_reserves: Reserves<N>

black_reserves: Reserves<N>

ply: u16

reversible_plies: u16

Implementations

impl<const N: usize, const HALF_KOMI: i8> Game<N, HALF_KOMI>

pub fn play(&mut self, my_move: Move) -> Result<(), PlayError>

Play a move on the board.

Errors

In case the move is invalid an error is returned and the game might be in an invalid state.

impl<const N: usize, const HALF_KOMI: i8> Game<N, HALF_KOMI>

pub fn possible_moves(&self, moves: &mut Vec<Move>)

Populate moves vector with all possible moves for the current position.

Panics

If the move vector is not empty.

impl<const N: usize, const HALF_KOMI: i8> Game<N, HALF_KOMI>

where Reserves<N>: Default,

pub fn from_moves(moves: &[Move]) -> Result<Self, PlayError>

Creates a default game and plays the supplied moves.

Errors

If a move is invalid or the game is over when trying to play a move, a PlayError is returned.

pub fn from_ptn_moves(moves: &[&str]) -> Self

Creates a default game and plays all the moves after parsing them.

Panics

Panics if there is an error in parsing or if any move is invalid during play.

impl<const N: usize, const HALF_KOMI: i8> Game<N, HALF_KOMI>

pub fn canonical(self) -> Self

impl<const N: usize, const HALF_KOMI: i8> Game<N, HALF_KOMI>

pub fn result(&self) -> GameResult

Trait Implementations

impl<const N: usize, const HALF_KOMI: i8> Clone for Game<N, HALF_KOMI>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<const N: usize, const HALF_KOMI: i8> Debug for Game<N, HALF_KOMI>

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

Formats the value using the given formatter.

impl<const N: usize, const HALF_KOMI: i8> Default for Game<N, HALF_KOMI>

where Reserves<N>: Default,

fn default() -> Self

Returns the “default value” for a type.

impl<const N: usize, const HALF_KOMI: i8> From<Game<N, HALF_KOMI>> for Tps

fn from(game: Game<N, HALF_KOMI>) -> Self

Converts to this type from the input type.

impl<const N: usize, const HALF_KOMI: i8> From<Tps> for Game<N, HALF_KOMI>

where Reserves<N>: Default,

fn from(tps: Tps) -> Self

Converts to this type from the input type.

impl<const N: usize, const HALF_KOMI: i8> Hash for Game<N, HALF_KOMI>

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<const N: usize, const HALF_KOMI: i8> Ord for Game<N, HALF_KOMI>

fn cmp(&self, other: &Game<N, HALF_KOMI>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<const N: usize, const HALF_KOMI: i8> PartialEq for Game<N, HALF_KOMI>

fn eq(&self, other: &Game<N, HALF_KOMI>) -> 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<const N: usize, const HALF_KOMI: i8> PartialOrd for Game<N, HALF_KOMI>

fn partial_cmp(&self, other: &Game<N, HALF_KOMI>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<const N: usize, const HALF_KOMI: i8> Symmetry<N> for Game<N, HALF_KOMI>

fn symmetries(&self) -> [Self; 8]

impl<const N: usize, const HALF_KOMI: i8> Eq for Game<N, HALF_KOMI>

impl<const N: usize, const HALF_KOMI: i8> StructuralPartialEq for Game<N, HALF_KOMI>