net.sf.gogui.go

Class Board

java.lang.Object

net.sf.gogui.go.Board

All Implemented Interfaces:

java.lang.Iterable<GoPoint>, ConstBoard

public final class Board
extends java.lang.Object
implements ConstBoard

Go board.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Board.BoardIterator

Constructor Summary

Constructors

Constructor and Description
Board(int boardSize) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	bothPassed() Check for two consecutive passes.
void	clear() Clear board.
boolean	contains(GoPoint point) Check if board contains a point.
ConstPointList	getAdjacent(GoPoint point) Get points adjacent to a point.
int	getCaptured(GoColor c) Get number of captured stones.
GoColor	getColor(GoPoint p) Get state of a point on the board.
static ConstPointList	getHandicapStones(int size, int n) Get location of handicap stones for a given board size.
ConstPointList	getKilled() Opponent stones captured in last move.
Move	getLastMove() Return last move.
Move	getMove(int i) Get a move from the sequence of moves played so far.
int	getNumberMoves() Get the number of moves played so far.
ConstPointList	getSetup(GoColor c) Get initial setup stones of a color.
GoColor	getSetupPlayer() Get player of initial setup position.
int	getSize() Get board size.
void	getStones(GoPoint p, GoColor color, PointList stones) Get stones of a block.
ConstPointList	getSuicide() Player stones killed by suicide in last move.
GoColor	getToMove() Get color to move.
void	init(int size) Initialize the board for a given board size.
boolean	isCaptureOrSuicide(GoColor c, GoPoint p) Check if a move would capture anything (including suicide).
boolean	isHandicap(GoPoint point) Check if a point is a handicap point.
boolean	isKo(GoPoint point) Check if move would violate the simple Ko rule.
boolean	isModified() Check if any moves were played or setup stones placed on the board.
boolean	isSetupHandicap() Check if the initial setup position was a handicap.
boolean	isSuicide(GoColor c, GoPoint p) Check if a point would be a suicide move.
java.util.Iterator<GoPoint>	iterator()
void	play(GoColor color, GoPoint point) Play a move.
void	play(Move move) Play a move.
void	setToMove(GoColor toMove) Change the color to move.
void	setup(ConstPointList black, ConstPointList white, GoColor player) Setup position.
void	setupHandicap(ConstPointList points) Setup initial handicap stones.
void	undo() Undo the last move.
void	undo(int n) Undo a number of moves.

Methods inherited from class java.lang.Object

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

Constructor Detail

Board

public Board(int boardSize)

Constructor.

Parameters:

boardSize - The board size (number of points per row / column) in the range from one to GoPoint.MAX_SIZE

Method Detail

bothPassed

public boolean bothPassed()

Check for two consecutive passes.

Specified by:

bothPassed in interface ConstBoard

Returns:

true, if the last two moves were pass moves

contains

public boolean contains(GoPoint point)

Check if board contains a point.

Specified by:

contains in interface ConstBoard

Parameters:

point - The point to check

Returns:

true, if the point is on the board

getAdjacent

public ConstPointList getAdjacent(GoPoint point)

Get points adjacent to a point.

Specified by:

getAdjacent in interface ConstBoard

Parameters:

point - The point.

Returns:

List of points adjacent.

getCaptured

public int getCaptured(GoColor c)

Get number of captured stones.

Specified by:

getCaptured in interface ConstBoard

Returns:

The total number of stones of the given color captured by opponent moves or by suicide.

getColor

public GoColor getColor(GoPoint p)

Get state of a point on the board.

Specified by:

getColor in interface ConstBoard

Returns:

BLACK, WHITE or EMPTY

getHandicapStones

public static ConstPointList getHandicapStones(int size,
                               int n)

Get location of handicap stones for a given board size.

Parameters:

n - The number of handicap stones.

size - The board size.

Returns:

List of points (go.Point) corresponding to the handicap stone locations.

See Also:

BoardConstants.getHandicapStones(int)

getKilled

public ConstPointList getKilled()

Opponent stones captured in last move. Does not include player stones killed by suicide. Requires that there is a last move (or setup stone).

Specified by:

getKilled in interface ConstBoard

Returns:

List of opponent stones (go.Point) captured in last move; empty if none were killed or there is no last move.

See Also:

getSuicide()

getLastMove

public Move getLastMove()

Return last move.

Specified by:

getLastMove in interface ConstBoard

Returns:

Last move or null if there is no last move.

getNumberMoves

public int getNumberMoves()

Get the number of moves played so far.

Specified by:

getNumberMoves in interface ConstBoard

Returns:

The number of moves.

See Also:

getMove(int)

getMove

public Move getMove(int i)

Get a move from the sequence of moves played so far.

Specified by:

getMove in interface ConstBoard

Parameters:

i - The number of the move (starting with zero).

Returns:

The move with the given number.

See Also:

getNumberMoves()

getSetup

public ConstPointList getSetup(GoColor c)

Get initial setup stones of a color.

Specified by:

getSetup in interface ConstBoard

