BenBot 1.7.5
A chess engine
Loading...
Searching...
No Matches
chess::uci::GoCommandOptions Struct Referencefinal

#include <libchess/uci/CommandParsing.hpp>

Public Attributes

optional< milliseconds > blackInc
optional< milliseconds > blackTimeLeft
optional< size_t > depth
bool infinite { false }
optional< size_t > mateIn
moves::MoveList moves
optional< size_t > movesToGo
optional< size_t > nodes
bool ponderMode { false }
optional< milliseconds > searchTime
optional< milliseconds > whiteInc
optional< milliseconds > whiteTimeLeft

(Note that these are not member symbols.)

auto parse_go_options (string_view options, const Position &currentPosition) -> GoCommandOptions

Detailed Description

This struct encapsulates the options given to a UCI [3] "go" command.

See also
parse_go_options()

Definition at line 92 of file CommandParsing.hpp.

Member Data Documentation

◆ blackInc

optional<milliseconds> chess::uci::GoCommandOptions::blackInc

Increment for Black, in milliseconds.

Definition at line 114 of file CommandParsing.hpp.

◆ blackTimeLeft

optional<milliseconds> chess::uci::GoCommandOptions::blackTimeLeft

Number of milliseconds that Black has left.

Definition at line 108 of file CommandParsing.hpp.

◆ depth

optional<size_t> chess::uci::GoCommandOptions::depth

Restrict the search to this many plies only.

Definition at line 123 of file CommandParsing.hpp.

◆ infinite

bool chess::uci::GoCommandOptions::infinite { false }

If true, search until the "stop" command.

Definition at line 102 of file CommandParsing.hpp.

◆ mateIn

optional<size_t> chess::uci::GoCommandOptions::mateIn

Search for a mate in this many moves.

Definition at line 129 of file CommandParsing.hpp.

◆ moves

moves::MoveList chess::uci::GoCommandOptions::moves

The search should be restricted to only these moves. Empty if the "moves" suboption was not specified.

Definition at line 96 of file CommandParsing.hpp.

◆ movesToGo

optional<size_t> chess::uci::GoCommandOptions::movesToGo

Number of moves to the next time control.

Definition at line 120 of file CommandParsing.hpp.

◆ nodes

optional<size_t> chess::uci::GoCommandOptions::nodes

Search this many nodes only.

Definition at line 126 of file CommandParsing.hpp.

◆ ponderMode

bool chess::uci::GoCommandOptions::ponderMode { false }

True if this "go" command is in ponder mode.

Definition at line 99 of file CommandParsing.hpp.

◆ searchTime

optional<milliseconds> chess::uci::GoCommandOptions::searchTime

Search for exactly this number of milliseconds.

Definition at line 117 of file CommandParsing.hpp.

◆ whiteInc

optional<milliseconds> chess::uci::GoCommandOptions::whiteInc

Increment for White, in milliseconds.

Definition at line 111 of file CommandParsing.hpp.

◆ whiteTimeLeft

optional<milliseconds> chess::uci::GoCommandOptions::whiteTimeLeft

Number of milliseconds that White has left.

Definition at line 105 of file CommandParsing.hpp.


The documentation for this struct was generated from the following file: