Index (Atenes Documentation - A Zero-Sum Game Engine Framework for Java)

A B C D E F G H I L M N O P R S T U V W

A

abortComputation() - Method in interface com.joansala.engine.Engine: Aborts the current search.
abortComputation() - Method in class com.joansala.engine.Negamax: Aborts the current search

B

Board - Interface in com.joansala.engine: A board represents an immutable game state and its representations.
Book - Class in com.joansala.engine: Abstract book implementation.
Book(File, String) - Constructor for class com.joansala.engine.Book: Initializes a new Book object wich will read entries from a file stored on disk.

C

Cache - Interface in com.joansala.engine: Stores information about a game state.
clear() - Method in interface com.joansala.engine.Cache: Removes all the data stored on the cache.
com.joansala.engine - package com.joansala.engine: Framework for the implementation of two-player zero-sum game engines.
computeBestMove(Game) - Method in interface com.joansala.engine.Engine: Computes a best move for the current position of a game.
computeBestMove(Game) - Method in class com.joansala.engine.Negamax: Computes a best move for the current position of a game.
computeBestScore(Game) - Method in class com.joansala.engine.Negamax: Computes a best move for the current position of a game and returns its score.

D

DEFAULT_TIME - Static variable in class com.joansala.engine.Negamax: The default time per move for a search
DEFAULT_TIME - Static variable in class com.joansala.engine.UCIService: The default time per move for a search
discharge() - Method in interface com.joansala.engine.Cache: Asks the cache to make room for new entries.
DRAW - Static variable in interface com.joansala.engine.Game: Returned when the game ended in a draw
DRAW_SCORE - Static variable in interface com.joansala.engine.Game: The draw score for the utility function

E

EMPTY - Static variable in interface com.joansala.engine.Cache: Flag of an unknown score
endMatch() - Method in interface com.joansala.engine.Game: Sets the internal board to the endgame position.
Engine - Interface in com.joansala.engine: An engine searches a game and returns a best move for its current state.
ensureCapacity(int) - Method in interface com.joansala.engine.Game: Increases the capacity of the game object if necessary.
EXACT - Static variable in interface com.joansala.engine.Cache: Flag of an exact score

F

fields() - Method in class com.joansala.engine.Book: Returns an iterator over the field names found in the book's header information.
finalize() - Method in class com.joansala.engine.Book: Destructor for this Book instance.
finalize() - Method in class com.joansala.engine.Negamax: Destructor for this Negamax instance.
find(Game) - Method in interface com.joansala.engine.Cache: Search the current game state provided by a Game object.
find(Game) - Method in interface com.joansala.engine.Leaves: Search a position provided by a Game object and sets it as the current position on the endgames book.

G

Game - Interface in com.joansala.engine: Represents the logic of a game between two players.
getAuthor() - Method in class com.joansala.engine.UCIClient: Returns the current engine author name.
getBestMove() - Method in class com.joansala.engine.UCIClient: Returns the last received best move.
getBoard() - Method in class com.joansala.engine.UCIClient: Returns a board representation of the current game state.
getContempt() - Method in interface com.joansala.engine.Engine: Returns the current the contempt factor of the engine.
getContempt() - Method in class com.joansala.engine.Negamax: Returns current the comptempt factor of the engine.
getDatabase() - Method in class com.joansala.engine.Book: Returns the random access file object associated with this book.
getDepth() - Method in interface com.joansala.engine.Cache: Returns the stored depth value for the last position found.
getDepth() - Method in interface com.joansala.engine.Engine: Returns the maximum depth allowed for the search
getDepth() - Method in class com.joansala.engine.Negamax: Returns the maximum depth allowed for the search
getField(String) - Method in class com.joansala.engine.Book: Returns the value of the specified header field.
getFlag() - Method in interface com.joansala.engine.Cache: Returns the stored flag value for the last position found.
getInfinity() - Method in interface com.joansala.engine.Engine: Returns the current infinity score of the engine.
getInfinity() - Method in class com.joansala.engine.Negamax: Returns the current infinity score of the engine.
getMove() - Method in interface com.joansala.engine.Cache: Returns the stored move value for the last position found.
getMoveTime() - Method in interface com.joansala.engine.Engine: Returns the maximum time allowed for a move computation in milliseconds
getMoveTime() - Method in class com.joansala.engine.Negamax: Returns the maximum time allowed for a move computation in milliseconds
getName() - Method in class com.joansala.engine.UCIClient: Returns the current engine name.
getPonderMove() - Method in class com.joansala.engine.UCIClient: Returns the last received ponder move.
getScore() - Method in interface com.joansala.engine.Cache: Returns the stored score value for the last position found.
getScore() - Method in interface com.joansala.engine.Leaves: Returns the exact score value for the last position found.
getService() - Method in class com.joansala.engine.UCIClient: Returns the engine process associated with this client.
getState() - Method in class com.joansala.engine.UCIClient: Returns the current engine state.
getVersion() - Method in class com.joansala.engine.Book: Returns the value for the database book format version.

