burlap.domain.stochasticgames.gridgame

Class GridGame

java.lang.Object

burlap.domain.stochasticgames.gridgame.GridGame

All Implemented Interfaces:

DomainGenerator

public class GridGame
extends java.lang.Object
implements DomainGenerator

The GridGame domain is much like the GridWorld domain, except for arbitrarily many agents in a stochastic game. Each agent in the world has an OO-MDP object instance of OO-MDP class "agent" which is defined by an x position, a y position, and a player number. Agents can either move north, south, east, west, or do nothing, therefore the game is symmetric for all agents. To get a standard SGAgentType to use with this game, use the getStandardGridGameAgentType(burlap.oomdp.core.Domain) static method.

In this domain, there is also an OO-MDP object class for 1-dimensional walls (both for horizontal walls or vertical walls). Each wall can take on a different type; a solid wall that can never be passed (type 0), and a semi-wall, can be passed with some stochastic probability (type 1). Finally, there is also an OO-MDP class for goal locations, which also have different types. There is a type that can be indicated as a universal goal/reward location for all agents (type 0), and type that is only useful to each individual agent (type i is a personal goal for player i-1).

The JointActionModel set for the domain is GridGameStandardMechanics, with a default semi-wall probability of passing through of 0.5, which is changeable with the

Author:

James MacGlashan

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GridGame.GGJointRewardFunction Specifies goal rewards and default rewards for agents.
static class	GridGame.GGTerminalFunction Causes termination when any agent reaches a personal or universal goal location.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ACTIONEAST A constant for the name of the east action.
static java.lang.String	ACTIONNOOP A constant for the name of the no operation (do nothing) action.
static java.lang.String	ACTIONNORTH A constant for the name of the north action.
static java.lang.String	ACTIONSOUTH A constant for the name of the south action.
static java.lang.String	ACTIONWEST A constant for the name of the west action.
static java.lang.String	ATTE1 A constant for the name of the first wall end position attribute.
static java.lang.String	ATTE2 A constant for the name of the second wall end position attribute.
static java.lang.String	ATTGT A constant for the name of the goal type attribute.
static java.lang.String	ATTP A constant for the name of the attribute for defining the walls position along its orthogonal direction.
static java.lang.String	ATTPN A constant for the name of the player number attribute.
static java.lang.String	ATTWT A constant for the name of the wall type attribute.
static java.lang.String	ATTX A constant for the name of the x position attribute
static java.lang.String	ATTY A constant for the name of the y position attribute
static java.lang.String	CLASSAGENT A constant for the name of the agent class.
static java.lang.String	CLASSDIMHWALL A constant for the name of the horizontal wall class.
static java.lang.String	CLASSDIMVWALL A constant for the name of the vertical wall class.
static java.lang.String	CLASSGOAL A constant for the name of the goal class.
protected int	maxDim The width and height of the world.
protected int	maxGT The number of goal types
protected int	maxPlyrs The maximum number of players that can be in the game
protected int	maxWT The number of wall types
static java.lang.String	PFINPGOAL A constant for the name of a propositional function that evaluates whether an agent is in a personal goal location for just them.
static java.lang.String	PFINUGOAL A constant for the name of a propositional function that evaluates whether an agent is in a universal goal location.
protected double	semiWallProb The probability that an agent will pass through a semi-wall.

Constructor Summary

Constructors

Constructor and Description
GridGame()

Method Summary

Methods

