SimulatedEnvironment

java.lang.Object
- burlap.oomdp.singleagent.environment.SimulatedEnvironment

All Implemented Interfaces:

Environment, EnvironmentServerInterface, StateSettableEnvironment, TaskSettableEnvironment

Direct Known Subclasses:

SimulatedPOEnvironment
```
public class SimulatedEnvironment
extends java.lang.Object
implements StateSettableEnvironment, TaskSettableEnvironment, EnvironmentServerInterface
```
An Environment that simulates interactions using the Action.performAction(burlap.oomdp.core.states.State, burlap.oomdp.singleagent.GroundedAction) method of the the Domain provided to this Environment. The rewards and terminal states are similarly tracked using a provided RewardFunction and TerminalFunction. Initial states of the environment are defined using a StateGenerator. If no StateGenerator is specified, but an initial State is provided in a constructor, then the StateGenerator is set to a ConstantStateGenerator so that upon resetEnvironment() method calls, the initial state is the same as the original input state.

All returned environment observations are fully observable returning a copy of the true internal State of the environment. Copies of the state are returned to prevent tampering of the internal environment state.

By default, this Environment will not allow states to change when the current environment state is a terminal state (as specified by the input TerminalFunction); instead, the same current state will be returned with a reward of zero if someone attempts to interact with the environment through executeAction(burlap.oomdp.singleagent.GroundedAction). In this case, the environment state will have to be manually changed with resetEnvironment() or setCurStateTo(burlap.oomdp.core.states.State) to a non-terminal state before actions will affect the state again. Alternatively, you can allow actions to affect the state from terminal states with the setAllowActionFromTerminalStates(boolean) method.

Author:

James MacGlashan.

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`allowActionFromTerminalStates` A flag indicating whether the environment will respond to actions from a terminal state.
`protected State`	`curState` The current state of the environment
`protected Domain`	`domain` The domain of this environment
`protected double`	`lastReward` The last reward generated from this environment.
`protected java.util.List<EnvironmentObserver>`	`observers` The `EnvironmentObserver` objects that will be notified of `Environment` events.
`protected RewardFunction`	`rf` The reward function of this environment
`protected StateGenerator`	`stateGenerator` The state generator used to generate new states when the environment is reset with `resetEnvironment()`;
`protected TerminalFunction`	`tf` The terminal function for this environment

Constructor Summary

Constructors
Constructor and Description
`SimulatedEnvironment(Domain domain, RewardFunction rf, TerminalFunction tf)`
`SimulatedEnvironment(Domain domain, RewardFunction rf, TerminalFunction tf, State initialState)`
`SimulatedEnvironment(Domain domain, RewardFunction rf, TerminalFunction tf, StateGenerator stateGenerator)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addObservers(EnvironmentObserver... observers)` Adds one or more `EnvironmentObserver`s
`void`	`clearAllObservers()` Clears all `EnvironmentObserver`s from this server.
`EnvironmentOutcome`	`executeAction(GroundedAction ga)` Executes the specified action in this environment
`State`	`getCurrentObservation()` Returns the current observation of the environment as a `State`.
`Domain`	`getDomain()`
`double`	`getLastReward()` Returns the last reward returned by the environment
`java.util.List<EnvironmentObserver>`	`getObservers()` Returns all `EnvironmentObserver`s registered with this server.
`RewardFunction`	`getRf()` Returns the `RewardFunction` this `Environment` uses to determine rewards.
`StateGenerator`	`getStateGenerator()`
`TerminalFunction`	`getTf()` Returns the `TerminalFunction` this `Environment` uses to determine terminal states
`boolean`	`isInTerminalState()` Returns whether the environment is in a terminal state that prevents further action by the agent.
`void`	`removeObservers(EnvironmentObserver... observers)` Removes one or more `EnvironmentObserver`s from this server.
`void`	`resetEnvironment()` Resets this environment to some initial state, if the functionality exists.
`void`	`setAllowActionFromTerminalStates(boolean allowActionFromTerminalStates)` Sets whether the environment will respond to actions from a terminal state.
`void`	`setCurStateTo(State s)` Sets the current state of the environment to the specified state.
`void`	`setDomain(Domain domain)`
`void`	`setRf(RewardFunction rf)` Sets the `RewardFunction` of this `Environment` to the specified reward function.
`void`	`setStateGenerator(StateGenerator stateGenerator)`
`void`	`setTf(TerminalFunction tf)` Sets the `TerminalFunction` of this `Environment` to the specified terminal function.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - domain
```
protected Domain domain
```
    The domain of this environment
  - rf
