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

#include <libchess/uci/Printing.hpp>

Collaboration diagram for chess::uci::printing::SearchInfo:

Classes

struct  Score

Public Member Functions

auto get_nps () const noexcept -> size_t

Public Attributes

size_t depth { 0uz }
std::string extraInformation
size_t hashfull { 0uz }
std::optional< size_t > multiPV
size_t nodes { 0uz }
moves::MoveList pv
Score score
size_t selDepth { 0uz }
size_t tbHits { 0uz }
std::chrono::milliseconds time

(Note that these are not member symbols.)

void search_info (const SearchInfo &info)

Detailed Description

This POD struct encapsulates the various information that can be printed about a search.

See also
search_info()

Definition at line 93 of file Printing.hpp.

Member Function Documentation

◆ get_nps()

auto chess::uci::printing::SearchInfo::get_nps ( ) const -> size_t
nodiscardnoexcept

Returns the nodes-per-second for this search.

Member Data Documentation

◆ depth

size_t chess::uci::printing::SearchInfo::depth { 0uz }

The search depth, in plies, associated with this information.

Definition at line 129 of file Printing.hpp.

◆ extraInformation

std::string chess::uci::printing::SearchInfo::extraInformation

An optional additional information string that will be printed along with the rest of the search information.

Definition at line 157 of file Printing.hpp.

◆ hashfull

size_t chess::uci::printing::SearchInfo::hashfull { 0uz }

The transposition table was filled X permille by this search so far.

Definition at line 149 of file Printing.hpp.

◆ multiPV

std::optional<size_t> chess::uci::printing::SearchInfo::multiPV

In MultiPV mode, this integer should be the number of the line that this info is for. In non-MultiPV mode, this should be nullopt.

Definition at line 143 of file Printing.hpp.

◆ nodes

size_t chess::uci::printing::SearchInfo::nodes { 0uz }

The total number of nodes searched.

Definition at line 138 of file Printing.hpp.

◆ pv

moves::MoveList chess::uci::printing::SearchInfo::pv

The principal variation found.

Definition at line 146 of file Printing.hpp.

◆ score

Score chess::uci::printing::SearchInfo::score

The engine's evaluation of the root position.

Definition at line 126 of file Printing.hpp.

◆ selDepth

size_t chess::uci::printing::SearchInfo::selDepth { 0uz }

Selective search depth, in plies.

Definition at line 132 of file Printing.hpp.

◆ tbHits

size_t chess::uci::printing::SearchInfo::tbHits { 0uz }

The number of positions found in the endgame tablebases.

Definition at line 152 of file Printing.hpp.

◆ time

std::chrono::milliseconds chess::uci::printing::SearchInfo::time

The elapsed search time.

Definition at line 135 of file Printing.hpp.


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