Modifier and Type	Method and Description
protected static void	addNObjects(Domain d, State s, java.lang.String className, int n) AddsN objects of a specific object class to a state object
Domain	generateDomain() Returns a newly instanced Domain object
static State	getCleanState(Domain d, int na, int ng, int nhw, int nvw, int width, int height) Returns a state with with the specified number of objects for each object class and with the specified boundary of the playing area.
static State	getCorrdinationGameInitialState(Domain d) Returns the initial state for a classic coordination game, where the agent's personal goals are on opposite sides.
static State	getFriendFoeInitialState(Domain d) Returns the initial state for Friend Foe game.
static State	getIncredibleInitialState(Domain d) Returns the initial state for the Incredible game (a game in which player 0 can give an incredible threat).
int	getMaxDim() Returns the maximum dimension of the world; it's width and height.
int	getMaxGT() Returns the maximum goal types
int	getMaxPlyrs() Returns the max number of players
int	getMaxWT() Returns the maximum number of wall types
static State	getPrisonersDilemmaInitialState(Domain d) Returns the initial state for a classic prisoner's dilemma formulated in a Grid Game.
double	getSemiWallProb() Returns the probability that an agent can pass through a semi-wall.
static State	getSimpleGameInitialState(Domain d) Returns the initial state for a simple game in which both players can win without interfering with one another.
static SGAgentType	getStandardGridGameAgentType(Domain domain) Creates and returns a standard SGAgentType for grid games.
static State	getTurkeyInitialState(Domain d)
static void	main(java.lang.String[] args) Creates a visual explorer for a simple domain with two agents in it.
static void	setAgent(State s, int i, int x, int y, int pn) Sets an agent's attribute values
static void	setBoundaryWalls(State s, int w, int h) Sets boundary walls of a domain.
static void	setGoal(State s, int i, int x, int y, int gt) Sets a goal objects attribute values
static void	setHorizontalWall(State s, int i, int p, int e1, int e2, int wt) Sets the attribute values for a horizontal wall
void	setMaxDim(int maxDim) Sets the maximum dimension of the world; it's width and height.
void	setMaxGT(int maxGT) Sets the maximum goal types
void	setMaxPlyrs(int maxPlyrs) Sets the max number of players
void	setMaxWT(int maxWT) Sets the maximum number of wall types
void	setSemiWallPassableProbability(double p) Sets the probability that an agent can pass through a semi-wall.
static void	setVerticalWall(State s, int i, int p, int e1, int e2, int wt) Sets the attribute values for a vertical wall
static void	setWallInstance(ObjectInstance w, int p, int e1, int e2, int wt) Sets the attribute values for a wall instance

Methods inherited from class java.lang.Object

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

Field Detail

ATTX

public static final java.lang.String ATTX

A constant for the name of the x position attribute

See Also:

Constant Field Values

ATTY

public static final java.lang.String ATTY

A constant for the name of the y position attribute

See Also:

Constant Field Values

ATTPN

public static final java.lang.String ATTPN

A constant for the name of the player number attribute. The first player number is 0.

See Also:

Constant Field Values

ATTGT

public static final java.lang.String ATTGT

A constant for the name of the goal type attribute. Type 0 corresponds to a universal goal. Type i corresponds to a personal goal for player i-1.

See Also:

Constant Field Values

ATTE1

public static final java.lang.String ATTE1

A constant for the name of the first wall end position attribute. For a horizontal wall, this attribute represents the left end point; for a vertical wall, the bottom end point.

See Also:

Constant Field Values

ATTE2

public static final java.lang.String ATTE2

A constant for the name of the second wall end position attribute. For a horizontal wall, this attribute represents the right end point; for a vertical wall, the top end point.

See Also:

Constant Field Values

ATTP

public static final java.lang.String ATTP

A constant for the name of the attribute for defining the walls position along its orthogonal direction. For a horizontal wall, this attribute represents the y position of the wall; for a vertical wall, the x position.

See Also:

Constant Field Values

ATTWT

public static final java.lang.String ATTWT

A constant for the name of the wall type attribute.

See Also:

Constant Field Values

CLASSAGENT

public static final java.lang.String CLASSAGENT

A constant for the name of the agent class.

See Also:

Constant Field Values

CLASSGOAL

public static final java.lang.String CLASSGOAL

A constant for the name of the goal class.

See Also:

Constant Field Values

CLASSDIMHWALL

public static final java.lang.String CLASSDIMHWALL

A constant for the name of the horizontal wall class.

See Also:

Constant Field Values

CLASSDIMVWALL

public static final java.lang.String CLASSDIMVWALL

A constant for the name of the vertical wall class.

See Also:

Constant Field Values

ACTIONNORTH

public static final java.lang.String ACTIONNORTH

A constant for the name of the north action.

See Also:

Constant Field Values

ACTIONSOUTH

