org.eyelanguage.rl.reading
Class ReadingState

java.lang.Object
  net.pakl.rl.State
      org.eyelanguage.rl.reading.ReadingState

All Implemented Interfaces:

java.io.Serializable, HasVectorRepresentation

Direct Known Subclasses:

ReadingStateRelative

public class ReadingState
extends State
implements java.io.Serializable, HasVectorRepresentation

This class represents the State of a reading Agent -- scroll down to Field Detail to see more detailed on information for each dimension of the state. Implicit means that the dimensions are not used in comparing states to each other (ignored.)

See Also:

Serialized Form

Field Summary

protected int	attendedWordID A unique word identification number of the attended word.
protected int	attendedWordLen This is an integer which indicates the number of characters in the word being attended.
protected double	attendedWordPredictability
protected int	distanceFromAttendCenter (Implicit) Indicates the number of characters, including whitespace, from the current eye position to the center of the word that is being attended.
protected int	eyePosition Position of the eye, in integers, relative the to the entire text.
protected int	fixatedWordID (Implicit) A unique word identification number of the fixated word.
protected boolean	identified Whether or not the word being attended has been identified.
protected int	nextWordLen
protected int	previousWordLen
protected boolean	programmingSaccade True or false indicating whether we are in a saccade or not (but we can only be in a saccade if we performed an action to get into one so do all these need to exist?).
protected int	saccadeRequestDistance Result of an action issued by the agent to specify how much of a saccade distance is requested.
protected int	timeAttending The amount of time the agent has spent in this state attending/processing this word.
protected int	timeInProgrammingSaccade Indicates the amount of time spent in a saccade.

Constructor Summary

ReadingState()

ReadingState(double[] doubleRepresentation)

ReadingState(int uniqueCode)

ReadingState(ReadingState oldReadingState)
Preserves all relevant state information in the new state returned.

Method Summary

int[]	binaryRepresentation()
void	clear()
void	copyFrom(ReadingState oldReadingState)
double[]	doubleRepresentation()
boolean	equals(java.lang.Object otherObject)
int	getAttendedWordID()
int	getAttendedWordLen()
double	getAttendedWordPredictability() Getter for property attendedWordPredictability.
int	getDistanceFromAttendCenter()
int	getEyePosition()
int	getFixatedWordID()
int	getNextNextWordLen() Getter for property nextNextWordLen.
double	getNextNextWordPredictability() Getter for property nextNextWordPredictability.
int	getNextWordLen() Getter for property nextWordLen.
double	getNextWordPredictability() Getter for property nextWordPredictability.
int	getPreviousWordLen() Getter for property previousWordLen.
double	getPreviousWordPredictability() Getter for property previousWordPredictability.
int	getSaccadeRequestDistance()
int	getTimeAttending()
int	getTimeInProgrammingSaccade() Getter for property timeInProgrammingSaccade.
int	hashCode() Any two objects which are equal must have equal HashCodes, but not necessarily the other way around.
boolean	isIdentified()
boolean	isProgrammingSaccade() Getter for property programmingSaccade.
void	setAttendedWordID(int attendedWordID)
void	setAttendedWordLen(int attendedWordLen)
void	setAttendedWordPredictability(double attendedWordPredictability) Setter for property attendedWordPredictability.
void	setDistanceFromAttendCenter(int distanceFromAttendCenter)
void	setEyePosition(int eyePosition)
void	setFixatedWordID(int fixatedWordID)
void	setIdentified(boolean identified)
void	setNextNextWordLen(int nextNextWordLen) Setter for property nextNextWordLen.
void	setNextNextWordPredictability(double nextNextWordPredictability) Setter for property nextNextWordPredictability.
void	setNextWordLen(int nextWordLen) Setter for property nextWordLen.
void	setNextWordPredictability(double nextWordPredictability) Setter for property nextWordPredictability.
void	setPreviousWordLen(int previousWordLen) Setter for property previousWordLen.
void	setPreviousWordPredictability(double previousWordPredictability) Setter for property previousWordPredictability.
void	setProgrammingSaccade(boolean programmingSaccade) Setter for property programmingSaccade.
void	setSaccadeRequestDistance(int saccadeRequestDistance)
void	setTimeAttending(int timeAttending)
void	setTimeInProgrammingSaccade(int timeInProgrammingSaccade) Setter for property timeInProgrammingSaccade.
java.lang.String	toString()
static int	uniqueCode()

Methods inherited from class net.pakl.rl.State

concatenateArrays, getPatchName, representAsVector

Methods inherited from class java.lang.Object

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

Field Detail

attendedWordID

protected int attendedWordID

A unique word identification number of the attended word. The first word in the sentence is word number 0.

attendedWordLen

protected int attendedWordLen

This is an integer which indicates the number of characters in the word being attended.

previousWordLen

protected int previousWordLen

nextWordLen

protected int nextWordLen

attendedWordPredictability

protected double attendedWordPredictability

distanceFromAttendCenter

protected int distanceFromAttendCenter

(Implicit) Indicates the number of characters, including whitespace, from the current eye position to the center of the word that is being attended.

eyePosition

protected int eyePosition

Position of the eye, in integers, relative the to the entire text.

fixatedWordID

protected int fixatedWordID

(Implicit) A unique word identification number of the fixated word. The first word in the sentence is word number 0.

identified

protected boolean identified

Whether or not the word being attended has been identified.

programmingSaccade

protected boolean programmingSaccade

True or false indicating whether we are in a saccade or not (but we can only be in a saccade if we performed an action to get into one so do all these need to exist?).

saccadeRequestDistance

protected int saccadeRequestDistance