```
protected RewardFunction rf
```
    The reward function of this environment
  - tf
```
protected TerminalFunction tf
```
    The terminal function for this environment
  - stateGenerator
```
protected StateGenerator stateGenerator
```
    The state generator used to generate new states when the environment is reset with resetEnvironment();
  - curState
```
protected State curState
```
    The current state of the environment
  - lastReward
```
protected double lastReward
```
    The last reward generated from this environment.
  - allowActionFromTerminalStates
```
protected boolean allowActionFromTerminalStates
```
    A flag indicating whether the environment will respond to actions from a terminal state. If false, then once a the environment transitions to a terminal state, any action attempted by the executeAction(burlap.oomdp.singleagent.GroundedAction) method will result in no change in state and to enable action again, the Environment state will have to be manually changed with the resetEnvironment() method or the setCurStateTo(burlap.oomdp.core.states.State) method. If this value is true, then actions will be carried out according to the domain's transition dynamics.
  - observers
```
protected java.util.List<EnvironmentObserver> observers
```
    The EnvironmentObserver objects that will be notified of Environment events.
- Constructor Detail
  - SimulatedEnvironment
```
public SimulatedEnvironment(Domain domain,
                    RewardFunction rf,
                    TerminalFunction tf)
```
  - SimulatedEnvironment
```
public SimulatedEnvironment(Domain domain,
                    RewardFunction rf,
                    TerminalFunction tf,
                    State initialState)
```
  - SimulatedEnvironment
```
public SimulatedEnvironment(Domain domain,
                    RewardFunction rf,
                    TerminalFunction tf,
                    StateGenerator stateGenerator)
```
- Method Detail
  - getDomain
```
public Domain getDomain()
```
  - setDomain
```
public void setDomain(Domain domain)
```
  - getRf
```
public RewardFunction getRf()
```
    Description copied from interface: TaskSettableEnvironment
    
    Returns the RewardFunction this Environment uses to determine rewards.
    
    Specified by:
    
    getRf in interface TaskSettableEnvironment
    
    Returns:
    a RewardFunction
  - setRf
```
public void setRf(RewardFunction rf)
```
    Description copied from interface: TaskSettableEnvironment
    
    Sets the RewardFunction of this Environment to the specified reward function.
    
    Specified by:
    
    setRf in interface TaskSettableEnvironment
    
    Parameters:
    rf - the new RewardFunction of the Environment.
  - getTf
```
public TerminalFunction getTf()
```
    Description copied from interface: TaskSettableEnvironment
    
    Returns the TerminalFunction this Environment uses to determine terminal states
    
    Specified by:
    
    getTf in interface TaskSettableEnvironment
    
    Returns:
    a TerminalFunction
  - setTf
```
public void setTf(TerminalFunction tf)
```
    Description copied from interface: TaskSettableEnvironment
    
    Sets the TerminalFunction of this Environment to the specified terminal function.
    
    Specified by:
    
    setTf in interface TaskSettableEnvironment
    
    Parameters:
    tf - the new TerminalFunction of the Environment.
  - getStateGenerator
```
public StateGenerator getStateGenerator()
```
  - setStateGenerator
```
public void setStateGenerator(StateGenerator stateGenerator)
```
  - addObservers
```
public void addObservers(EnvironmentObserver... observers)
```
    Description copied from interface: EnvironmentServerInterface
    
    Adds one or more EnvironmentObservers
    
    Specified by:
    
    addObservers in interface EnvironmentServerInterface
    
    Parameters:
    observers - and EnvironmentObserver
  - clearAllObservers