Parameters:

c - Black or White.

Returns:

Initial stones of this color placed on the board by calling setup.

See Also:

setup(net.sf.gogui.go.ConstPointList, net.sf.gogui.go.ConstPointList, net.sf.gogui.go.GoColor)

getSetupPlayer

public GoColor getSetupPlayer()

Get player of initial setup position.

Specified by:

getSetupPlayer in interface ConstBoard

Returns:

Player of initial setup position as used in the call to setup; null means unknown player color.

See Also:

setup(net.sf.gogui.go.ConstPointList, net.sf.gogui.go.ConstPointList, net.sf.gogui.go.GoColor)

getSize

public int getSize()

Get board size.

Specified by:

getSize in interface ConstBoard

Returns:

The board size.

getStones

public void getStones(GoPoint p,
             GoColor color,
             PointList stones)

Get stones of a block.

Specified by:

getStones in interface ConstBoard

getSuicide

public ConstPointList getSuicide()

Player stones killed by suicide in last move. Requires that there is a last move (or setup stone).

Specified by:

getSuicide in interface ConstBoard

Returns:

List of stones (go.Point) killed by suicide in last move, including the stone played; empty if no stones were killed by suicide or if there is no last move.

See Also:

getKilled()

getToMove

public GoColor getToMove()

Get color to move.

Specified by:

getToMove in interface ConstBoard

Returns:

The color to move.

init

public void init(int size)

Initialize the board for a given board size. For changing the board size. Also calls clear().

Parameters:

size - The new board size (number of points per row / column) in the range from one to GoPoint.MAX_SIZE

isCaptureOrSuicide

public boolean isCaptureOrSuicide(GoColor c,
                         GoPoint p)

Check if a move would capture anything (including suicide).

Specified by:

isCaptureOrSuicide in interface ConstBoard

Parameters:

c - The player color.

p - The point to check.

Returns:

true, if a move on the given point by the given player would capture any opponent stones, or be a suicide move.

isHandicap

public boolean isHandicap(GoPoint point)

Check if a point is a handicap point.

Specified by:

isHandicap in interface ConstBoard

Parameters:

point - The point to check.

Returns:

true, if the given point is a handicap point.

See Also:

BoardConstants.isHandicap(net.sf.gogui.go.GoPoint)

isKo

public boolean isKo(GoPoint point)

Check if move would violate the simple Ko rule. Assumes other color to move than the color of the last move.

Specified by:

isKo in interface ConstBoard

Parameters:

point - The point to check

Returns:

true, if a move at this point would violate the simple ko rule

isModified

public boolean isModified()

Check if any moves were played or setup stones placed on the board.

Specified by:

isModified in interface ConstBoard

isSetupHandicap

public boolean isSetupHandicap()

Check if the initial setup position was a handicap.

Specified by:

isSetupHandicap in interface ConstBoard

Returns:

true, if the initial position was setup by calling setupHandicap, false otherwise.

See Also:

setupHandicap(net.sf.gogui.go.ConstPointList)

isSuicide

public boolean isSuicide(GoColor c,
                GoPoint p)

Check if a point would be a suicide move.

Specified by:

isSuicide in interface ConstBoard

Parameters:

c - The player color to check.

p - The point to check.

Returns:

true, if a move at the given point by the given player would be a suicide move.

iterator

public java.util.Iterator<GoPoint> iterator()

Specified by:

iterator in interface java.lang.Iterable<GoPoint>

Specified by:

iterator in interface ConstBoard

clear

public void clear()

Clear board. Takes back the effects of any moves or setup stones on the board.

play

public void play(GoColor color,
        GoPoint point)

Play a move.

Parameters:

color - The player who played the move.

point - The location of the move.

See Also:

play(Move)

play

public void play(Move move)

Play a move. Never fails, even if ko rule is violated, suicide or play on occupied points. For example, when loading an SGF file with illegal moves, we still want to be able to load and execute the moves. A move will place a stone of the given color, capture all dead blocks adjacent to the stone, capture the block the stone is part of if it was a suicide move and switches the color to move.

Parameters:

move - The move (location and player)

setToMove

public void setToMove(GoColor toMove)

Change the color to move.

Parameters:

toMove - The new color to move.

setup

public void setup(ConstPointList black,
         ConstPointList white,
         GoColor player)

Setup position. Clears the board and move history and sets up a position.

Parameters:

black - Black stones to add on the board.

white - White stones to add on the board.

player - Color to play

setupHandicap

public void setupHandicap(ConstPointList points)

Setup initial handicap stones. This function is similar to an initial setup with only black stones, but it is remembered that the setup was a handicap and it can later be checked with isSetupHandicap.

See Also:

isSetupHandicap()

undo

public void undo()

Undo the last move. Restores any stones removed by the last move (captured or suicide) and the color who was to move before the move.

undo

public void undo(int n)

Undo a number of moves.

Parameters:

n - Number of moves to undo. Must be between 0 and getNumberMoves().

See Also:

undo()