com.fossgalaxy.games.fireworks.state

Class BasicHand

java.lang.Object

com.fossgalaxy.games.fireworks.state.BasicHand

All Implemented Interfaces:

Hand, Serializable, Iterable<Card>

Direct Known Subclasses:

NegativeHand

public class BasicHand
extends Object
implements Iterable<Card>, Hand

An implementation of a hand.

This only keeps track of only explicitly told information (performs no deduction)

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
BasicHand(BasicHand hand) Create a deep copy of a given hand.
BasicHand(int size) Create a new blank hand.

Method Summary

Modifier and Type	Method and Description
void	bindCard(int slot, Card card) Bind a card to a given slot, keeping all known information about it.
boolean	equals(Object o)
Card	getCard(int slot) Get the card really present in the slot (or null if unknown).
CardColour	getKnownColour(int slot) Get the known colour of this slot, from the perspective of the player who's hand it is.
Integer	getKnownValue(int slot) Get the known value of this slot, from the perspective of the player who's hand it is.
CardColour[]	getPossibleColours(int slot) get possible colours for a given slot.
int[]	getPossibleValues(int slot) get possible values for a given slot.
int	getSize() The number of cards which make up this hand.
boolean	hasCard(int slot) Does the hand contain a card in this slot?
boolean	hasColour(CardColour colour) Has a card of that colour that it knows exactly about
int	hashCode()
boolean	hasValue(Integer value) Has a card of that value that it knows exactly about
void	init() Initialise all information about the slots.
boolean	isCompletePossible(int slot, Card card) Check if this card is possible based on complete infomation.
boolean	isPossible(int slot, Card card) check if the card is possible, based on the owner's prespective
Iterator<Card>	iterator() Create an iterator of the cards, based on the real cards present.
void	setCard(int slot, Card card) Set a card in a given slot, removing all known information about it.
void	setHasCard(int slot, boolean value) Sets whether the hand has a card in this slot.
void	setKnownColour(CardColour colour, Integer[] slots) Sets the known colour of a slot from the perspective of the owner.
void	setKnownValue(Integer value, Integer[] slots) Sets the known value of a slot from the perspective of the owner.
String	toString() Pretty print this hand.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

BasicHand

public BasicHand(BasicHand hand)

Create a deep copy of a given hand.

Parameters:

hand - the hand to copy

BasicHand

public BasicHand(int size)

Create a new blank hand.

When initialised, all card slots will be blank (have no card present).

Parameters:

size - the number of cards in this hand

Method Detail

init

public void init()

Initialise all information about the slots.

This should reset any known infomation for any slot in the hand.

Specified by:

init in interface Hand

getCard

public Card getCard(int slot)

Get the card really present in the slot (or null if unknown).

This is the card which is present in the slot based on information provided by the game itself. This method should always return null for your own hand (agents should not call this method on their own hands).

Agents can use this for accurate information about other player's hands.

Specified by:

getCard in interface Hand

Parameters:

slot - the slot to query

Returns:

the card present in that slot, or null if the card is unknown.

getKnownColour

public CardColour getKnownColour(int slot)

Get the known colour of this slot, from the perspective of the player who's hand it is.

For this version of the hand class, this is worked out based on explicitly observed tell actions. It will not take into account negative information.

Specified by:

getKnownColour in interface Hand

Parameters:

slot - the slot to query

Returns:

the colour of the slot, from the owner's perspective.

getKnownValue

public Integer getKnownValue(int slot)

Get the known value of this slot, from the perspective of the player who's hand it is.

For this version of the hand class, this is worked out based on explicitly observed tell actions. It will not take into account negative information.

Specified by:

getKnownValue in interface Hand

Parameters:

slot - the slot to query

Returns:

the value of the slot, from the owner's perspective.

getSize

public int getSize()

The number of cards which make up this hand.

This can very with game size, and so this should be used whenever you need to iterate over the number of slots in this player's hand.

