burlap.mdp.singleagent.pomdp

Class PODomain

java.lang.Object

burlap.mdp.singleagent.SADomain

burlap.mdp.singleagent.pomdp.PODomain

All Implemented Interfaces:

Domain

public class PODomain
extends SADomain

A class for defining POMDP domains. Primarily, this adds to the SADomain definition an ObservationFunction. It also adds an optional StateEnumerator since many POMDP algorithms require knowing in advance the full underlying MDP state space. However, not all domains can enumerate all the states, and therefore this field is not required to be set. If a POMDP algorithm requires a StateEnumerator, then it should first check the providesStateEnumerator() method first. Querying the getStateEnumerator() when it is unset will result in a Runtime exception.

Field Summary

Fields

Modifier and Type	Field and Description
protected ObservationFunction	obsevationFunction The observation function
protected StateEnumerator	stateEnumerator The underlying MDP state enumerator

Fields inherited from class burlap.mdp.singleagent.SADomain

actionMap, actionTypes, model

Constructor Summary

Constructors

Constructor and Description
PODomain()

Method Summary

Modifier and Type	Method and Description
ObservationFunction	getObservationFunction() Returns the ObservationFunction used by this domain.
StateEnumerator	getStateEnumerator() Gets the StateEnumerator used by this domain to enumerate all underlying MDP states.
boolean	providesStateEnumerator() Indicates whether this domain has a StateEnumerator defined for it.
void	setObservationFunction(ObservationFunction observationFunction) Sets the ObservationFunction used by the domain.
void	setStateEnumerator(StateEnumerator stateEnumerator) Sets the StateEnumerator used by this domain to enumerate all underlying MDP states.

Methods inherited from class burlap.mdp.singleagent.SADomain

addActionType, addActionTypes, clearActionTypes, getAction, getActionTypes, getModel, setActionTypes, setActionTypes, setModel

Methods inherited from class java.lang.Object

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

Field Detail

obsevationFunction

protected ObservationFunction obsevationFunction

The observation function

stateEnumerator

protected StateEnumerator stateEnumerator

The underlying MDP state enumerator

Constructor Detail

PODomain

public PODomain()

Method Detail

setObservationFunction

public void setObservationFunction(ObservationFunction observationFunction)

Sets the ObservationFunction used by the domain.

Parameters:

observationFunction - the ObservationFunction to be used by the domain.

getObservationFunction

public ObservationFunction getObservationFunction()

Returns the ObservationFunction used by this domain.

Returns:

the ObservationFunction used by this domain.

providesStateEnumerator

public boolean providesStateEnumerator()

Indicates whether this domain has a StateEnumerator defined for it. If true, then it does provide a StateEnumerator, if false, then it does not. POMDP algorithms that require access to a StateEnumerator should always query this method to check, because querying the getStateEnumerator() when one is not provided by this domain will result in a runtime exception.

Returns:

True if this POMDP domain provides a StateEnumerator, false otherwise.

getStateEnumerator

public StateEnumerator getStateEnumerator()

Gets the StateEnumerator used by this domain to enumerate all underlying MDP states. If no StateEnumerator is provided by this domain, then a runtime exception will be thrown. To check if a StateEnumerator is provided, use the providesStateEnumerator() method.

Returns:

the StateEnumerator used by this domain to enumerate all underlying MDP states.

setStateEnumerator

public void setStateEnumerator(StateEnumerator stateEnumerator)

Sets the StateEnumerator used by this domain to enumerate all underlying MDP states.

Parameters:

stateEnumerator - the StateEnumerator used by this domain to enumerate all underlying MDP states.