Struct shakmaty_syzygy::Tablebase

pub struct Tablebase<S: Position + Clone + Syzygy> { /* fields omitted */ }

A collection of tables.

Implementations

impl<S: Position + Clone + Syzygy> Tablebase<S>

pub fn new() -> Tablebase<S>

Create an empty collection of tables.

pub fn add_directory<P: AsRef<Path>>(&mut self, path: P) -> Result<usize>

Add all relevant tables from a directory.

Tables are selected by filename, e.g. KQvKP.rtbz. The files are not actually opened. This happens lazily when probing.

Note that probing generally requires tables for the specific material composition, as well as material compositions that are transitively reachable by captures and promotions. These are sometimes distributed separately, so make sure to add tables from all relevant directories.

Returns the number of added table files.

Errors

Returns an error result when:

• The path does not exist.
• path is not a directory.
• The process lacks permissions to list the directory.

pub fn add_file<P: AsRef<Path>>(&mut self, path: P) -> Result<()>

Add a table file.

The file is not actually opened. This happens lazily when probing.

Errors

Returns an error when no file exists at the given path or the filename does not indicate that it is a valid table file (e.g. KQvKP.rtbz).

pub fn probe_wdl(&self, pos: &S) -> Result<Wdl, SyzygyError>

Probe tables for the Wdl value of a position.

This indicates if the position is winning, lost or drawn with or without the 50-move rule, assuming pos is reached directly after a capture or pawn move.

Errors

See SyzygyError for possible error conditions.

pub fn probe_dtz(&self, pos: &S) -> Result<Dtz, SyzygyError>

Probe tables for the Dtz value of a position.

Min-maxing the DTZ of the available moves guarantees achieving the optimal outcome under the 50-move rule.

Requires both WDL and DTZ tables.

Errors

See SyzygyError for possible error conditions.

pub fn best_move(&self, pos: &S) -> Result<Option<(Move, Dtz)>, SyzygyError>

Select a DTZ-optimal move.

Requires both WDL and DTZ tables.

Errors

See SyzygyError for possible error conditions.

Trait Implementations

impl<S: Debug + Position + Clone + Syzygy> Debug for Tablebase<S>

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

Formats the value using the given formatter.

impl<S: Position + Clone + Syzygy> Default for Tablebase<S>

fn default() -> Tablebase<S>

Returns the “default value” for a type.