burlap.behavior.singleagent.options

Class SubgoalOption

java.lang.Object

burlap.behavior.singleagent.options.SubgoalOption

All Implemented Interfaces:

Option, Action

public class SubgoalOption
extends java.lang.Object
implements Option

A class for a classic subgoal Markov option. The option policy is specified with a Policy object, the deterministic termination conditions with a StateConditionTest and the initiation set with a StateConditionTest.

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 StateConditionTest	initiationTest The states in which the options can be initiated
protected java.lang.String	name The name of the option
protected Policy	policy The policy of the options
protected StateConditionTest	terminationStates The states in which the option terminates deterministically

Constructor Summary

Constructors

Constructor and Description
SubgoalOption() A default constructor for serialization purposes.
SubgoalOption(java.lang.String name, Policy p, StateConditionTest init, StateConditionTest terminationStates) Initializes.

Method Summary

Modifier and Type	Method and Description
java.lang.String	actionName() Returns the action name for this grounded action.
EnvironmentOptionOutcome	control(Environment env, double discount)
Action	copy() Returns a copy of this grounded action.
boolean	enumerable() Returns true if the initiation states and termination states of this option are iterable; false if either of them are not.
boolean	equals(java.lang.Object o)
StateConditionTest	getInitiationTest() Returns the object defining the initiation states.
java.lang.String	getName()
Policy	getPolicy()
StateConditionTest	getTerminationStates()
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	setInitiationTest(StateConditionTest initiationTest)
void	setName(java.lang.String name)
void	setPolicy(Policy policy)
void	setTerminationStates(StateConditionTest terminationStates)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

name

protected java.lang.String name

The name of the option

policy

protected Policy policy

The policy of the options

initiationTest

protected StateConditionTest initiationTest

The states in which the options can be initiated

terminationStates

protected StateConditionTest terminationStates

The states in which the option terminates deterministically

Constructor Detail

SubgoalOption

public SubgoalOption()

A default constructor for serialization purposes. In general, you should use the SubgoalOption(String, Policy, StateConditionTest, StateConditionTest) constructor.

SubgoalOption

public SubgoalOption(java.lang.String name,
                     Policy p,
                     StateConditionTest init,
                     StateConditionTest terminationStates)

Initializes.

Parameters:

name - the name of the option

p - the option's policy

init - the initiation states of the option

terminationStates - the deterministic termination states of the option.

Method Detail

getInitiationTest

public StateConditionTest getInitiationTest()

Returns the object defining the initiation states.

Returns:

the object defining the initiation states.

getName

public java.lang.String getName()

setName

public void setName(java.lang.String name)

getPolicy

public Policy getPolicy()

setPolicy

public void setPolicy(Policy policy)

setInitiationTest

public void setInitiationTest(StateConditionTest initiationTest)

getTerminationStates

public StateConditionTest getTerminationStates()

setTerminationStates

public void setTerminationStates(StateConditionTest terminationStates)

enumerable

public boolean enumerable()

Returns true if the initiation states and termination states of this option are iterable; false if either of them are not.

Returns:

true if the initiation states and termination states of this option are iterable; false if either of them are not.

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.

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

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object