Struct vampirc_uci::uci::UciSearchControl

pub struct UciSearchControl {
    pub search_moves: Vec<UciMove>,
    pub mate: Option<u8>,
    pub depth: Option<u8>,
    pub nodes: Option<u64>,
}

A struct that controls the engine's (non-time-related) search settings.

Fields

search_moves: Vec<UciMove>

Limits the search to these moves.

mate: Option<u8>

Search for mate in this many moves.

depth: Option<u8>

Search to this ply depth.

nodes: Option<u64>

Search no more than this many nodes (positions).

Methods

impl UciSearchControl

pub fn depth(depth: u8) -> UciSearchControl

Creates an UciSearchControl with depth set to the parameter and everything else set to empty or None.

pub fn mate(mate: u8) -> UciSearchControl

Creates an UciSearchControl with mate set to the parameter and everything else set to empty or None.

pub fn nodes(nodes: u64) -> UciSearchControl

Creates an UciSearchControl with nodes set to the parameter and everything else set to empty or None.

pub fn is_empty(&self) -> bool

Returns true if all of the struct's settings are either None or empty.

Trait Implementations

impl PartialEq<UciSearchControl> for UciSearchControl

fn eq(&self, other: &UciSearchControl) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Default for UciSearchControl

fn default() -> Self

Creates an empty UciSearchControl.

impl Clone for UciSearchControl

fn clone(&self) -> UciSearchControl

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Eq for UciSearchControl

impl Debug for UciSearchControl

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

Formats the value using the given formatter.

impl Hash for UciSearchControl

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