clarion.system
Class AbstractEquation

java.lang.Object
  extended by clarion.system.AbstractImplicitModule
      extended by clarion.system.AbstractEquation
All Implemented Interfaces:
InterfaceHandlesFeedback
Direct Known Subclasses:
ACSLevelProbabilitySettingEquation, DriveEquation, GoalSelectionEquation

public abstract class AbstractEquation
extends AbstractImplicitModule
implements InterfaceHandlesFeedback

This class implements an equation within CLARION. It extends the AbstractImplicitModule class and implements the InterfaceHandlesFeedback interface. This class is abstract and therefore cannot be instantiated on its own.

Usage:

Any class that extends an abstract equation can be used in the bottom level of the CLARION subsystems. This class mainly provides a framework for building equations to use as implicit modules in the bottom level.

While it is completely within the capabilities of this system to use equations within CLARION, equations are NOT sub-symbolic or distributed in nature. Therefore, it is encouraged that you only use equations in the bottom level for testing and debugging purposes. Instead, you are advised to use a more sub-symbolic structure (such as a neural network) for the implicit modules within CLARION.

Known Subclasses:

Version:
6.0.4
Author:
Nick Wilson

Field Summary
protected  double Feedback
          The immediate feedback given to the equation (if given).
protected  DimensionValueCollection NewInput
          The new input after the chosen output is performed (represented as a collection).
 
Fields inherited from class clarion.system.AbstractImplicitModule
ACTUATION_TIME, ChosenOutput, DECISION_TIME, GLOBAL_ACTUATION_TIME, GLOBAL_DECISION_TIME, GLOBAL_PERCEPTION_TIME, InputAsCollection, Output, PERCEPTION_TIME
 
Constructor Summary
AbstractEquation(java.util.Collection<Dimension> InputSpace, AbstractOutputChunkCollection<? extends AbstractOutputChunk> Outputs)
          Initializes an equation.
 
Method Summary
 double getFeedback()
          Gets the immediate feedback that was last provided to the equation.
 void setFeedback(double R)
          Sets the immediate feedback for the equation.
 
Methods inherited from class clarion.system.AbstractImplicitModule
forwardPass, getChosenOutput, getInput, getNumInput, getNumOutput, getOutput, getOutput, getResponseTime, setChosenOutput, setInput, setInput, setInput
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface clarion.system.InterfaceHandlesFeedback
checkMatchCriterion
 

Field Detail

Feedback

protected double Feedback
The immediate feedback given to the equation (if given).


NewInput

protected DimensionValueCollection NewInput
The new input after the chosen output is performed (represented as a collection).

Constructor Detail

AbstractEquation

public AbstractEquation(java.util.Collection<Dimension> InputSpace,
                        AbstractOutputChunkCollection<? extends AbstractOutputChunk> Outputs)
Initializes an equation.

If this is being used as an implicit module in the ACS and you are using goals or specialized working memory chunks, remember that the input space must also contain all dimension-value pairs within those chunks that differ from the sensory information space.

Parameters:
InputSpace - The input space for the equation.
Outputs - The outputs for the equation.
Method Detail

getFeedback

public double getFeedback()
Gets the immediate feedback that was last provided to the equation. This method is only used if feedback is being provided to the equation (usually for the purposes of extraction).

Specified by:
getFeedback in interface InterfaceHandlesFeedback
Returns:
The feedback.

setFeedback

public void setFeedback(double R)
Sets the immediate feedback for the equation. This method is only used if feedback is being provided to the equation (usually for the purposes of extraction).

Specified by:
setFeedback in interface InterfaceHandlesFeedback
Parameters:
R - The value of the feedback.