net.viktorc.detroid.framework.uci

Class SearchInformation

Object

Observable

SearchInformation

public abstract class SearchInformation
extends Observable

An observable abstract class for containing search information and notifying the observers on changes.

Author:

Viktor

Constructor Summary

Constructors

Constructor and Description
SearchInformation()

Method Summary

Modifier and Type	Method and Description
abstract int	getCurrentLine() Returns the number of the line the engine is currently calculating.
abstract String	getCurrentMove() Returns the currently searched root move in Pure Algebraic Coordinate Notation.
abstract int	getCurrentMoveNumber() Returns the number of the currently searched move in the move list of the root position.
abstract short	getDepth() Returns the nominal depth of the search.
abstract long	getEndgameTablebaseHits() Returns the number of endgame tablebase hits while searching.
abstract long	getNodes() Returns the number of nodes searched to reach this result.
abstract String[]	getPv() Returns an array of the principal variation with the moves in Pure Algebraic Coordinate Notation.
abstract int	getPvNumber() Returns the index of the PV line.
abstract short	getScore() Returns the result score of the search for the side to move.
abstract ScoreType	getScoreType() Returns whether it is an exact score, a lower bound, an upper bound, or a mate score, in which case the score denotes the mate distance in half moves.
abstract short	getSelectiveDepth() Returns the greatest depth of the search.
abstract String	getString() Returns any additional information the engine wants to send.
abstract long	getTime() Returns the time spent on the search to reach this result in milliseconds.

Methods inherited from class Observable

addObserver, clearChanged, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers, setChanged

Methods inherited from class Object

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

Constructor Detail

SearchInformation

public SearchInformation()

Method Detail

getPvNumber

public abstract int getPvNumber()

Returns the index of the PV line. If multi-PV is not supported, it should always return 0. If it is supported, the numbering should start from 1 with the best line.

Returns:

The index of the PV line.

getPv

public abstract String[] getPv()

Returns an array of the principal variation with the moves in Pure Algebraic Coordinate Notation.

Returns:

An array of the moves in PACN that make up the PV.

getCurrentMove

public abstract String getCurrentMove()

Returns the currently searched root move in Pure Algebraic Coordinate Notation. If it returns null, it is ignored.

Returns:

The currently search root move in PACN.

getCurrentMoveNumber

public abstract int getCurrentMoveNumber()

Returns the number of the currently searched move in the move list of the root position. If it returns 0, it is ignored.

Returns:

The current move index in the list of legal moves.

getDepth

public abstract short getDepth()

Returns the nominal depth of the search.

Returns:

The nominal depth of the search.

getSelectiveDepth

public abstract short getSelectiveDepth()

Returns the greatest depth of the search.

Returns:

The greatest depth of the search.

getScore

public abstract short getScore()

Returns the result score of the search for the side to move.

Returns:

The search score in centipawns or if it is a mate score, the mate distance.

getScoreType

public abstract ScoreType getScoreType()

Returns whether it is an exact score, a lower bound, an upper bound, or a mate score, in which case the score denotes the mate distance in half moves. If the side to move in the root position is going to get mated, the negative distance is returned.

Returns:

The type of the returned score.

getNodes

public abstract long getNodes()

Returns the number of nodes searched to reach this result.

Returns:

The number of nodes traversed.

getTime

public abstract long getTime()

Returns the time spent on the search to reach this result in milliseconds.

Returns:

The time spent searching in milliseconds.

getEndgameTablebaseHits

public abstract long getEndgameTablebaseHits()

Returns the number of endgame tablebase hits while searching.

Returns:

The number of endgame tablebase hits.

getCurrentLine

public abstract int getCurrentLine()

Returns the number of the line the engine is currently calculating. In concurrent engines, this may be the thread/process number. It should start 1. If it is 0 or less, it is ignored.

Returns:

The current line number.

getString

public abstract String getString()

Returns any additional information the engine wants to send. If it is null, it is ignored.

Returns:

Any additional information.