burlap.behavior.singleagent.options

Class PrimitiveOption

java.lang.Object

burlap.oomdp.singleagent.Action

burlap.behavior.singleagent.options.Option

burlap.behavior.singleagent.options.PrimitiveOption

public class PrimitiveOption
extends Option

This class is just an option wrapper of a standard primitive action. Typically this should be unnecessary because options and actions can coexist in a planner, but if an algorithm wishes to homogenize its interface it may be useful for it to wrap all of the primitives as options.

Author:

James MacGlashan

Field Summary

Fields

Modifier and Type	Field and Description
protected Action	srcAction The primitive action this option wraps.

Fields inherited from class burlap.behavior.singleagent.options.Option

cachedExpectations, cachedExpectedRewards, cumulativeDiscount, discountFactor, expectationSearchCutoffProb, expectationStateHashingFactory, externalTerminalFunction, keepTrackOfReward, lastCumulativeReward, lastNumSteps, lastOptionExecutionResults, rand, rf, shouldAnnotateExecution, shouldRecordResults, stateMapping, terminateMapper

Fields inherited from class burlap.oomdp.singleagent.Action

actionObservers, domain, name, parameterClasses, parameterOrderGroup

Constructor Summary

Constructors

Constructor and Description
PrimitiveOption(Action srcAction) Creates an option wrapper for a given primitive action.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	applicableInState(State st, java.lang.String[] params) Returns true if this action can be applied in this specified state with the specified parameters.
java.util.List<Policy.ActionProb>	getActionDistributionForState(State s, java.lang.String[] params) Returns the option's policy distribution for a given state.
void	initiateInStateHelper(State s, java.lang.String[] params) This method is always called when an option is initated and begins execution.
boolean	isMarkov() Returns whether this option is Markov or not; that is, whether action selection and termination only depends on the current state.
boolean	isPrimitive() Returns whether this action is a primitive action of the domain or not.
GroundedAction	oneStepActionSelection(State s, java.lang.String[] params) This method causes the option to take a single step in the given state, when the option was initiated with the provided parameters.
double	probabilityOfTermination(State s, java.lang.String[] params) Returns the probability that this option (executed with the given parameters) will terminate in the given state
boolean	usesDeterministicPolicy() Returns whether this option's policy is deterministic or stochastic
boolean	usesDeterministicTermination() Returns whether this option's termination conditions are deterministic or stochastic

Methods inherited from class burlap.behavior.singleagent.options.Option

accumulateDiscountedProb, continueFromState, getDeterministicPolicy, getExpectedRewards, getLastCumulativeReward, getLastExecutionResults, getLastNumSteps, getTransitions, init, initiateInState, isAnnotatingExecutionResults, isRecordingExecutionResults, iterateExpectationScan, keepTrackOfRewardWith, map, oneStep, performActionHelper, setExernalTermination, setExpectationCalculationProbabilityCutoff, setExpectationHashingFactory, setStateMapping, setTerminateMapper, toggleShouldAnnotateResults, toggleShouldRecordResults

Methods inherited from class burlap.oomdp.singleagent.Action

addActionObserver, applicableInState, clearAllActionsObservers, deterministicTransition, equals, getAllApplicableGroundedActions, getAllApplicableGroundedActionsFromActionList, getDomain, getName, getParameterClasses, getParameterOrderGroups, getTransitions, hashCode, parametersAreObjects, performAction, performAction

Methods inherited from class java.lang.Object

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

Field Detail

srcAction

protected Action srcAction

The primitive action this option wraps.

Constructor Detail

PrimitiveOption

public PrimitiveOption(Action srcAction)

Creates an option wrapper for a given primitive action. This option will take on the same name as the primitive action.

Parameters:

srcAction - the primitive action to wrap.

Method Detail

isPrimitive

public boolean isPrimitive()

Description copied from class: Action

Returns whether this action is a primitive action of the domain or not. A primitive action is defined to be an action that always takes one time step.

Overrides:

isPrimitive in class Option

Returns:

true if the action is primitive; false otherwise.

isMarkov

public boolean isMarkov()

Description copied from class: Option

Returns whether this option is Markov or not; that is, whether action selection and termination only depends on the current state.

Specified by:

isMarkov in class Option

Returns:

True if this option is Markov ; false otherwise.

usesDeterministicTermination

public boolean usesDeterministicTermination()

Description copied from class: Option

Returns whether this option's termination conditions are deterministic or stochastic

Specified by:

usesDeterministicTermination in class Option

Returns:

true if this option's termination conditions are deterministic; false if stochastic.

usesDeterministicPolicy

public boolean usesDeterministicPolicy()

Description copied from class: Option

Returns whether this option's policy is deterministic or stochastic

Specified by:

usesDeterministicPolicy in class Option

Returns:

true if this option's policy is deterministic; false if stochastic

probabilityOfTermination

public double probabilityOfTermination(State s,
                              java.lang.String[] params)

Description copied from class: Option

Returns the probability that this option (executed with the given parameters) will terminate in the given state

Specified by:

probabilityOfTermination in class Option

Parameters:

s - the state to test for termination

params - any parameters that were applied to this option when it was initiated

Returns:

the probability that this option (executed with the given parameters) will terminate in the given state

initiateInStateHelper

public void initiateInStateHelper(State s,
                         java.lang.String[] params)

Description copied from class: Option

This method is always called when an option is initated and begins execution. Specifically, it is called from the Option.performActionHelper(State, String []) For Markov options, this method probably does not need to do anything, but for non-Markov options, like Macro actions, it may need to initialize some structures for determining termination and action selection.

Specified by:

initiateInStateHelper in class Option

Parameters:

s - the state in which the option was initiated

params - the parameters that were passed to the option for execution

applicableInState

public boolean applicableInState(State st,
                        java.lang.String[] params)

Description copied from class: Action

Returns true if this action can be applied in this specified state with the specified parameters. Default behavior is that an action can be applied in any state, but this will need be overridden if that is not the case.

Overrides:

applicableInState in class Action

Parameters:

st - the state to perform the action on

params - a String array specifying the action object parameters

Returns:

whether the action can be performed on the given state

oneStepActionSelection

public GroundedAction oneStepActionSelection(State s,
                                    java.lang.String[] params)

Description copied from class: Option

This method causes the option to take a single step in the given state, when the option was initiated with the provided parameters. This method will be called by the Option.performActionHelper(State, String []) method until it is determined that the option terminates.

Specified by:

oneStepActionSelection in class Option

Parameters:

s - the state in which an action should be selected.

params - the parameters that were passed to the option when it was initiated

Returns:

the action the option has selected to take in State s

getActionDistributionForState

public java.util.List<Policy.ActionProb> getActionDistributionForState(State s,
                                                              java.lang.String[] params)

Description copied from class: Option

Returns the option's policy distribution for a given state. This method is primarily used by the methods for computing transition dynamics. Note that if this is a non-Markov option, the returned distribution should be with respect to the state in which the option was executed and any previous actions it took that influence behavior.

Specified by:

getActionDistributionForState in class Option

Parameters:

s - the state for which this option's policy distribution should be returned

params - the parameters that were passed to the option when it was initiated

Returns:

this options policy distribution for the given state.