net.viktorc.detroid.framework.uci

Class SearchResults

Object

SearchResults

public class SearchResults
extends Object

A simple immutable container class for the best move found in a search and the suggested ponder move for the next search both in pure algebraic coordinate notation. It also has an optional score field which can hold the search score if there is one, i.e. the best move was not read from an opening book.

Author:

Viktor

Constructor Summary

Constructors

Constructor and Description
SearchResults(String bestMove, String suggestedPonderMove, Short score, ScoreType scoreType) Constructs an instance according to the specified parameters.

Method Summary

Modifier and Type	Method and Description
String	getBestMove() Returns a Pure Algebraic Coordinate Notation representation of the best move.
Optional<Short>	getScore() Returns an optional 16-bit integer that may hold the score of the search results in centipawns, or if it is a mate score, the mate distance.
Optional<ScoreType>	getScoreType() Returns the type of the score if there is a score present.
Optional<String>	getSuggestedPonderMove() Returns an optional Pure Algebraic Coordinate Notation representation of the suggested ponder move.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SearchResults

public SearchResults(String bestMove,
                     String suggestedPonderMove,
                     Short score,
                     ScoreType scoreType)

Constructs an instance according to the specified parameters.

Parameters:

bestMove - The best move in PACN.

suggestedPonderMove - The expected reply to the best move in PACN. It is optional and thus can be null.

score - An optional search score value in centipawns. If the move was found using other methods than classic search and there is no score associated with it, the score should be null.

scoreType - An optional search score type. If the score is not present, the score type is ignored. If the score is present, the score type cannot be null either.

Method Detail

getBestMove

public String getBestMove()

Returns a Pure Algebraic Coordinate Notation representation of the best move.

Returns:

The best move in PACN.

getSuggestedPonderMove

public Optional<String> getSuggestedPonderMove()

Returns an optional Pure Algebraic Coordinate Notation representation of the suggested ponder move.

Returns:

The optional expected reply of the opponent to the best move found in PACN.

getScore

public Optional<Short> getScore()

Returns an optional 16-bit integer that may hold the score of the search results in centipawns, or if it is a mate score, the mate distance.

Returns:

The search score if it is available.

getScoreType

public Optional<ScoreType> getScoreType()

Returns the type of the score if there is a score present.

Returns:

The type of the score.