public static final java.lang.String ACTIONSOUTH

A constant for the name of the south action.

See Also:

Constant Field Values

ACTIONEAST

public static final java.lang.String ACTIONEAST

A constant for the name of the east action.

See Also:

Constant Field Values

ACTIONWEST

public static final java.lang.String ACTIONWEST

A constant for the name of the west action.

See Also:

Constant Field Values

ACTIONNOOP

public static final java.lang.String ACTIONNOOP

A constant for the name of the no operation (do nothing) action.

See Also:

Constant Field Values

PFINUGOAL

public static final java.lang.String PFINUGOAL

A constant for the name of a propositional function that evaluates whether an agent is in a universal goal location.

See Also:

Constant Field Values

PFINPGOAL

public static final java.lang.String PFINPGOAL

A constant for the name of a propositional function that evaluates whether an agent is in a personal goal location for just them.

See Also:

Constant Field Values

maxDim

protected int maxDim

The width and height of the world.

maxPlyrs

protected int maxPlyrs

The maximum number of players that can be in the game

maxGT

protected int maxGT

The number of goal types

maxWT

protected int maxWT

The number of wall types

semiWallProb

protected double semiWallProb

The probability that an agent will pass through a semi-wall.

Constructor Detail

GridGame

public GridGame()

Method Detail

main

public static void main(java.lang.String[] args)

Creates a visual explorer for a simple domain with two agents in it. The w-a-s-d keys control the movement of the first agent; the i-k-j-l keys control the movement direction of the second agent. q sets the first agent to do nothing and u sets the second agent to do nothing. When the actions for both agents have been set, the actions can be committed to affect the world by pressing the c key.

If "t" is passed as an argument then a terminal explorer is used instead.

Parameters:

args -

getMaxDim

public int getMaxDim()

Returns the maximum dimension of the world; it's width and height.

Returns:

the maximum dimension of the world; it's width and height.

setMaxDim

public void setMaxDim(int maxDim)

Sets the maximum dimension of the world; it's width and height.

Parameters:

maxDim - the maximum dimension of the world; it's width and height.

getMaxPlyrs

public int getMaxPlyrs()

Returns the max number of players

Returns:

the max number of players

setMaxPlyrs

public void setMaxPlyrs(int maxPlyrs)

Sets the max number of players

Parameters:

maxPlyrs - the max number of players

getMaxGT

public int getMaxGT()

Returns the maximum goal types

Returns:

the maximum goal types

setMaxGT

public void setMaxGT(int maxGT)

Sets the maximum goal types

Parameters:

maxGT - the maximum goal types

getMaxWT

public int getMaxWT()

Returns the maximum number of wall types

Returns:

the maximum number of wall types

setMaxWT

public void setMaxWT(int maxWT)

Sets the maximum number of wall types

Parameters:

maxWT - the maximum number of wall types

setSemiWallPassableProbability

public void setSemiWallPassableProbability(double p)

Sets the probability that an agent can pass through a semi-wall.

Parameters:

p - the probability that an agent will pass through a semi-wall.

getSemiWallProb

public double getSemiWallProb()

Returns the probability that an agent can pass through a semi-wall.

Returns:

the probability that an agent can pass through a semi-wall.

generateDomain

public Domain generateDomain()

Description copied from interface: DomainGenerator

Returns a newly instanced Domain object

Specified by:

generateDomain in interface DomainGenerator

Returns:

the newly instantiated Domain object.

getCleanState

public static State getCleanState(Domain d,
                  int na,
                  int ng,
                  int nhw,
                  int nvw,
                  int width,
                  int height)

Returns a state with with the specified number of objects for each object class and with the specified boundary of the playing area. The number of walls *MUST* include the world boundary walls; that is, there must be at least 2 horizontal walls and 2 vertical walls.

Parameters:

d - the domain object of the grid world

na - the number of agents/players

ng - the number of goal objects

nhw - the number of horizontal walls

nvw - the number of vertical walls

width - the width of the playing area

height - the height of the playing area

Returns:

A state with the specified number of objects

getSimpleGameInitialState

public static State getSimpleGameInitialState(Domain d)

