clarion.system
Class AbstractOutputChunk

java.lang.Object
  extended by java.util.AbstractMap<K,V>
      extended by java.util.HashMap<K,V>
          extended by java.util.LinkedHashMap<java.lang.Object,Dimension>
              extended by clarion.system.DimensionValueCollection
                  extended by clarion.system.AbstractChunk
                      extended by clarion.system.AbstractOutputChunk
All Implemented Interfaces:
InterfaceStochasticallySelectable, InterfaceTracksTime, java.io.Serializable, java.lang.Cloneable, java.util.Map<java.lang.Object,Dimension>
Direct Known Subclasses:
AbstractAction, DimensionlessOutputChunk, Goal

public abstract class AbstractOutputChunk
extends AbstractChunk
implements InterfaceTracksTime, InterfaceStochasticallySelectable

This class implements an output chunk within CLARION. It extends the AbstractChunk class and implements the InterfaceTracksTime and InterfaceStochasticallySelectable interfaces. This class is abstract and therefore cannot be instantiated on its own.

Usage:

An output chunk is a specific case of a chunk that can be set as a node in the output layer of an implicit module. More specifically, unlike a normal chunk, an output chunk has an activation that can be used to store pertinent activation information for objects like drives, goals, or actions.

In addition, output chunks can also be used to keep track of selection measures for both the top and bottom level of the CLARION subsystems, which is used for combination and/or stochastic selection.

Known Subclasses:

This class contains both global (static) and local constants. The default is to use the local constants. If you want to change any of the global constants, you need to do so before any instances of this class are initialized.

Version:
6.0.4
Author:
Nick Wilson
See Also:
Serialized Form

Field Summary
private  double Activation
          The activation of the output chunk.
 double C
          Constant c.
 double D
          Constant d.
private  double FinalSelectionMeasure
          The final selection measure used during stochastic selection.
 double FULL_ACTIVATION_LEVEL
          The level at which an output chunk is considered to be fully activated.
static double GLOBAL_C
          Constant c.
static double GLOBAL_D
          Constant d.
static double GLOBAL_FULL_ACTIVATION_LEVEL
          The level at which an output chunk is considered to be fully activated.
static double GLOBAL_INITIAL_BLA
          The initalBLA.
static double GLOBAL_MINIMUM_ACTIVATION_THRESHOLD
          The minimum threshold an output chunk activation must be above to be considered activated.
static double GLOBAL_PERSISTENCE
          The persistence factor for the previous selection (if used).
 double INITIAL_BLA
          The initalBLA.
 double MINIMUM_ACTIVATION_THRESHOLD
          The minimum threshold an output chunk activation must be above to be considered activated.
 double PERSISTENCE
          The persistence factor for the previous selection (if used).
private  double SelectionMeasureBL
          The selection measure used by the bottom level (usually the same as the activation).
private  double SelectionMeasureTL
          The selection measure used by the top level (in the case of the ACS, can be: Support or Utility).
private static long serialVersionUID
           
private  java.util.LinkedList<java.lang.Long> T
          Time stamps for each usage of the chunk.
 
Constructor Summary
AbstractOutputChunk(java.lang.Object id)
          Initializes the output chunk with the ID specified.
AbstractOutputChunk(java.lang.Object id, java.util.Collection<? extends Dimension> dims)
          Initializes the output chunk with the specified ID and dimensions.
AbstractOutputChunk(java.lang.Object id, java.util.Map<? extends java.lang.Object,? extends Dimension> dims)
          Initializes the output chunk with the specified ID and map of dimensions.
 
Method Summary
 void addTimeStamp(long stamp)
          Adds a time stamp to this chunk.
protected  double adjustSelectionMeasure(double current, double last)
          Adjusts the specified selection measure by the persistence factor.