H

hasEnded() - Method in interface com.joansala.engine.Game: Checks if the game has ended on the current position
hash() - Method in interface com.joansala.engine.Game: Returns an unique hash code for the current position.
hasTimeLimit() - Method in class com.joansala.engine.UCIClient: Returns if the current engine is not thinking in infinite mode.

I

isDebugOn() - Method in class com.joansala.engine.UCIClient: Returns the current engine debug mode.
isLegal(int) - Method in interface com.joansala.engine.Game: Check if a move may be performed on the current position.
isPondering() - Method in class com.joansala.engine.UCIClient: Returns true if the engine is in a pondering state.
isReady() - Method in class com.joansala.engine.UCIClient: Returns true whenever the engine is ready to receive new commands.
isRunning() - Method in class com.joansala.engine.UCIClient: Returns if the engine process is running.
isThinking() - Method in class com.joansala.engine.UCIClient: Returns true if the engine is in a thinking state.
isUCIReady() - Method in class com.joansala.engine.UCIClient: This method returns true whenever the engine is ready to receive commands in UCI mode.

L

Leaves - Interface in com.joansala.engine: An end games book that returns precomputed scores from a database.
legalMoves() - Method in interface com.joansala.engine.Game: Returns all the legal moves that can be performed on the current game position.
length() - Method in interface com.joansala.engine.Game: Returns the number of moves performed on this game.
LOWER - Static variable in interface com.joansala.engine.Cache: Flag of a lower bound score

M

makeMove(int) - Method in interface com.joansala.engine.Game: Performs a move on the internal board.
MAX_DEPTH - Static variable in class com.joansala.engine.Negamax: The maximum depth allowed for a search
MIN_DEPTH - Static variable in class com.joansala.engine.Negamax: The minimum depth allowed for a search
moves() - Method in interface com.joansala.engine.Game: Returns all the performed moves till the current position.

N

Negamax - Class in com.joansala.engine: Implements a game engine using a negamax framework.
Negamax() - Constructor for class com.joansala.engine.Negamax: Initializes a new Negamax object.
newMatch() - Method in interface com.joansala.engine.Engine: Tells the engine that the next positions are going to be from a different match.
newMatch() - Method in class com.joansala.engine.Negamax: Tells the engine that the next positions are going to be from a different match.
newMatch() - Method in interface com.joansala.engine.Roots: Notifies the book intance that the next positions are going to be from a different match.
nextMove() - Method in interface com.joansala.engine.Game: Returns the next legal move for the current position and turn.
NORTH - Static variable in interface com.joansala.engine.Game: North player identifier
NULL_MOVE - Static variable in interface com.joansala.engine.Game: Null move identifier

O

outcome() - Method in interface com.joansala.engine.Game: Returns an utility evaluation of the current position.

P

pickBestMove(Game) - Method in interface com.joansala.engine.Roots: Chooses one move at random from the best moves found on the book.
position() - Method in interface com.joansala.engine.Board: Returns a copy of the position on this the board.
position() - Method in interface com.joansala.engine.Game: Returns a representation of the current position.

R

receive() - Method in class com.joansala.engine.UCIClient: Receives and evaluates the next engine-to-client command.
resize(long) - Method in interface com.joansala.engine.Cache: Resizes the cache and clears all the stored data.
Roots - Interface in com.joansala.engine: An opening book that returns precomputed moves from a database.

S

