burlap.oomdp.stochasticgames.explorers

Class SGTerminalExplorer

java.lang.Object

burlap.oomdp.stochasticgames.explorers.SGTerminalExplorer

public class SGTerminalExplorer
extends java.lang.Object

This class allows you act as all of the agents in a domain by choosing actions for each of them to take in specific states. States are conveyed to the user through a text description in the terminal and the user specifies actions by typing the actions into the terminal, one line at a time for each agent's action. The command format is "agentName:action parameter1 parameter2" and so on for as many parameters as there may be (or none if an action takes no parameters).

When all of the agent's actions have been input, they may be executed by typing "##"

Shorthand names for actions names may be provided.

The command #reset causes the state to reset to the initial state provided to the explorer. Other special commands to modify the state may also be specified. The full syntax is printed to the terminal when the explorer begins.

This explorer can also track a reward function and terminal function and print them to the screen, which can be set with the setRewardFunction(burlap.oomdp.stochasticgames.JointReward) and setTerminalFunction(burlap.oomdp.core.TerminalFunction) methods.

Author:

James MacGlashan

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<java.lang.String,java.lang.String>	actionShortHand
protected JointAction	curJointAction
protected SGDomain	domain
protected JointActionModel	jam
protected JointReward	rewardFunction
protected TerminalFunction	terminalFunction

Constructor Summary

Constructors

Constructor and Description
SGTerminalExplorer(SGDomain domain) Initializes the explorer with a domain and action model
SGTerminalExplorer(SGDomain domain, JointActionModel jam) Deprecated.
SGTerminalExplorer(SGDomain domain, JointActionModel jam, java.util.Map<java.lang.String,java.lang.String> ash) Deprecated.
SGTerminalExplorer(SGDomain domain, java.util.Map<java.lang.String,java.lang.String> ash) Initializes the explorer with a domain and action model and shorthand names for actions

Method Summary

Methods

Modifier and Type	Method and Description
void	addActionShortHand(java.lang.String shortHand, java.lang.String action) Adds a shorthand for an action
void	exploreFromState(State s) Causes the explorer to begin from the given input state
JointReward	getRewardFunction()
TerminalFunction	getTerminalFunction()
protected State	parseCommand(State curState, java.lang.String command) Parses a command and returns the resulted modified state
void	printState(State s) Prints the given state to the terminal.
void	setActionShortHand(java.util.Map<java.lang.String,java.lang.String> ash) Sets the action shorthands to use
void	setRewardFunction(JointReward rf) Allows the explorer to keep track of the reward received that will be printed to the output.
void	setTerminalFunction(TerminalFunction terminalFunction)

Methods inherited from class java.lang.Object

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

Field Detail

domain

protected SGDomain domain

actionShortHand

protected java.util.Map<java.lang.String,java.lang.String> actionShortHand

jam

protected JointActionModel jam

curJointAction

protected JointAction curJointAction

rewardFunction

protected JointReward rewardFunction

terminalFunction

protected TerminalFunction terminalFunction

Constructor Detail

SGTerminalExplorer

@Deprecated
public SGTerminalExplorer(SGDomain domain,
                             JointActionModel jam)

Deprecated.

This constructor is deprecated, because SGDomain objects are now expected to have a JointActionModel associated with them, making the constructor parameter for it unnecessary. Instead use the constructor SGTerminalExplorer(burlap.oomdp.stochasticgames.SGDomain).

Parameters:

domain - the domain which will be explored

jam - the action model definition transition dynamics

SGTerminalExplorer

public SGTerminalExplorer(SGDomain domain)

Initializes the explorer with a domain and action model

Parameters:

domain - the domain which will be explored

SGTerminalExplorer

@Deprecated
public SGTerminalExplorer(SGDomain domain,
                             JointActionModel jam,
                             java.util.Map<java.lang.String,java.lang.String> ash)

Deprecated.

This constructor is deprecated, because SGDomain objects are now expected to have a JointActionModel associated with them, making the constructor parameter for it unnecessary. Instead use the constructor SGTerminalExplorer(burlap.oomdp.stochasticgames.SGDomain, java.util.Map).

Parameters:

domain - the domain which will be explored

jam - the action model definition transition dynamics

ash - a map from shorthand names to full action names that can be typed instead of the full action names

SGTerminalExplorer

public SGTerminalExplorer(SGDomain domain,
                  java.util.Map<java.lang.String,java.lang.String> ash)

Initializes the explorer with a domain and action model and shorthand names for actions

Parameters:

domain - the domain which will be explored

ash - a map from shorthand names to full action names that can be typed instead of the full action names

Method Detail

setRewardFunction

public void setRewardFunction(JointReward rf)

Allows the explorer to keep track of the reward received that will be printed to the output.

Parameters:

rf - the reward function to use.

getRewardFunction

public JointReward getRewardFunction()

getTerminalFunction

public TerminalFunction getTerminalFunction()

setTerminalFunction

public void setTerminalFunction(TerminalFunction terminalFunction)

setActionShortHand

public void setActionShortHand(java.util.Map<java.lang.String,java.lang.String> ash)

Sets the action shorthands to use

Parameters:

ash - a map from action shorthands to full action names

addActionShortHand

public void addActionShortHand(java.lang.String shortHand,
                      java.lang.String action)

Adds a shorthand for an action

Parameters:

shortHand - the shorthand for the action

action - the full name of the action that the shorthand represents

exploreFromState

public void exploreFromState(State s)

Causes the explorer to begin from the given input state

Parameters:

s - the state from which to start exploring.

parseCommand

protected State parseCommand(State curState,
                 java.lang.String command)

Parses a command and returns the resulted modified state

Parameters:

curState - the current state to modify

command - the special command to parse

Returns:

the modified state

printState

public void printState(State s)

Prints the given state to the terminal.

Parameters:

s - the state to print to the terminal.