abstract  AbstractOutputChunk clone()
          Clones the chunk (including all of it's dimensions).
 double getActivation()
          Gets the activation level.
 double getBLA()
          Gets the BLA of this chunk.
 double getBLSelectionMeasure()
          Gets the bottom level selection measure.
 double getFinalSelectionMeasure()
          Gets the final selection measure used for stochastic selection.
 double getTLSelectionMeasure()
          Gets the top level selection measure.
 void resetActivation()
          Resets the activation of the output chunk.
 void setActivation(double act)
          Sets the activation level for the output chunk.
 void setBLSelectionMeasure(double Measure)
          Sets the bottom level selection measure for this chunk.
 void setFinalSelectionMeasure(double Measure)
          Sets the final selection measure.
 void setTLSelectionMeasure(double Measure)
          Sets the top level selection measure for this chunk.
 
Methods inherited from class clarion.system.AbstractChunk
equals, equalsID, getID, toString
 
Methods inherited from class clarion.system.DimensionValueCollection
containsKeys, getNumDVPairs, getValueCollection, hashCode, put, putAll, size
 
Methods inherited from class java.util.LinkedHashMap
clear, containsValue, get, removeEldestEntry
 
Methods inherited from class java.util.HashMap
containsKey, entrySet, isEmpty, keySet, remove, values
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface java.util.Map
containsKey, entrySet, isEmpty, keySet, remove, values
 

Field Detail

serialVersionUID

private static final long serialVersionUID
See Also:
Constant Field Values

Activation

private double Activation
The activation of the output chunk.


SelectionMeasureBL

private double SelectionMeasureBL
The selection measure used by the bottom level (usually the same as the activation).


SelectionMeasureTL

private double SelectionMeasureTL
The selection measure used by the top level (in the case of the ACS, can be: Support or Utility).


FinalSelectionMeasure

private double FinalSelectionMeasure
The final selection measure used during stochastic selection. By default this is set to the bottom level selection measure.


GLOBAL_MINIMUM_ACTIVATION_THRESHOLD

public static double GLOBAL_MINIMUM_ACTIVATION_THRESHOLD
The minimum threshold an output chunk activation must be above to be considered activated.


MINIMUM_ACTIVATION_THRESHOLD

public double MINIMUM_ACTIVATION_THRESHOLD
The minimum threshold an output chunk activation must be above to be considered activated.


GLOBAL_FULL_ACTIVATION_LEVEL

public static double GLOBAL_FULL_ACTIVATION_LEVEL
The level at which an output chunk is considered to be fully activated.


FULL_ACTIVATION_LEVEL

public double FULL_ACTIVATION_LEVEL
The level at which an output chunk is considered to be fully activated.


GLOBAL_PERSISTENCE

public static double GLOBAL_PERSISTENCE
The persistence factor for the previous selection (if used).


PERSISTENCE

public double PERSISTENCE
The persistence factor for the previous selection (if used).


GLOBAL_INITIAL_BLA

public static double GLOBAL_INITIAL_BLA
The initalBLA. Used to calculate BLA


GLOBAL_C

public static double GLOBAL_C
Constant c. Used for calculating BLA


GLOBAL_D

public static double GLOBAL_D
Constant d. Used for calculating BLA


INITIAL_BLA

public double INITIAL_BLA
The initalBLA. Used to calculate BLA


C

public double C
Constant c. Used for calculating BLA


D

public double D
Constant d. Used for calculating BLA


T

private java.util.LinkedList<java.lang.Long> T
Time stamps for each usage of the chunk. Used for calculating BLA.

Constructor Detail

AbstractOutputChunk

public AbstractOutputChunk(java.lang.Object id)
Initializes the output chunk with the ID specified.

Parameters:
id - The ID of the output chunk.

AbstractOutputChunk

public AbstractOutputChunk(java.lang.Object id,
                           java.util.Collection<? extends Dimension> dims)
Initializes the output chunk with the specified ID and dimensions.

Parameters:
id - The ID of the output chunk.
dims - The dimensions for the output chunk.

AbstractOutputChunk

public AbstractOutputChunk(java.lang.Object id,
                           java.util.Map<? extends java.lang.Object,? extends Dimension> dims)
Initializes the output chunk with the specified ID and map of dimensions.

Parameters:
id - The ID of the output chunk.
dims - The map of dimensions for the output chunk.
Method Detail

getActivation

public double getActivation()
Gets the activation level.

Returns:
The activation level.

setActivation

public void setActivation(double act)
Sets the activation level for the output chunk.

Parameters:
act - The activation level to set.

getBLSelectionMeasure

public double getBLSelectionMeasure()
Gets the bottom level selection measure.

Returns:
The bottom level selection measure.

setBLSelectionMeasure

public void setBLSelectionMeasure(double Measure)
Sets the bottom level selection measure for this chunk. This method also sets the final selection measure to the measure specified.

Parameters:
Measure - The selection measure to set.

getTLSelectionMeasure

public double getTLSelectionMeasure()
Gets the top level selection measure.

Returns:
The top level selection measure.

setTLSelectionMeasure

public void setTLSelectionMeasure(double Measure)
Sets the top level selection measure for this chunk.

Parameters:
Measure - The selection measure to set.

getFinalSelectionMeasure

public double getFinalSelectionMeasure()
Gets the final selection measure used for stochastic selection.

Specified by:
getFinalSelectionMeasure in interface InterfaceStochasticallySelectable
Returns:
The final selection measure.

setFinalSelectionMeasure

public void setFinalSelectionMeasure(double Measure)
Sets the final selection measure.

Specified by:
setFinalSelectionMeasure in interface InterfaceStochasticallySelectable
Parameters:
Measure - The value to set for the final selection measure.

resetActivation

public void resetActivation()
Resets the activation of the output chunk.


adjustSelectionMeasure

protected double adjustSelectionMeasure(double current,
                                        double last)
Adjusts the specified selection measure by the persistence factor.

Parameters:
current - The current level of the specified selection measure for the output chunk.
last - The level of the specified selection measure for the output chunk from the last time step.
Returns:
The selection measure adjusted for the persistence factor.

getBLA

public double getBLA()
Gets the BLA of this chunk.

Specified by:
getBLA in interface InterfaceTracksTime
Returns:
The BLA.

addTimeStamp

public void addTimeStamp(long stamp)
Adds a time stamp to this chunk. The time stamp is used for calculating BLA.

Specified by:
addTimeStamp in interface InterfaceTracksTime
Parameters:
stamp - The time stamp to add.

clone

public abstract AbstractOutputChunk clone()
Description copied from class: AbstractChunk
Clones the chunk (including all of it's dimensions).

Specified by:
clone in class AbstractChunk
Returns:
A copy of the chunk.