evaluate_position: Evaluate a chess position

In dryguy/rbitr: Arbiter: One who ensures adherence to the rules and laws of chess

Evaluate a chess position

Description

Chess positions are analyzed using a UCI compatible chess engine.

Usage

evaluate_position(
  position,
  engine_path,
  limiter,
  limit,
  n_cpus,
  n_pv,
  hash_size = NULL
)

Arguments

position	A single-element character vector containing a series of legal chess moves in long algebraic notation (LAN).
engine_path	A single-element character vector of the path to a UCI compatible chess engine.
limiter	A single-element character vector indicating the desired mode of search termination. Allowed values are 'depth' (to search a fixed number of plies), 'nodes' (to search a fixed number of nodes), and 'movetime' (to search for a fixed number of milliseconds).
limit	A single-element integer vector of the desired search depth (# of plies), search nodes (# of nodes), or search time (# of milliseconds).
n_cpus	(Default = 1) A single-element integer vector of the number of CPUs to use.
n_pv	(Default = 1) A single-element integer vector of the desired number of principal variations.
hash_size	(Default = NULL) A single-element integer vector of the desired hash size, in MB.

Value

A list containing a character vector of the engine's output.

See Also

The 'tabulate' functions tabulate analysis logs into data frames.

• tabulate_positionlog() for condensing analysis of one position.

• tabulate_gamelog() for condensing analysis of one game.

• tabulate_pgnlog() for condensing analysis of an entire pgn file.

The 'parse' functions extract specific data from analysis logs.

• parse_gamelog() for extracting data from one evaluated game.

• parse_pgnlog() for extracting data from games in a pgn.

The 'evaluate' functions produce analysis logs.

• evaluate_position() for analyzing chess positions.

• evaluate_game() for analyzing individual games.

• evaluate_pgn() for evaluating all the games in a PGN file.

Examples

position <- 'e2e4'
# Modify engine_path as required for your engine location & operating system
engine_path <- '//stockfish.exe'
evaluate_position(position, engine_path, n_pv = 1, n_cpus = 1,
                  limiter = 'depth', limit = 1)

dryguy/rbitr documentation built on Oct. 15, 2024, 6:18 a.m.