JointAction

java.lang.Object
- burlap.oomdp.core.AbstractGroundedAction
- - burlap.oomdp.stochasticgames.JointAction

All Implemented Interfaces:

java.lang.Iterable<GroundedSingleAction>
```
public class JointAction
extends AbstractGroundedAction
implements java.lang.Iterable<GroundedSingleAction>
```
This class specifies which action each agent took in a world. The class is backed by a Map from agent names to the GroundedSingleAction taken by that respective agent. The GroundedSingleAction 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,GroundedSingleAction> actions
- Fields inherited from class burlap.oomdp.core.AbstractGroundedAction
  params

Fields
Modifier and Type	Field and Description
`java.util.Map<java.lang.String,GroundedSingleAction>`	`actions`

Constructor Summary

Constructors
Constructor and Description

JointAction()

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

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

Method Summary

Methods
Modifier and Type	Method and Description
`GroundedSingleAction`	`action(java.lang.String agentName)` Returns the action taken by the agent with the given name
`boolean`	`actionDomainIsObjectIdentifierDependent()` Returns true if the domain to which this action belongs is object identifier dependent
`java.lang.String`	`actionName()` Returns the action name for this grounded action.
`void`	`addAction(GroundedSingleAction action)` Adds a single `GroundedSingleAction` object to this joint aciton
`protected static void`	`allJointActionsHelper(java.util.List<java.util.List<GroundedSingleAction>> individualActionChoices, int i, java.util.LinkedList<GroundedSingleAction> currentSelections, java.util.List<JointAction> allJointActions)`
`JointAction`	`copy()` Returns a copy of this grounded action.
`boolean`	`equals(java.lang.Object o)`
`State`	`executeIn(State s)` Executes the grounded action on a given state
`java.util.List<GroundedSingleAction>`	`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<Agent> agents)`
`static java.util.List<JointAction>`	`getAllJointActions(State s, java.util.Map<java.lang.String,AgentType> agents)`
`int`	`hashCode()`
`boolean`	`isExecutable()` Returns true if this grounded action can be directly executed on a state with the `AbstractGroundedAction.executeIn(State)` method.
`boolean`	`isParameterized()` Returns true if this action uses parameters
`java.util.Iterator<GroundedSingleAction>`	`iterator()`
`java.lang.String`	`noParametersActionDescription()` Returns a string representation of this joint aciton without including the parameters of any parameterized actions.
`boolean`	`parametersAreObjects()` Returns true if all parameters (if any) for this action represent OO-MDP objects in a state; false otherwise.
`int`	`size()` Returns the number of actions in this joint action.
`java.lang.String`	`toString()`
`AbstractGroundedAction`	`translateParameters(State sourceState, State targetState)` This method will translate this object's parameters that were assigned for a given source state, into object parameters in the target state that are equal.

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,GroundedSingleAction> actions
```
- Constructor Detail
  - JointAction
```
public JointAction()
```
  - JointAction
```
public JointAction(java.util.List<GroundedSingleAction> actions)
```
    Adds all GroundedSingleAction objects in a list to this joint action.
    
    Parameters:
    actions - the actions to add to this joint action.
- Method Detail
  - addAction
```
public void addAction(GroundedSingleAction action)
```
    Adds a single GroundedSingleAction object to this joint aciton
    
    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<GroundedSingleAction> 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 GroundedSingleAction 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<GroundedSingleAction> iterator()
```
    Specified by:
    
    iterator in interface java.lang.Iterable<GroundedSingleAction>
  - copy
```
public JointAction copy()
```
    Description copied from class: AbstractGroundedAction
    
    Returns a copy of this grounded action.
    
    Specified by:
    
    copy in class 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 class: AbstractGroundedAction
    
    Returns the action name for this grounded action.
    
    Specified by:
    
    actionName in class AbstractGroundedAction
    
    Returns:
    the action name for this grounded action.
  - isExecutable
