com.fathzer.games.ai.transposition.TranspositionTableEntry Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of games-core Show documentation

A core library to help implement two players games.

The newest version!

package com.fathzer.games.ai.transposition;

/** A transposition table entry.
 * 
Warning: All getters have non specified results when called on an invalid entry.
 * @param  The type of moves
 */
public interface TranspositionTableEntry {
	/** Tests if the entry is valid.
	 * @return true if the entry is present in the transposition table, false if there no entry for the key in the table.
	 */
	boolean isValid();
	
	/** Gets the entry's key.
	 * @return a long
	 */
	long getKey();
	
	
	/** Get's the entry's type.
	 * @return the entry type
	 */
	EntryType getEntryType();
	
	
	/** Get's the entry's depth.
	 * @return a positive or null integer
	 */
	int getDepth();
	
	
	/** Get's the entry's value.
	 * @return an integer
	 */
	int getValue();
	
	/** Get's the entry's move.
	 * @return a move
	 */
	M getMove();
}