net.viktorc.detroid.framework.validation

Interface ControllerEngine

All Superinterfaces:

AutoCloseable, Closeable, UCIEngine

All Known Implementing Classes:

Detroid

public interface ControllerEngine
extends UCIEngine

An interface for an engine that provides the basic functionalities required for a user interface base engine.

Author:

Viktor

Field Summary

Fields inherited from interface UCIEngine

HASH_OPTION_NAME, OWN_BOOK_OPTION_NAME, START_POSITION, THREADS_OPTION_NAME

Method Summary

Modifier and Type	Method and Description
void	blackForfeit() Sets the game state to unspecified white victory.
String	convertPACNToSAN(String move) Converts a move legal in the current position from Pure Algebraic Coordinate Notation to Standard Algebraic Notation.
String	convertSANToPACN(String move) Converts a move legal in the current position from Standard Algebraic Notation to Pure Algebraic Coordinate Notation.
default Set<Map.Entry<String,Long>>	divide(int depth) Returns a set of entries with all legal moves in the current position as the key set and the perft results at depth - 1 for the positions the respective moves lead to as the value set.
void	drawByAgreement() Sets the game state to draw by agreement from both parties.
GameState	getGameState() Returns the current game state as labelled by GameState.
List<String>	getLegalMoves() Returns a list of all legal moves in the current position in Pure Algebraic Coordinate Notation.
List<String>	getMoveHistory() Returns a list of all past moves made on the board in Pure Algebraic Coordinate Notation in chronological order.
String	getStartPosition() Returns the starting position of the current game in Forsyth-Edwards Notation.
boolean	isQuiet() Determines whether the current position is quiet, i.e.
boolean	isWhitesTurn() Returns whether it's white's turn.
default long	perft(int depth) Runs a perft to the specified depth in the current position and returns the number of leaf nodes counted while traversing the tree.
void	setControllerMode(boolean on) Sets whether the engine should run in controller mode.
void	setEvent(String event) Sets the event at which the game is taking place.
boolean	setGame(String pgn) Parses the Portable Game Notation string and sets its internal data structure tracking the state of the game accordingly.
void	setPlayers(String whitePlayer, String blackPlayer) Sets the names of the players.
void	setSite(String site) Sets the site where the game is taking place.
String	toFEN() Returns a Forsyth-Edwards Notation string representing the current position.
String	toPGN() Returns a Portable Game Notation string representing the state of the game.
default String	unplayLastMove() Takes back the last move and returns it in Pure Algebraic Coordinate Notation.
void	whiteForfeit() Sets the game state to unspecified black victory.

Methods inherited from interface UCIEngine

close, getAuthor, getDebugInfo, getHashLoadPermill, getName, getOptions, getSearchInfo, init, isInit, newGame, play, ponderHit, quit, search, setDebugMode, setHashSizeOption, setOption, setOption, setOwnBookOption, setPosition, setPosition, setThreadsOption, stop

Method Detail

isWhitesTurn

boolean isWhitesTurn()

Returns whether it's white's turn.

Returns:

Whether the side to move is white.

getStartPosition

String getStartPosition()

Returns the starting position of the current game in Forsyth-Edwards Notation.

Returns:

The start position of the game in FEN.

getGameState

GameState getGameState()

Returns the current game state as labelled by GameState.

Returns:

The current game state.

getMoveHistory

List<String> getMoveHistory()

Returns a list of all past moves made on the board in Pure Algebraic Coordinate Notation in chronological order.

Returns:

A list of all past moves made on the board in PACN. It should never return null.

getLegalMoves

List<String> getLegalMoves()

Returns a list of all legal moves in the current position in Pure Algebraic Coordinate Notation.

Returns:

A list of all legal moves in the current position in PACN. It should never return null.

isQuiet

boolean isQuiet()

Determines whether the current position is quiet, i.e. there are no legal tactical no moves.

Returns:

Whether the current position is quiet.

setGame

boolean setGame(String pgn)

Parses the Portable Game Notation string and sets its internal data structure tracking the state of the game accordingly. It returns whether the game could be successfully set or not.

Parameters:

pgn - A PGN string representation of a chess game.

Returns:

Whether the game could be successfully set or not.

setPlayers

void setPlayers(String whitePlayer,
                String blackPlayer)

Sets the names of the players.

Parameters:

whitePlayer - The name of the white player.

blackPlayer - The name of the black player.

setEvent

void setEvent(String event)

Sets the event at which the game is taking place.

Parameters:

event - The event at which the game is taking place.

setSite

void setSite(String site)

Sets the site where the game is taking place.

Parameters:

site - The site where the game is taking place.

setControllerMode

void setControllerMode(boolean on)

Sets whether the engine should run in controller mode.

Parameters:

on - Whether the engine should run in controller mode.

drawByAgreement

void drawByAgreement()

Sets the game state to draw by agreement from both parties.

whiteForfeit

void whiteForfeit()

Sets the game state to unspecified black victory. This can be due to a loss on time, resignation, or breaking of the rules.

blackForfeit

void blackForfeit()

Sets the game state to unspecified white victory. This can be due to a loss on time, resignation, or breaking of the rules.

convertPACNToSAN

String convertPACNToSAN(String move)

Converts a move legal in the current position from Pure Algebraic Coordinate Notation to Standard Algebraic Notation.

Parameters:

move - The move in PACN.

Returns:

The move in SAN.

convertSANToPACN

String convertSANToPACN(String move)

Converts a move legal in the current position from Standard Algebraic Notation to Pure Algebraic Coordinate Notation.

Parameters:

move - The move in SAN.

Returns:

The move in PACN.

toFEN

String toFEN()

Returns a Forsyth-Edwards Notation string representing the current position.

Returns:

A FEN string representing the current position.

toPGN

String toPGN()

Returns a Portable Game Notation string representing the state of the game.

Returns:

A PGN string representing the state of the game.

unplayLastMove

default String unplayLastMove()

Takes back the last move and returns it in Pure Algebraic Coordinate Notation. It returns null if no moves have been made yet.

Returns:

The last move made in Pure Algebraic Coordinate Notation

perft

default long perft(int depth)

Runs a perft to the specified depth in the current position and returns the number of leaf nodes counted while traversing the tree.

Parameters:

depth - The depth at which the leaf nodes are to be counted.

Returns:

The number of leaf nodes counted.

divide

default Set<Map.Entry<String,Long>> divide(int depth)

Returns a set of entries with all legal moves in the current position as the key set and the perft results at depth - 1 for the positions the respective moves lead to as the value set. The moves should be in PACN.

Parameters:

depth - The perft depth. Perft to a depth of this minus one will be executed for each legal move from the current position.

Returns:

A set of entries with all legal moves in the current position as the key set and the perft results at depth - 1 for the positions the respective moves lead to as the value set.