burlap.oomdp.stochasticgames

Class SingleAction

java.lang.Object

burlap.oomdp.stochasticgames.SingleAction

Direct Known Subclasses:

SingleStageNormalFormGame.NFGSingleAction, UniversalSingleAction

public abstract class SingleAction
extends java.lang.Object

A single action is an action specification for individual agents in a stochastic game. The single action specifies preconditions and any parameters that are required for it to operate. Like The Action class and PropositionalFunction class, SingleAction's can also specify parameter order groups for parameter effect symmetry. See the PropositionalFunction class documentation for a larger discussion on parameter order groups. Unlike The Action class, SingleAction's do not specify the actual transition dynamics, because transition dynamics in a stochastic game depend on the full joint action of all agents (that is, the SingleAction selected by each agent in the world).

Author:

James MacGlashan

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	actionName
SGDomain	domain
java.lang.String[]	parameterOrderGroups
java.lang.String[]	parameterTypes

Constructor Summary

Constructors

Constructor and Description
SingleAction(SGDomain d, java.lang.String name) Initializes this single action to be for the given domain and with the given name.
SingleAction(SGDomain d, java.lang.String name, java.lang.String[] parameterTypes) Initializes this single action to be for the given domain, with the given name, and with the given parameter class types.
SingleAction(SGDomain d, java.lang.String name, java.lang.String[] types, java.lang.String[] parameterOrderGroups) Initializes this single action to be for the given domain, with the given name, with the given parameter class types, and with the given parameter order groups.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
java.util.List<GroundedSingleAction>	getAllGroundedActionsFor(State s, java.lang.String actingAgent) Returns all possible grounded versions of this single action for a given state and acting agent.
static java.util.List<GroundedSingleAction>	getAllPossibleGroundedSingleActions(State s, java.lang.String actingAgent, java.util.List<SingleAction> actions) Returns all possible grounded versions of the provided list of SingleAction objects that an agent can take in the given state.
int	hashCode()
abstract boolean	isApplicableInState(State s, java.lang.String actingAgent, java.lang.String[] params) Returns true if this action can be applied in the given state by the given agent with the given parameters.
boolean	isPamaeterized() Returns true if this action is parameterized.
boolean	parametersAreObjects() Returns true if all parameters (if any) for this action represent OO-MDP objects in a state; false otherwise.

Methods inherited from class java.lang.Object

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

Field Detail

actionName

public java.lang.String actionName

parameterTypes

public java.lang.String[] parameterTypes

parameterOrderGroups

public java.lang.String[] parameterOrderGroups

domain

public SGDomain domain

Constructor Detail

SingleAction

public SingleAction(SGDomain d,
            java.lang.String name)

Initializes this single action to be for the given domain and with the given name. This action is automatically added to the given domain

Parameters:

d - the domain to which this action belongs

name - the name of this action

SingleAction

public SingleAction(SGDomain d,
            java.lang.String name,
            java.lang.String[] parameterTypes)

Initializes this single action to be for the given domain, with the given name, and with the given parameter class types. This action is automatically added to the given domain

Parameters:

d - the domain to which this action belongs

name - the name of this action

parameterTypes - the object class names for the possible parameters of this action.

SingleAction

public SingleAction(SGDomain d,
            java.lang.String name,
            java.lang.String[] types,
            java.lang.String[] parameterOrderGroups)

Initializes this single action to be for the given domain, with the given name, with the given parameter class types, and with the given parameter order groups. This action is automatically added to the given domain

Parameters:

d - the domain to which this action belongs

name - the name of this action

types - the object class names for the possible parameters of this action.

parameterOrderGroups - the parameter order groups to use

Method Detail

isApplicableInState

public abstract boolean isApplicableInState(State s,
                          java.lang.String actingAgent,
                          java.lang.String[] params)

Returns true if this action can be applied in the given state by the given agent with the given parameters.

Parameters:

s - the state in which the action would be executed.

actingAgent - the agent who would be executing the action

params - the parameters applied

Returns:

true if this action can be executed; false otherwise.

isPamaeterized

public boolean isPamaeterized()

Returns true if this action is parameterized.

Returns:

true if this action is parameterized; false otherwise.

parametersAreObjects

public boolean parametersAreObjects()

Returns true if all parameters (if any) for this action represent OO-MDP objects in a state; false otherwise. The default behavior is to return True; but this can be overriden for special actions.

Returns:

true if all parameters (if any) for this action represent OO-MDP objects in a state; false otherwise.

getAllPossibleGroundedSingleActions

public static java.util.List<GroundedSingleAction> getAllPossibleGroundedSingleActions(State s,
                                                                       java.lang.String actingAgent,
                                                                       java.util.List<SingleAction> actions)

Returns all possible grounded versions of the provided list of SingleAction objects that an agent can take in the given state.

Parameters:

s - the state in which to execute actions

actingAgent - the agent who will be executing the actions

actions - the list of actions that to get the grounded version for

Returns:

all possible grounded versions of the provided list of SingleAction objects

getAllGroundedActionsFor

public java.util.List<GroundedSingleAction> getAllGroundedActionsFor(State s,
                                                            java.lang.String actingAgent)

Returns all possible grounded versions of this single action for a given state and acting agent.

Parameters:

s - the state in which the agent would execute this action

actingAgent - the agent who would execute the action

Returns:

all possible grounded versions of this single action for a given state and acting agent.

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object