burlap.oomdp.stochasticgames

Class SGDomain

java.lang.Object

burlap.oomdp.core.Domain

burlap.oomdp.stochasticgames.SGDomain

public class SGDomain
extends Domain

This class is used to define Stochastic Games Domains. This class extends the parent Domain class by including an index for possible actions each individual agent can take and the joint action model that defines the "physics" of the domain.

Author:

James MacGlashan

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Set<SGAgentAction>	agentActions The full set of actions that could be taken by any agent.
protected JointActionModel	jam The joint action model of the domain
protected java.util.Map<java.lang.String,SGAgentAction>	singleActionMap A map from action names to their corresponding SGAgentAction

Fields inherited from class burlap.oomdp.core.Domain

attributeMap, attributes, debugCode, objectClasses, objectClassMap, objectIdentifierDependentDomain, propFunctionMap, propFunctions

Constructor Summary

Constructors

Constructor and Description
SGDomain()

Method Summary

Methods

Modifier and Type	Method and Description
void	addAction(Action act) Add a single agent action that defines this domain.
void	addSGAgentAction(SGAgentAction sa) Add a SGAgentAction that can be executed by an agent in the game.
Action	getAction(java.lang.String name) Returns the single agent action with the given name.
java.util.List<Action>	getActions() Returns a list of the single agent actions that define this domain.
java.util.List<SGAgentAction>	getAgentActions() Returns a list of the stochastic game actions that that can be taken by individual agents in this domain.
JointActionModel	getJointActionModel() Returns the joint action model associated with this domain.
SGAgentAction	getSGAgentAction(java.lang.String name) Return the stochastic game action (SGAgentAction) with the given name.
SGAgentAction	getSingleAction(java.lang.String name) DEPRECATED: Use Domain.getSGAgentAction(String) instead. Return the stochastic game action with the given name.
protected Domain	newInstance() Will return a new instance of this Domain's class (either SADomain or SGDomain)
void	setJointActionModel(JointActionModel jam) Sets the joint action model associated with this domain.

Methods inherited from class burlap.oomdp.core.Domain

addAttribute, addObjectClass, addPropositionalFunction, getAttribute, getAttributes, getDebugCode, getNewDomainWithCopiedObjectClasses, getObjectClass, getObjectClasses, getPropFunction, getPropFunctions, getPropositionlFunctionsFromObjectClass, getPropositionlFunctionsMap, isObjectIdentifierDependent, setDebugCode, setObjectIdentiferDependence, toggleDebugPrinting

Methods inherited from class java.lang.Object

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

Field Detail

agentActions

protected java.util.Set<SGAgentAction> agentActions

The full set of actions that could be taken by any agent.

singleActionMap

protected java.util.Map<java.lang.String,SGAgentAction> singleActionMap

A map from action names to their corresponding SGAgentAction

jam

protected JointActionModel jam

The joint action model of the domain

Constructor Detail

SGDomain

public SGDomain()

Method Detail

setJointActionModel

public void setJointActionModel(JointActionModel jam)

Sets the joint action model associated with this domain.

Parameters:

jam - the joint action model to associate with this domain.

getJointActionModel

public JointActionModel getJointActionModel()

Returns the joint action model associated with this domain.

Returns:

the joint action model associated with this domain.

addSGAgentAction

public void addSGAgentAction(SGAgentAction sa)

Description copied from class: Domain

Add a SGAgentAction that can be executed by an agent in the game. The set of SGAgentActions defines the set of joint actions in the stochastic domain (as the cross product). This method will throw a runtime exception if this domain is not an instance of the stochastic game domain (SGDomain). The action will not be added if this domain already has a instance with the same name.

Specified by:

addSGAgentAction in class Domain

Parameters:

sa - the SGAgentAction that can be executed by an agent in the game.

getAgentActions

public java.util.List<SGAgentAction> getAgentActions()

Description copied from class: Domain

Returns a list of the stochastic game actions that that can be taken by individual agents in this domain. Modifying the returned list will not alter the list of actions that define this domain, because it returns a shallow copy. Modifying the actions in the returned list will, however, modify the actions in this domain. This method will throw a runtime exception if it is not an instance of the stochastic game domain (SGDomain).

Specified by:

getAgentActions in class Domain

Returns:

a list of the stochastic game actions that that can be taken by individual agents in this domain

getSingleAction

public SGAgentAction getSingleAction(java.lang.String name)

Description copied from class: Domain

DEPRECATED: Use Domain.getSGAgentAction(String) instead.
Return the stochastic game action with the given name. This method will throw a runtime exception if it is not an instance of the stochastic game domain (SGDomain).

Specified by:

getSingleAction in class Domain

Parameters:

name - the name of the action to return

Returns:

the action with the given name or null if it does not exist.

getSGAgentAction

public SGAgentAction getSGAgentAction(java.lang.String name)

Description copied from class: Domain

Return the stochastic game action (SGAgentAction) with the given name. This method will throw a runtime exception if it is not an instance of the stochastic game domain (SGDomain).

Specified by:

getSGAgentAction in class Domain

Parameters:

name - the name of the action to return

Returns:

the SGAgentAction with the given name or null if it does not exist.

addAction

public void addAction(Action act)

Description copied from class: Domain

Add a single agent action that defines this domain. This method will throw a runtime exception if this domain is not an instance of the single agent domain (SADomain). The action will not be added if this domain already has a instance with the same name.

Specified by:

addAction in class Domain

Parameters:

act - the single agent action to add.

getActions

public java.util.List<Action> getActions()

Description copied from class: Domain

Returns a list of the single agent actions that define this domain. Modifying the returned list will not alter the list of actions that define this domain, because it returns a shallow copy. Modifying the actions in the returned list will, however, modify the actions in this domain. This method will throw a runtime exception if it is not an instance of the single agent domain (SADomain).

Specified by:

getActions in class Domain

Returns:

a list of the single agent actions that define this domain

getAction

public Action getAction(java.lang.String name)

Description copied from class: Domain

Returns the single agent action with the given name. This method will throw a runtime exception if it is not an instance of the single agent domain (SADomain).

Specified by:

getAction in class Domain

Parameters:

name - the name of the action to return

Returns:

the action with the given name or null if it does not exist.

newInstance

protected Domain newInstance()

Description copied from class: Domain

Will return a new instance of this Domain's class (either SADomain or SGDomain)

Specified by:

newInstance in class Domain

Returns:

a new instance of this Domain's class (either SADomain or SGDomain)