org.rlcommunity.rlglue.codec.types
Class Reward_observation_terminal

java.lang.Object
  extended by org.rlcommunity.rlglue.codec.types.Reward_observation_terminal

public class Reward_observation_terminal
extends java.lang.Object

I'm iteratively updating these methods to have getters and setters for all components because eventually we might like to make the actual members private.

Author:
btanner

Field Summary
 Observation o
           
 double r
           
 int terminal
           
 
Constructor Summary
Reward_observation_terminal()
           
Reward_observation_terminal(double reward, Observation observation, boolean terminal)
           
Reward_observation_terminal(double reward, Observation observation, int terminal)
           
Reward_observation_terminal(Reward_observation_terminal src)
          This is a deep copy constructor
 
Method Summary
 Reward_observation_terminal duplicate()
           
 Observation getObservation()
           
 double getReward()
           
 int getTerminal()
          Deprecated. use isTerminal
 boolean isTerminal()
           
 void setObservation(Observation o)
           
 void setReward(double newReward)
          Set the reward value.
 void setTerminal(boolean newTerminal)
          Adding this method in an effort to get us away from the integer terminal type.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

r

public double r

o

public Observation o

terminal

public int terminal
Constructor Detail

Reward_observation_terminal

public Reward_observation_terminal()

Reward_observation_terminal

public Reward_observation_terminal(double reward,
                                   Observation observation,
                                   int terminal)

Reward_observation_terminal

public Reward_observation_terminal(double reward,
                                   Observation observation,
                                   boolean terminal)
Since:
2.0 Want to move towards using terminal as a boolean not an int.

Reward_observation_terminal

public Reward_observation_terminal(Reward_observation_terminal src)
This is a deep copy constructor

Parameters:
src -
Method Detail

setReward

public void setReward(double newReward)
Set the reward value.

Parameters:
newReward -
Since:
2.0

getReward

public double getReward()

isTerminal

public boolean isTerminal()
Returns:
boolean representation of whether the episode is over.
Since:
2.0 Want to move towards using terminal as a boolean not an int.

getTerminal

public int getTerminal()
Deprecated. use isTerminal

One day we will make the members private and you'll have to use accessors. It would be better if you used the version that returns a boolean, but this is better than accessing the members directly.

Returns:
an integer, 1 if terminal, 0 if not

setTerminal

public void setTerminal(boolean newTerminal)
Adding this method in an effort to get us away from the integer terminal type. Eventually we can just use the methods and privatize the members.

Parameters:
newTerminal -
Since:
2.0

setObservation

public void setObservation(Observation o)
Parameters:
o -
Since:
2.0

getObservation

public Observation getObservation()

duplicate

public Reward_observation_terminal duplicate()