burlap.oomdp.stochasticgames

Class JointAction

java.lang.Object

burlap.oomdp.stochasticgames.JointAction

All Implemented Interfaces:

AbstractGroundedAction, java.lang.Iterable<GroundedSGAgentAction>

public class JointAction
extends java.lang.Object
implements AbstractGroundedAction, java.lang.Iterable<GroundedSGAgentAction>

This class specifies which action each agent took in a world. The class is backed by a Map from agent names to the GroundedSGAgentAction taken by that respective agent. The GroundedSGAgentAction objects of this class can also be iterated over.

Author:

James MacGlashan

Field Summary

Fields

Modifier and Type	Field and Description
java.util.Map<java.lang.String,GroundedSGAgentAction>	actions

Constructor Summary

Constructors

Constructor and Description
JointAction()
JointAction(java.util.List<GroundedSGAgentAction> actions) Adds all GroundedSGAgentAction objects in a list to this joint action.

Method Summary

Methods

Modifier and Type	Method and Description
GroundedSGAgentAction	action(java.lang.String agentName) Returns the action taken by the agent with the given name
java.lang.String	actionName() Returns the action name for this grounded action.
void	addAction(GroundedSGAgentAction action) Adds a single GroundedSGAgentAction object to this joint action.
protected static void	allJointActionsHelper(java.util.List<java.util.List<GroundedSGAgentAction>> individualActionChoices, int i, java.util.LinkedList<GroundedSGAgentAction> currentSelections, java.util.List<JointAction> allJointActions)
JointAction	copy() Returns a copy of this grounded action.
boolean	equals(java.lang.Object o)
java.util.List<GroundedSGAgentAction>	getActionList() Returns a list of the actions in this joint action.
java.util.List<java.lang.String>	getAgentNames() Returns a list of the names of all agents who are represented in this joint action.
static java.util.List<JointAction>	getAllJointActions(State s, java.util.List<SGAgent> agents)
static java.util.List<JointAction>	getAllJointActions(State s, java.util.Map<java.lang.String,SGAgentType> agents)
java.lang.String[]	getParametersAsString() Returns an array of string representations of this AbstractGroundedAction's parameters
int	hashCode()
void	initParamsWithStringRep(java.lang.String[] params) Initializes the parameter values of this AbstractGroundedAction according to the provided string representation of their values.
boolean	isParameterized() Returns true if this action uses parameters
java.util.Iterator<GroundedSGAgentAction>	iterator()
java.lang.String	noParametersActionDescription() Returns a string representation of this joint aciton without including the parameters of any parameterized actions.
int	size() Returns the number of actions in this joint action.
java.lang.String	toString()
AbstractGroundedAction	translateParameters(State sourceState, State targetState)

Methods inherited from class java.lang.Object

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

Field Detail

actions

public java.util.Map<java.lang.String,GroundedSGAgentAction> actions

Constructor Detail

JointAction

public JointAction()

JointAction

public JointAction(java.util.List<GroundedSGAgentAction> actions)

Adds all GroundedSGAgentAction objects in a list to this joint action.

Parameters:

actions - the actions to add to this joint action.

Method Detail

addAction

public void addAction(GroundedSGAgentAction action)

Adds a single GroundedSGAgentAction object to this joint action. Replaces the action for the same agent if an action for that agent is already specified.

Parameters:

action - the action to add

size

public int size()

Returns the number of actions in this joint action.

Returns:

the number of actions in this joint action.

getActionList

public java.util.List<GroundedSGAgentAction> getActionList()

Returns a list of the actions in this joint action. Modifying the returned list does not modify the structure of this joint action.

Returns:

a list of the actions in this joint action

action

public GroundedSGAgentAction action(java.lang.String agentName)

Returns the action taken by the agent with the given name

Parameters:

agentName - the name of the agent whose taken action is to be returned.

Returns:

the action taken by the agent with the given name

getAgentNames

public java.util.List<java.lang.String> getAgentNames()

Returns a list of the names of all agents who are represented in this joint action.

Returns:

a list of the names of all agents who are represented in this joint action.

noParametersActionDescription

public java.lang.String noParametersActionDescription()

Returns a string representation of this joint aciton without including the parameters of any parameterized actions. This method can be useful for generating hash codes since two grounded single actions with different parameter orders may be the same action if the parameters belong to the same order group.

Returns:

a string representation of this joint aciton without including the parameters of any parameterized actions

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

iterator

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

Specified by:

iterator in interface java.lang.Iterable<GroundedSGAgentAction>

copy

public JointAction copy()

Description copied from interface: AbstractGroundedAction

Returns a copy of this grounded action.

Specified by:

copy in interface AbstractGroundedAction

Returns:

a copy of this grounded action.

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

actionName

public java.lang.String actionName()

Description copied from interface: AbstractGroundedAction

Returns the action name for this grounded action.

Specified by:

actionName in interface AbstractGroundedAction

Returns:

the action name for this grounded action.

translateParameters

public AbstractGroundedAction translateParameters(State sourceState,
                                         State targetState)

isParameterized

public boolean isParameterized()

Description copied from interface: AbstractGroundedAction

Returns true if this action uses parameters

Specified by:

isParameterized in interface AbstractGroundedAction

Returns:

true if this action uses parameters; false otherwise

getAllJointActions

public static java.util.List<JointAction> getAllJointActions(State s,
                                             java.util.List<SGAgent> agents)

getAllJointActions

public static java.util.List<JointAction> getAllJointActions(State s,
                                             java.util.Map<java.lang.String,SGAgentType> agents)

allJointActionsHelper

protected static void allJointActionsHelper(java.util.List<java.util.List<GroundedSGAgentAction>> individualActionChoices,
                         int i,
                         java.util.LinkedList<GroundedSGAgentAction> currentSelections,
                         java.util.List<JointAction> allJointActions)

initParamsWithStringRep

public void initParamsWithStringRep(java.lang.String[] params)

Description copied from interface: AbstractGroundedAction

Initializes the parameter values of this AbstractGroundedAction according to the provided string representation of their values.

Specified by:

initParamsWithStringRep in interface AbstractGroundedAction

Parameters:

params - an array in which each element is the string representation of one of this AbstractGroundedAction's values

getParametersAsString

public java.lang.String[] getParametersAsString()

Description copied from interface: AbstractGroundedAction

Returns an array of string representations of this AbstractGroundedAction's parameters

Specified by:

getParametersAsString in interface AbstractGroundedAction

Returns:

an array of string representations of this AbstractGroundedAction's parameters