edu.memphis.ccrg.lida.proceduralmemory
Interface Scheme

All Superinterfaces:
Activatible, Learnable, java.io.Serializable
All Known Implementing Classes:
SchemeImpl

public interface Scheme
extends Learnable

A Scheme consists of a Context, an Action and a Result. A scheme is activated in the presence of its context. If its action is taken then its result is more likely to be true. It can be instantiated in which case the instantiation is called a Behavior.

Author:
Ryan J. McCall

Field Summary
 
Fields inherited from interface edu.memphis.ccrg.lida.framework.shared.activation.Learnable
DEFAULT_BASE_LEVEL_ACTIVATION, DEFAULT_LEARNABLE_REMOVAL_THRESHOLD
 
Fields inherited from interface edu.memphis.ccrg.lida.framework.shared.activation.Activatible
DEFAULT_ACTIVATIBLE_REMOVAL_THRESHOLD, DEFAULT_ACTIVATION
 
Method Summary
 void actionExecuted()
          Called when Scheme's action is executed Scheme should update the number of times its action has been executed in order to calculate reliability.
 void actionSuccessful()
          Called when Scheme's action produces expected result.
 Action getAction()
          Gets action.
 NodeStructure getAddingResult()
          Returns addingResult.
 NodeStructure getContext()
          Gets context.
 NodeStructure getDeletingResult()
          Returns deletingResult.
 int getExecutions()
          Gets the number of executions
 long getId()
          Gets scheme's id.
 Behavior getInstantiation()
          Instantiates and returns a Behavior based on this Scheme
 java.lang.String getLabel()
          Gets label.
 double getReliability()
          Returns reliability
 double getReliabilityThreshold()
          Gets reliabilityThreshold
 boolean isInnate()
           
 boolean isReliable()
           
 void setAction(Action action)
          Sets scheme Action.
 void setAddingResult(NodeStructure ns)
          Sets addingResult.
 void setContext(NodeStructure ns)
          Sets context.
 void setDeletingResult(NodeStructure ns)
          Sets deletingResult.
 void setInnate(boolean innate)
          Sets innate
 void setLabel(java.lang.String label)
          Sets label.
 void setReliabilityThreshold(double threshold)
          Sets reliabilityThreshold
 
Methods inherited from interface edu.memphis.ccrg.lida.framework.shared.activation.Learnable
decayBaseLevelActivation, getBaseLevelActivation, getBaseLevelDecayStrategy, getBaseLevelExciteStrategy, getLearnableRemovalThreshold, getTotalActivationStrategy, reinforceBaseLevelActivation, setBaseLevelActivation, setBaseLevelDecayStrategy, setBaseLevelExciteStrategy, setBaseLevelRemovalThreshold, setTotalActivationStrategy
 
Methods inherited from interface edu.memphis.ccrg.lida.framework.shared.activation.Activatible
decay, excite, getActivatibleRemovalThreshold, getActivation, getDecayStrategy, getExciteStrategy, getTotalActivation, isRemovable, setActivatibleRemovalThreshold, setActivation, setDecayStrategy, setExciteStrategy
 

Method Detail

getId

long getId()
Gets scheme's id.

Returns:
unique identifier for this scheme

getLabel

java.lang.String getLabel()
Gets label.

Returns:
human-readable label

setLabel

void setLabel(java.lang.String label)
Sets label.

Parameters:
label - human-readable label

getContext

NodeStructure getContext()
Gets context.

Returns:
context in which this scheme is activated.

setContext

void setContext(NodeStructure ns)
Sets context.

Parameters:
ns - context in which this scheme is activated.

getAction

Action getAction()
Gets action.

Returns:
scheme's action in SensoryMotorMemory

setAction

void setAction(Action action)
Sets scheme Action.

Parameters:
action - Action

getAddingResult

NodeStructure getAddingResult()
Returns addingResult.

Returns:
NodeStructure representing what this scheme's action should add if executed.

setAddingResult

void setAddingResult(NodeStructure ns)
Sets addingResult.

Parameters:
ns - NodeStructure representing what this scheme's action should add if executed.

getDeletingResult

NodeStructure getDeletingResult()
Returns deletingResult.

Returns:
NodeStructure representing what this scheme's action should delete if executed.

setDeletingResult

void setDeletingResult(NodeStructure ns)
Sets deletingResult.

Parameters:
ns - NodeStructure representing what this scheme's action should delete if executed.

getReliability

double getReliability()
Returns reliability

Returns:
frequency that result is observed after scheme's Action is taken.

isReliable

boolean isReliable()
Returns:
true if reliability is over threshold

actionExecuted

void actionExecuted()
Called when Scheme's action is executed Scheme should update the number of times its action has been executed in order to calculate reliability.


actionSuccessful

void actionSuccessful()
Called when Scheme's action produces expected result.


getExecutions

int getExecutions()
Gets the number of executions

Returns:
how many times this scheme's action has been executed

isInnate

boolean isInnate()
Returns:
true if this scheme should not be decayed.

setInnate

void setInnate(boolean innate)
Sets innate

Parameters:
innate - whether this Scheme is hard-wired and cannot be decayed.

getInstantiation

Behavior getInstantiation()
Instantiates and returns a Behavior based on this Scheme

Returns:
an instantiation of this scheme

setReliabilityThreshold

void setReliabilityThreshold(double threshold)
Sets reliabilityThreshold

Parameters:
threshold - threshold of reliability

getReliabilityThreshold

double getReliabilityThreshold()
Gets reliabilityThreshold

Returns:
threshold of reliability