Struct Engine

pub struct Engine { /* private fields */ }

Engine wraps up all parameters required for running any kind of search. It is stateful because to properly evaluate a chess position the history of moves for the current game need to be tracked.

If a new game is going to be started, the engine needs to be told so.

Implementations

impl Engine

pub fn new() -> Self

pub fn game(&self) -> &Game

Returns reference to current game of engine.

pub fn debug(&self) -> &bool

Returns reference to current debug flag of engine.

pub fn transposition_table(&self) -> &TranspositionTable

Returns reference to engine’s transposition table.

pub fn set_game<T: Into<Game>>(&mut self, game: T)

Set the game or position for evaluation.

pub fn set_debug(&mut self, new_debug: bool)

Update the engine’s debug parameter.

pub fn new_game(&mut self) -> Result<()>

Informs engine that next search will be from a new game. Returns Ok if engine succeeded in changing state for a new game, Err otherwise.

pub fn try_set_transpositions_mb(&mut self, new_mb: usize) -> Result<usize>

Attempt to set a new size for the transposition table in Megabytes. Table is set only if there is exactly one reference to the table (not used in search). Returns Ok(new capacity) on success or Err if no change was made.

pub fn try_clear_transpositions(&mut self) -> Result<()>

Attempt to clear the transposition table. Table is cleared only if there are no other Arcs to the table. Returns Ok on success or Err if the table was not cleared.

pub fn search_sync(&mut self, mode: Mode) -> SearchResult

Run a blocking search.

pub fn search<T>(&mut self, mode: Mode, sender: Sender<T>) -> Result<()>

where T: From<SearchResult> + Send + 'static,

Run a non-blocking search. The engine only runs one search at a time, so if it is not ready, it fails to begin. If the engine is available for searching, it ensures its stopper is unset.

pub fn ponder(&self)

pub fn stop(&self)

Informs the active search to stop searching as soon as possible.

pub fn unstop(&self)

Resets stopper flag.

pub fn wait(&mut self)

Engine blocks thread until search is completed.

pub fn ready(&self) -> bool

Returns true if the engine is ready to start a search. Only one search may run at a time, so if a search is in progress, engine is not ready.

pub fn shutdown(self)

Consumes and shuts down the Engine. Signals any threads to stop searching and waits for internal resources to close first. The engine will normally close up properly when dropped, however this function provides a way to do it explicitly directly from the API.

Trait Implementations

impl Default for Engine

fn default() -> Self

Returns the “default value” for a type.

impl Drop for Engine

fn drop(&mut self)

Executes the destructor for this type.