Class HexState

java.lang.Object

HexState

public class HexState
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static int	NONE
static int	PLAYER1
static int	PLAYER2

Constructor Summary

Constructors

Constructor and Description
HexState(HexState state) Create a deep copy of the given Hex game state (including current player).
HexState(int size) Create an empty Hex board that has the given number of rows and upper-left diagonals for hex grid positions.

Method Summary

Modifier and Type	Method and Description
int	getPlayer() Return the current player constant PLAYER1 or PLAYER2.
int	getPosition(int row, int col) Return the contents of a board row and column (upper-left diagonal) position using integer constants PLAYER1/PLAYER2/NONE.
int	getPosition(java.lang.String pos) Return the contents of a board row and column (upper-left diagonal) position using integer constants PLAYER1/PLAYER2/NONE.
int	getSize() Return the number of rows and columns (i.e.
int	getWinner() Return the winner PLAYER1/PLAYER2 if there is a winner, or NONE is there is no winner.
boolean	playAt(int row, int col) Attempt to make a legal play for the current player at the given position and then change the player and return true.
boolean	playAt(java.lang.String pos) Attempt to make a legal play for the current player at the given position and then change the player and return true.
java.lang.String	toString() Return a String representation of the board according to the following specification: There should be one line per board row, one line with column letter labels, and one final line terminated with a newline that describes the current player/winner.

Methods inherited from class java.lang.Object

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

Field Detail

PLAYER1

public static final int PLAYER1

See Also:

Constant Field Values

PLAYER2

public static final int PLAYER2

See Also:

Constant Field Values

NONE

public static final int NONE

See Also:

Constant Field Values

Constructor Detail

HexState

public HexState(int size)

Create an empty Hex board that has the given number of rows and upper-left diagonals for hex grid positions.

Parameters:

size - the given number of rows and columns (i.e. upper-left diagonals) for hex grid positions

HexState

public HexState(HexState state)

Create a deep copy of the given Hex game state (including current player).

Parameters:

state - the given Hex game state to copy

Method Detail

getSize

public int getSize()

Return the number of rows and columns (i.e. upper-left diagonals) for hex grid positions.

Returns:

the number of rows and columns (i.e. upper-left diagonals) for hex grid positions

getPlayer

public int getPlayer()

Return the current player constant PLAYER1 or PLAYER2.

Returns:

the current player constant PLAYER1 or PLAYER2

getPosition

public int getPosition(int row,
                       int col)

Return the contents of a board row and column (upper-left diagonal) position using integer constants PLAYER1/PLAYER2/NONE.

Parameters:

row - given board row

col - given board column (upper-left diagonal)

Returns:

the contents of a board row and column (upper-left diagonal) position using integer constants PLAYER1/PLAYER2/NONE

getPosition

public int getPosition(java.lang.String pos)

Return the contents of a board row and column (upper-left diagonal) position using integer constants PLAYER1/PLAYER2/NONE.

Parameters:

pos - an algebraic notation of the board position consisting of a letter concatenated with an integer, where the integer is one more than the row index and the initial letter indicates the column (upper-left diagonal) with 'a'=0, 'b'=1, etc.

Returns:

the contents of a board row and column (upper-left diagonal) position using integer constants PLAYER1/PLAYER2/NONE

playAt

public boolean playAt(int row,
                      int col)

Attempt to make a legal play for the current player at the given position and then change the player and return true. If the play is illegal (i.e. out of bounds or the position is already occupied), make no change and return false.

Parameters:

row - given board row

col - given board column (upper-left diagonal)

Returns:

whether or not the play was legal (and thus made with a player change)

playAt

public boolean playAt(java.lang.String pos)

Attempt to make a legal play for the current player at the given position and then change the player and return true. If the play is illegal (i.e. out of bounds or the position is already occupied), make no change and return false.

Parameters:

pos - an algebraic notation of the board position consisting of a letter concatenated with an integer, where the integer is one more than the row index and the initial letter indicates the column (upper-left diagonal) with 'a'=0, 'b'=1, etc.

Returns:

whether or not the play was legal (and thus made with a player change)

toString

public java.lang.String toString()

Return a String representation of the board according to the following specification: There should be one line per board row, one line with column letter labels, and one final line terminated with a newline that describes the current player/winner. Board rows are numbered from 1 through the board size. Rows are printed from highest numbered row to lowest. Each row starts with some number of spaces, an integer row number right justified within two spaces, and, for each column of that row, a space concatenated with a character "O", "-", and "*" for PLAYER2, NONE, and PLAYER1, respectively. The number of spaces at the beginning of the row line is 0 for the first (highest) row and increases by one for each successive row. After the board rows, first print a number of spaces equal to the board size plus 2, then for each column, append a space and a letter starting with 'a' and increasing alphabetically. Finally, add a newline-terminated line that begins with either the current player or winner piece character followed by " to play." or " wins.", respectively.

Overrides:

toString in class java.lang.Object

Returns:

a String representation of the Hex board

getWinner

public int getWinner()

Return the winner PLAYER1/PLAYER2 if there is a winner, or NONE is there is no winner. PLAYER1 wins if there is an unbroken path of PLAYER1 plays between the top and bottom rows. PLAYER2 wins if there is an unbroken path of PLAYER2 plays between the leftmost and rightmost columns (upper-left diagonals). Positions are adjacent for forming paths horizontally, upper-left diagonally, and upper-right diagonally. That is, [r1][c1] and [r2][c2] are adjacent if the differences between the rows and between the columns does not exceed 1, and either (1) r1 equals r2 (same row), (2) c1 equals c2 (same column (upper-left diagonal)), or (3) r1-r2 is equal to c1-c2 (same upper-right diagonal).

Returns:

the winner PLAYER1/PLAYER2 if there is a winner, or NONE is there is no winner