Returns the initial state for a simple game in which both players can win without interfering with one another.

Parameters:

d - the grid games domain object

Returns:

the simple game initial state

getCorrdinationGameInitialState

public static State getCorrdinationGameInitialState(Domain d)

Returns the initial state for a classic coordination game, where the agent's personal goals are on opposite sides.

Parameters:

d - the grid games domain object

Returns:

the coordination game initial state

getPrisonersDilemmaInitialState

public static State getPrisonersDilemmaInitialState(Domain d)

Returns the initial state for a classic prisoner's dilemma formulated in a Grid Game.

Parameters:

d - the grid game's domain object

Returns:

the grid game prisoner's dilemma initial state

getFriendFoeInitialState

public static State getFriendFoeInitialState(Domain d)

Returns the initial state for Friend Foe game.

Parameters:

d - the grid game's domain object

Returns:

the initial state for Friend Foe

getIncredibleInitialState

public static State getIncredibleInitialState(Domain d)

Returns the initial state for the Incredible game (a game in which player 0 can give an incredible threat).

Parameters:

d - the grid game's domain object

Returns:

the initial state for the Incredible game.

getTurkeyInitialState

public static State getTurkeyInitialState(Domain d)

addNObjects

protected static void addNObjects(Domain d,
               State s,
               java.lang.String className,
               int n)

AddsN objects of a specific object class to a state object

Parameters:

d - the domain of the object classes

s - the state to which the objects of the specified class should be added

className - the name of the object class for which to create object instances

n - the number of object instances to create

setAgent

public static void setAgent(State s,
            int i,
            int x,
            int y,
            int pn)

Sets an agent's attribute values

Parameters:

s - the state in which the agent exists

i - indicates the ith agent object whose values should be set

x - the x position of the agent

y - the y position of the agent

pn - the player number of the agent

setGoal

public static void setGoal(State s,
           int i,
           int x,
           int y,
           int gt)

Sets a goal objects attribute values

Parameters:

s - the state in which the goal exists

i - indicates the ith goal object whose values should be set

x - the x position of the goal

y - the y position of the goal

gt - the goal type

setBoundaryWalls

public static void setBoundaryWalls(State s,
                    int w,
                    int h)

Sets boundary walls of a domain. This method will add 4 solid walls (top left bottom right) to create a playing field in which the agents can interact.

Parameters:

s - the state in which the walls should be added

w - the width of the playing field

h - the height of the playing field

setWallInstance

public static void setWallInstance(ObjectInstance w,
                   int p,
                   int e1,
                   int e2,
                   int wt)

Sets the attribute values for a wall instance

Parameters:

w - the wall instance to set

p - the orthogonal position of the wall instance

e1 - the first end point of the wall

e2 - the second end point of the wall

wt - the type of the wall

setVerticalWall

public static void setVerticalWall(State s,
                   int i,
                   int p,
                   int e1,
                   int e2,
                   int wt)

Sets the attribute values for a vertical wall

Parameters:

s - the state in which the wall exits

i - indicates the ith vertical wall instance whose values should be set

p - the x position of the vertical wall

e1 - the bottom end point of the wall

e2 - the top end point of the wall

wt - the type of the wall

setHorizontalWall

public static void setHorizontalWall(State s,
                     int i,
                     int p,
                     int e1,
                     int e2,
                     int wt)

Sets the attribute values for a horizontal wall

Parameters:

s - the state in which the wall exits

i - indicates the ith horizontal wall instance whose values should be set

p - the y position of the vertical wall

e1 - the left end point of the wall

e2 - the right end point of the wall

wt - the type of the wall (0 is solid, 1 is semi)

getStandardGridGameAgentType

public static SGAgentType getStandardGridGameAgentType(Domain domain)

Creates and returns a standard SGAgentType for grid games. This SGAgentType is assigned the type name "agent", grid game OO-MDP object class for "agent", and has its action space set to all possible actions in the grid game domain. Typically, all agents in a grid game should be assigned to the same type.

Parameters:

domain - the domain object of the grid game.

Returns:

An SGAgentType that typically all SGAgent's of the grid game should play as.