Specified by:

getSize in interface Hand

Returns:

the number of slots in this player's hand.

iterator

public Iterator<Card> iterator()

Create an iterator of the cards, based on the real cards present.

This uses the same values as getCard(int).

Specified by:

iterator in interface Iterable<Card>

Returns:

a card iterator based on the getCard function

setCard

public void setCard(int slot,
                    Card card)

Set a card in a given slot, removing all known information about it.

This should be called when a CardDrawn event occurs in order to update this hand with the correct information.

It will also reset all known information from the perspective of the owner.

Specified by:

setCard in interface Hand

Parameters:

slot - the slot to update

card - the card now residing in this slot

bindCard

public void bindCard(int slot,
                     Card card)

Bind a card to a given slot, keeping all known information about it.

This has the same basic role as setCard(int, com.fossgalaxy.games.fireworks.state.Card) but will not remove any information from the owners perspective. This is mostly useful when using this class as part of a simulation based agent to set the value of the card.

Specified by:

bindCard in interface Hand

Parameters:

slot - the slot to update

card - the card to assign to that slot

setKnownColour

public void setKnownColour(CardColour colour,
                           Integer[] slots)

Sets the known colour of a slot from the perspective of the owner.

This method is used to inform the hand about the card from the owner's perspective (tell actions).

Specified by:

setKnownColour in interface Hand

Parameters:

colour - the colour to assign to the slots

slots - the slots to assign the colour to.

setKnownValue

public void setKnownValue(Integer value,
                          Integer[] slots)

Sets the known value of a slot from the perspective of the owner.

This method is used to inform the hand about the card from the owner's perspective (tell actions).

Specified by:

setKnownValue in interface Hand

Parameters:

value - the value to assign to the slots

slots - the slots to assign the value to.

toString

public String toString()

Pretty print this hand.

Overrides:

toString in class Object

Returns:

a string representation of the hand.

isCompletePossible

public boolean isCompletePossible(int slot,
                                  Card card)

Check if this card is possible based on complete infomation.

Specified by:

isCompletePossible in interface Hand

Parameters:

slot - the slot to check

card - the card we are considering

Returns:

true if this card could possibly be in this slot, else return false

isPossible

public boolean isPossible(int slot,
                          Card card)

check if the card is possible, based on the owner's prespective

Specified by:

isPossible in interface Hand

Parameters:

slot - the slot to check

card - the card we are considering

Returns:

true if this card could possibly fit in this slow, false otherwise.

getPossibleValues

public int[] getPossibleValues(int slot)

get possible values for a given slot.

Specified by:

getPossibleValues in interface Hand

Parameters:

slot - the slot to check

Returns:

all possible value for this slot

getPossibleColours

public CardColour[] getPossibleColours(int slot)

get possible colours for a given slot.

Specified by:

getPossibleColours in interface Hand

Parameters:

slot - the slot to check

Returns:

all possible colour for this slot

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

hasColour

public boolean hasColour(CardColour colour)

Description copied from interface: Hand

Has a card of that colour that it knows exactly about

Specified by:

hasColour in interface Hand

Parameters:

colour - The colour to check

Returns:

Wether there is a card of that colour in the hand

hasValue

public boolean hasValue(Integer value)

Description copied from interface: Hand

Has a card of that value that it knows exactly about

Specified by:

hasValue in interface Hand

Parameters:

value - The value to check

Returns:

Wether there is a card of that value in the hand

hasCard

public boolean hasCard(int slot)

Description copied from interface: Hand

Does the hand contain a card in this slot?

Specified by:

hasCard in interface Hand

Parameters:

slot - The slot to check

Returns:

Whether there is a card in the slot

setHasCard

public void setHasCard(int slot,
                       boolean value)

Description copied from interface: Hand

Sets whether the hand has a card in this slot.

Specified by:

setHasCard in interface Hand

Parameters:

slot - The slot to set

value - The presence or not of a card