```
public boolean isExecutable()
```
    Description copied from class: AbstractGroundedAction
    
    Returns true if this grounded action can be directly executed on a state with the AbstractGroundedAction.executeIn(State) method. For example, a single agent domain grounded action is executable; a stochastic games single grounded action is not, because the action of all other agents must also be known in order to get the next state.
    
    Specified by:
    
    isExecutable in class AbstractGroundedAction
    
    Returns:
    true if this grounded action can be directly executed on a state; false otherwise.
  - executeIn
```
public State executeIn(State s)
```
    Description copied from class: AbstractGroundedAction
    
    Executes the grounded action on a given state
    
    Specified by:
    
    executeIn in class AbstractGroundedAction
    
    Parameters:
    s - the state on which to execute the action
    
    Returns:
    The state after the action has been executed
  - actionDomainIsObjectIdentifierDependent
```
public boolean actionDomainIsObjectIdentifierDependent()
```
    Description copied from class: AbstractGroundedAction
    
    Returns true if the domain to which this action belongs is object identifier dependent
    
    Specified by:
    
    actionDomainIsObjectIdentifierDependent in class AbstractGroundedAction
    
    Returns:
    true if the domain to which this action belongs is object identifier dependent; false otherwise
  - translateParameters
```
public AbstractGroundedAction translateParameters(State sourceState,
                                         State targetState)
```
    Description copied from class: AbstractGroundedAction
    
    This method will translate this object's parameters that were assigned for a given source state, into object parameters in the target state that are equal. This method is useful if a domain uses parameterized actions and is object identifier invariant. If the domain of this grounded aciton's action is object identifier dependent, then no translation will occur and this object will be returned. This object will also be returned if it is a parameterless action.
    
    Overrides:
    
    translateParameters in class AbstractGroundedAction
    
    Parameters:
    sourceState - the source state from which this objects parameters were bound.
    targetState - a target state with potentially different object identifiers for equivalent values.
    
    Returns:
    a grounded action object whose parameters have been translated to the target state object identifiers
  - isParameterized
```
public boolean isParameterized()
```
    Description copied from class: AbstractGroundedAction
    
    Returns true if this action uses parameters
    
    Overrides:
    
    isParameterized in class AbstractGroundedAction
    
    Returns:
    true if this action uses parameters; false otherwise
  - getAllJointActions
```
public static java.util.List<JointAction> getAllJointActions(State s,
                                             java.util.List<Agent> agents)
```
  - getAllJointActions
```
public static java.util.List<JointAction> getAllJointActions(State s,
                                             java.util.Map<java.lang.String,AgentType> agents)
```
  - allJointActionsHelper
```
protected static void allJointActionsHelper(java.util.List<java.util.List<GroundedSingleAction>> individualActionChoices,
                         int i,
                         java.util.LinkedList<GroundedSingleAction> currentSelections,
                         java.util.List<JointAction> allJointActions)
```
  - parametersAreObjects
```
public boolean parametersAreObjects()
```
    Description copied from class: AbstractGroundedAction
    
    Returns true if all parameters (if any) for this action represent OO-MDP objects in a state; false otherwise. This method will query the refenced action object to evaluate. (e.g., GroundedAction will query its referenced Action object; GroundedSingleAction will query its referenced SingleAction.
    
    Specified by:
    
    parametersAreObjects in class AbstractGroundedAction
    
    Returns:
    true if all parameters (if any) for this action represent OO-MDP objects in a state; false otherwise.

Class JointAction

Field Summary

Fields inherited from class burlap.oomdp.core.AbstractGroundedAction

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

actions

Constructor Detail

JointAction

JointAction

Method Detail

addAction

size

getActionList

action

getAgentNames

noParametersActionDescription

toString

hashCode

iterator

copy

equals

actionName

isExecutable

executeIn

actionDomainIsObjectIdentifierDependent

translateParameters

isParameterized

getAllJointActions

getAllJointActions

allJointActionsHelper

parametersAreObjects