score() - Method in interface com.joansala.engine.Game: Returns an heuristic evaluation of the current position.
send(String) - Method in class com.joansala.engine.UCIClient: Evaluates and sends a single client-to-engine command.
setCache(Cache) - Method in class com.joansala.engine.Negamax: Sets the transposition table to use.
setCache(Cache) - Method in class com.joansala.engine.UCIService: Sets the transposition table to use by the service.
setContempt(int) - Method in interface com.joansala.engine.Engine: Sets the contempt factor.
setContempt(int) - Method in class com.joansala.engine.Negamax: Sets the contempt factor.
setContempt(int) - Method in class com.joansala.engine.UCIService: Sets the contempt factor.
setDepth(int) - Method in interface com.joansala.engine.Engine: Sets the maximum search depth for subsequent computations
setDepth(int) - Method in class com.joansala.engine.Negamax: Sets the maximum depth for subsequent computations
setInfinity(int) - Method in interface com.joansala.engine.Engine: Sets the infinity score.
setInfinity(int) - Method in class com.joansala.engine.Negamax: Sets the infinity score.
setLeaves(Leaves) - Method in class com.joansala.engine.Negamax: Sets the endgames database to use.
setMoveTime(long) - Method in interface com.joansala.engine.Engine: Sets the maximum search time allowed for subsequent computations
setMoveTime(long) - Method in class com.joansala.engine.Negamax: Sets the maximum time allowed for subsequent computations
setRoots(Roots) - Method in class com.joansala.engine.UCIService: Sets the openings book database to use.
setStart(Object, int) - Method in interface com.joansala.engine.Game: Sets a new initial position and turn for the game.
size() - Method in interface com.joansala.engine.Cache: Returns the current capacity of this cache in bytes.
SOUTH - Static variable in interface com.joansala.engine.Game: South player identifier
start(int, int) - Method in class com.joansala.engine.UCIMatch: Runs a match against an engine process.
start() - Method in class com.joansala.engine.UCIService: Asks this service to start receiving commands.
start() - Method in class com.joansala.engine.UCIShell: Runs the UCI shell.
store(Game, int, int, int, byte) - Method in interface com.joansala.engine.Cache: Stores information about a game state on the cache.

T

toAlgebraic(int) - Method in interface com.joansala.engine.Board: Converts an integer representation of one move to its algebraic representation.
toAlgebraic(int[]) - Method in interface com.joansala.engine.Board: Converts an integer representation of one or more moves to their algebraic representation.
toBoard(Game) - Method in interface com.joansala.engine.Board: Converts the current state of a game object to its board object representation.
toBoard(String) - Method in interface com.joansala.engine.Board: Converts a board notation to a board object.
toMove(String) - Method in interface com.joansala.engine.Board: Converts an algebraic move notation to an integer representation.
toMoves(String) - Method in interface com.joansala.engine.Board: Converts an algebraic moves notation to an integer move array representation.
toNotation() - Method in interface com.joansala.engine.Board: Converts this board object to its equivalent board notation.
toString() - Method in interface com.joansala.engine.Board: Returns an human readable string representation of this object.
turn() - Method in interface com.joansala.engine.Board: Returns which player is to move for the board position
turn() - Method in interface com.joansala.engine.Game: Returns the playing turn for the current game position

U

UCIClient - Class in com.joansala.engine: Provides a client communication interface to an UCI service.
UCIClient(Process, Board, Game) - Constructor for class com.joansala.engine.UCIClient: Instantiates a new client object.
UCIClient.State - Enum in com.joansala.engine: Possible engine states
UCIMatch - Class in com.joansala.engine: Command-line interface to run a match between an human player and an UCI engine.
UCIMatch(UCIClient, Board, Game) - Constructor for class com.joansala.engine.UCIMatch: Instantiates a new match object
UCIService - Class in com.joansala.engine: Implements a communication protocol service for game engines.
UCIService(Board, Game, Engine) - Constructor for class com.joansala.engine.UCIService: Instantiates a new UCI service for the given game.
UCIShell - Class in com.joansala.engine: Provides an interactive shell interface to an engine that supports the UCI protocol.
UCIShell(UCIClient) - Constructor for class com.joansala.engine.UCIShell: This class cannot be instantiated
unmakeMove() - Method in interface com.joansala.engine.Game: Undoes the last performed move on the internal board.
UPPER - Static variable in interface com.joansala.engine.Cache: Flag of an upper bound score

V

valueOf(String) - Static method in enum com.joansala.engine.UCIClient.State: Returns the enum constant of this type with the specified name.
values() - Static method in enum com.joansala.engine.UCIClient.State: Returns an array containing the constants of this enum type, in the order they are declared.

W

winner() - Method in interface com.joansala.engine.Game: Returns an identifier for the player that won the game on the current position.

A B C D E F G H I L M N O P R S T U V W