```
public void clearAllObservers()
```
    Description copied from interface: EnvironmentServerInterface
    
    Clears all EnvironmentObservers from this server.
    
    Specified by:
    
    clearAllObservers in interface EnvironmentServerInterface
  - removeObservers
```
public void removeObservers(EnvironmentObserver... observers)
```
    Description copied from interface: EnvironmentServerInterface
    
    Removes one or more EnvironmentObservers from this server.
    
    Specified by:
    
    removeObservers in interface EnvironmentServerInterface
    
    Parameters:
    observers - the EnvironmentObservers to remove.
  - getObservers
```
public java.util.List<EnvironmentObserver> getObservers()
```
    Description copied from interface: EnvironmentServerInterface
    
    Returns all EnvironmentObservers registered with this server.
    
    Specified by:
    
    getObservers in interface EnvironmentServerInterface
    
    Returns:
    all EnvironmentObservers registered with this server.
  - setAllowActionFromTerminalStates
```
public void setAllowActionFromTerminalStates(boolean allowActionFromTerminalStates)
```
    Sets whether the environment will respond to actions from a terminal state. If false, then once a the environment transitions to a terminal state, any action attempted by the executeAction(burlap.oomdp.singleagent.GroundedAction) method will result in no change in state and to enable action again, the Environment state will have to be manually changed with the resetEnvironment() method or the setCurStateTo(burlap.oomdp.core.states.State) method. If this value is true, then actions will be carried out according to the domain's transition dynamics.
    
    Parameters:
    allowActionFromTerminalStates - if false, then actions are not allowed from terminal states; if true, then they are allowed.
  - setCurStateTo
```
public void setCurStateTo(State s)
```
    Description copied from interface: StateSettableEnvironment
    
    Sets the current state of the environment to the specified state.
    
    Specified by:
    
    setCurStateTo in interface StateSettableEnvironment
    
    Parameters:
    s - the state to which this Environment will be set.
  - getCurrentObservation
```
public State getCurrentObservation()
```
    Description copied from interface: Environment
    
    Returns the current observation of the environment as a State.
    
    Specified by:
    
    getCurrentObservation in interface Environment
    
    Returns:
    the current observation of the environment as a State.
  - executeAction
```
public EnvironmentOutcome executeAction(GroundedAction ga)
```
    Description copied from interface: Environment
    
    Executes the specified action in this environment
    
    Specified by:
    
    executeAction in interface Environment
    
    Parameters:
    ga - the GroundedAction that is to be performed in this environment.
    
    Returns:
    the resulting observation and reward transition from applying the given GroundedAction in this environment.
  - getLastReward
```
public double getLastReward()
```
    Description copied from interface: Environment
    
    Returns the last reward returned by the environment
    
    Specified by:
    
    getLastReward in interface Environment
    
    Returns:
    the last reward returned by the environment
  - isInTerminalState
```
public boolean isInTerminalState()
```
    Description copied from interface: Environment
    
    Returns whether the environment is in a terminal state that prevents further action by the agent.
    
    Specified by:
    
    isInTerminalState in interface Environment
    
    Returns:
    true if the current environment is in a terminal state; false otherwise.
  - resetEnvironment
```
public void resetEnvironment()
```
    Description copied from interface: Environment
    
    Resets this environment to some initial state, if the functionality exists.
    
    Specified by:
    
    resetEnvironment in interface Environment

Class SimulatedEnvironment

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

domain

rf

tf

stateGenerator

curState

lastReward

allowActionFromTerminalStates

observers

Constructor Detail

SimulatedEnvironment

SimulatedEnvironment

SimulatedEnvironment

Method Detail

getDomain

setDomain

getRf

setRf

getTf

setTf

getStateGenerator

setStateGenerator

addObservers

clearAllObservers

removeObservers

getObservers

setAllowActionFromTerminalStates

setCurStateTo

getCurrentObservation

executeAction

getLastReward

isInTerminalState

resetEnvironment