burlap.behavior.singleagent.options

Class MacroAction

java.lang.Object

burlap.behavior.singleagent.options.MacroAction

All Implemented Interfaces:

Option, Action

public class MacroAction
extends java.lang.Object
implements Option

A macro action is a non-Markov option that always executes a fixed sequence of actions.

Author:

James MacGlashan

Nested Class Summary

Nested classes/interfaces inherited from interface burlap.behavior.singleagent.options.Option

Option.Helper

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<Action>	actionSequence The list of actions that will be executed in order when this macro-action is called.
protected java.lang.String	name The name of the action

Constructor Summary

Constructors

Constructor and Description
MacroAction() Default constructor for serialization purposes.
MacroAction(java.lang.String name, java.util.List<Action> actionSequence) Instantiates a macro action with a given name and action sequence.

Method Summary

Modifier and Type	Method and Description
java.lang.String	actionName() Returns the action name for this grounded action.
int	actionSequenceSize()
EnvironmentOptionOutcome	control(Environment env, double discount)
Action	copy() Returns a copy of this grounded action.
boolean	equals(java.lang.Object o)
java.util.List<Action>	getActionSequence()
java.lang.String	getName()
int	hashCode()
boolean	inInitiationSet(State s) Returns true if the input state is in the initiation set of the Option
boolean	markov()
Action	policy(State s, Episode history)
java.util.List<ActionProb>	policyDistribution(State s, Episode history)
double	probabilityOfTermination(State s, Episode history)
void	setActionSequence(java.util.List<Action> actionSequence)
void	setName(java.lang.String name)

Methods inherited from class java.lang.Object

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

Field Detail

name

protected java.lang.String name

The name of the action

actionSequence

protected java.util.List<Action> actionSequence

The list of actions that will be executed in order when this macro-action is called.

Constructor Detail

MacroAction

public MacroAction()

Default constructor for serialization purposes. In general, you should use MacroAction(String, List)

MacroAction

public MacroAction(java.lang.String name,
                   java.util.List<Action> actionSequence)

Instantiates a macro action with a given name and action sequence. The name of the macro action should be unique from any other action name.

Parameters:

name - the name of the macro action.

actionSequence - the sequence of actions the macro action will execute.

Method Detail

getName

public java.lang.String getName()

setName

public void setName(java.lang.String name)

getActionSequence

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

setActionSequence

public void setActionSequence(java.util.List<Action> actionSequence)

probabilityOfTermination

public double probabilityOfTermination(State s,
                                       Episode history)

Specified by:

probabilityOfTermination in interface Option

inInitiationSet

public boolean inInitiationSet(State s)

Description copied from interface: Option

Returns true if the input state is in the initiation set of the Option

Specified by:

inInitiationSet in interface Option

Parameters:

s - the State to test.

Returns:

true if the state is in the initiation set; false if it is not

policy

public Action policy(State s,
                     Episode history)

Specified by:

policy in interface Option

policyDistribution

public java.util.List<ActionProb> policyDistribution(State s,
                                                     Episode history)

Specified by:

policyDistribution in interface Option

control

public EnvironmentOptionOutcome control(Environment env,
                                        double discount)

Specified by:

control in interface Option

markov

public boolean markov()

Specified by:

markov in interface Option

actionName

public java.lang.String actionName()

Description copied from interface: Action

Returns the action name for this grounded action.

Specified by:

actionName in interface Action

Returns:

the action name for this grounded action.

copy

public Action copy()

Description copied from interface: Action

Returns a copy of this grounded action.

Specified by:

copy in interface Action

Returns:

a copy of this grounded action.

actionSequenceSize

public int actionSequenceSize()

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object