Result of an action issued by the agent to specify how much of a saccade distance is requested. After some amount of timeInSaccade has elapsed, the agent will find itself looking at a different word.

timeAttending

protected int timeAttending

The amount of time the agent has spent in this state attending/processing this word. After an amount of time, dictated by the ActionSet, there will be actiosn transitioning us to the next word.

timeInProgrammingSaccade

protected int timeInProgrammingSaccade

Indicates the amount of time spent in a saccade.

Constructor Detail

ReadingState

public ReadingState(int uniqueCode)

ReadingState

public ReadingState(ReadingState oldReadingState)

Preserves all relevant state information in the new state returned.

ReadingState

public ReadingState(double[] doubleRepresentation)

ReadingState

public ReadingState()

Method Detail

binaryRepresentation

public int[] binaryRepresentation()

Specified by:

binaryRepresentation in interface HasVectorRepresentation

doubleRepresentation

public double[] doubleRepresentation()

Specified by:

doubleRepresentation in interface HasVectorRepresentation

clear

public void clear()

copyFrom

public void copyFrom(ReadingState oldReadingState)

toString

public java.lang.String toString()

Specified by:

toString in class State

hashCode

public int hashCode()

Any two objects which are equal must have equal HashCodes, but not necessarily the other way around.

Specified by:

hashCode in class State

uniqueCode

public static int uniqueCode()

equals

public boolean equals(java.lang.Object otherObject)

Specified by:

equals in class State

getTimeAttending

public int getTimeAttending()

setTimeAttending

public void setTimeAttending(int timeAttending)

getAttendedWordID

public int getAttendedWordID()

setAttendedWordID

public void setAttendedWordID(int attendedWordID)

getAttendedWordLen

public int getAttendedWordLen()

setAttendedWordLen

public void setAttendedWordLen(int attendedWordLen)

getFixatedWordID

public int getFixatedWordID()

setFixatedWordID

public void setFixatedWordID(int fixatedWordID)

getDistanceFromAttendCenter

public int getDistanceFromAttendCenter()

setDistanceFromAttendCenter

public void setDistanceFromAttendCenter(int distanceFromAttendCenter)

isIdentified

public boolean isIdentified()

setIdentified

public void setIdentified(boolean identified)

getEyePosition

public int getEyePosition()

setEyePosition

public void setEyePosition(int eyePosition)

getSaccadeRequestDistance

public int getSaccadeRequestDistance()

setSaccadeRequestDistance

public void setSaccadeRequestDistance(int saccadeRequestDistance)

isProgrammingSaccade

public boolean isProgrammingSaccade()

Getter for property programmingSaccade.

Returns:

Value of property programmingSaccade.

setProgrammingSaccade

public void setProgrammingSaccade(boolean programmingSaccade)

Setter for property programmingSaccade.

Parameters:

programmingSaccade - New value of property programmingSaccade.

getTimeInProgrammingSaccade

public int getTimeInProgrammingSaccade()

Getter for property timeInProgrammingSaccade.

Returns:

Value of property timeInProgrammingSaccade.

setTimeInProgrammingSaccade

public void setTimeInProgrammingSaccade(int timeInProgrammingSaccade)

Setter for property timeInProgrammingSaccade.

Parameters:

timeInProgrammingSaccade - New value of property timeInProgrammingSaccade.

getAttendedWordPredictability

public double getAttendedWordPredictability()

Getter for property attendedWordPredictability.

Returns:

Value of property attendedWordPredictability.

setAttendedWordPredictability

public void setAttendedWordPredictability(double attendedWordPredictability)

Setter for property attendedWordPredictability.

Parameters:

attendedWordPredictability - New value of property attendedWordPredictability.

getPreviousWordLen

public int getPreviousWordLen()

Getter for property previousWordLen.

Returns:

Value of property previousWordLen.

setPreviousWordLen

public void setPreviousWordLen(int previousWordLen)

Setter for property previousWordLen.

Parameters:

previousWordLen - New value of property previousWordLen.

getNextWordLen

public int getNextWordLen()

Getter for property nextWordLen.

Returns:

Value of property nextWordLen.

setNextWordLen

public void setNextWordLen(int nextWordLen)

Setter for property nextWordLen.

Parameters:

nextWordLen - New value of property nextWordLen.

getNextNextWordLen

public int getNextNextWordLen()

Getter for property nextNextWordLen.

Returns:

Value of property nextNextWordLen.

setNextNextWordLen

public void setNextNextWordLen(int nextNextWordLen)

Setter for property nextNextWordLen.

Parameters:

nextNextWordLen - New value of property nextNextWordLen.

getPreviousWordPredictability

public double getPreviousWordPredictability()

Getter for property previousWordPredictability.

Returns:

Value of property previousWordPredictability.

setPreviousWordPredictability

public void setPreviousWordPredictability(double previousWordPredictability)

Setter for property previousWordPredictability.

Parameters:

previousWordPredictability - New value of property previousWordPredictability.

getNextWordPredictability

public double getNextWordPredictability()

Getter for property nextWordPredictability.

Returns:

Value of property nextWordPredictability.

setNextWordPredictability

public void setNextWordPredictability(double nextWordPredictability)

Setter for property nextWordPredictability.

Parameters:

nextWordPredictability - New value of property nextWordPredictability.

getNextNextWordPredictability

public double getNextNextWordPredictability()

Getter for property nextNextWordPredictability.

Returns:

Value of property nextNextWordPredictability.

setNextNextWordPredictability

public void setNextNextWordPredictability(double nextNextWordPredictability)

Setter for property nextNextWordPredictability.

Parameters:

nextNextWordPredictability - New value of property nextNextWordPredictability.