org.jactr.core.chunk
Interface ISubsymbolicChunk

All Superinterfaces:
IParameterized
All Known Subinterfaces:
ISubsymbolicChunk4, ISubsymbolicChunk5
All Known Implementing Classes:
AbstractSubsymbolicChunk, DefaultSubsymbolicChunk4, DefaultSubsymbolicChunk5

public interface ISubsymbolicChunk
extends IParameterized

Contains all the methods for manipulating the subsymbolic parameters necessary for learning and activation computation.

Author:
harrison

Field Summary
static java.lang.String ACTIVATION
          Description of the Field
static java.lang.String BASE_LEVEL_ACTIVATION
          Description of the Field
static java.lang.String CREATION_TIME
          Description of the Field
static java.lang.String REFERENCE_COUNT
          Description of the Field
static java.lang.String REFERENCE_TIMES
          Description of the Field
static java.lang.String SOURCE_ACTIVATION
           
static java.lang.String SPREADING_ACTIVATION
          Description of the Field
static java.lang.String TIMES_IN_CONTEXT
          Description of the Field
static java.lang.String TIMES_NEEDED
          Description of the Field
 
Method Summary
 void accessed(double time)
          Is called whenever the chunk is accessed (check via a condition or modified via an action in a IProduction) ? it can only be called once per cycle since the ReferenceList maintains a listing of unique access times.
 void dispose()
          Description of the Method
 void encode(double when)
           
 double getActivation()
          Return the total activation (summation of base-level, spreading, and noise).
 double getBaseLevelActivation()
          Return the current base level activation.
 double getCreationTime()
           
 IReferences getReferences()
          The org.jactr.misc.ReferenceList class maintains an optimized list of access times and access counts.
 double getSourceActivation()
          returns the transient amount of source activation
 double getSpreadingActivation()
          Get the transient amount of spreading activation to this chunk.
 int getTimesInContext()
          Get the number of times this chunk has been a slot value of a chunk in the goal buffer.
 int getTimesNeeded()
          Return the number of times that this chunk has been needed in a buffer other than the goal buffer.
 void incrementTimesInContext()
          Description of the Method
 void incrementTimesNeeded()
          Description of the Method
 void setActivation(double act)
          Set the total activation.
 void setBaseLevelActivation(double base)
          Set the base-level activation.
 void setCreationTime(double time)
          set the creation time and pass on an event.
 void setSourceActivation(double source)
          Set the source activation of this chunk.
 void setSpreadingActivation(double spread)
          Sets the spreadingActivation attribute of the ISubsymbolicChunk object
 void setTimesInContext(int context)
          Set number of times this chunk has been a slot value of a chunk in the goal buffer.
 void setTimesNeeded(int needed)
          Sets the number of times that this chunk has been needed in a buffer other than the goal buffer.
 
Methods inherited from interface org.jactr.core.utils.parameter.IParameterized
getParameter, getPossibleParameters, getSetableParameters, setParameter
 

Field Detail

CREATION_TIME

static final java.lang.String CREATION_TIME
Description of the Field

See Also:
Constant Field Values

TIMES_NEEDED

static final java.lang.String TIMES_NEEDED
Description of the Field

See Also:
Constant Field Values

TIMES_IN_CONTEXT

static final java.lang.String TIMES_IN_CONTEXT
Description of the Field

See Also:
Constant Field Values

REFERENCE_TIMES

static final java.lang.String REFERENCE_TIMES
Description of the Field

See Also:
Constant Field Values

REFERENCE_COUNT

static final java.lang.String REFERENCE_COUNT
Description of the Field

See Also:
Constant Field Values

BASE_LEVEL_ACTIVATION

static final java.lang.String BASE_LEVEL_ACTIVATION
Description of the Field

See Also:
Constant Field Values

SPREADING_ACTIVATION

static final java.lang.String SPREADING_ACTIVATION
Description of the Field

See Also:
Constant Field Values

SOURCE_ACTIVATION

static final java.lang.String SOURCE_ACTIVATION
See Also:
Constant Field Values

ACTIVATION

static final java.lang.String ACTIVATION
Description of the Field

See Also:
Constant Field Values
Method Detail

getCreationTime

double getCreationTime()
Returns:
chunk's creation time

setCreationTime

void setCreationTime(double time)
set the creation time and pass on an event.

Parameters:
time - The new creationTime value

setTimesNeeded

void setTimesNeeded(int needed)
Sets the number of times that this chunk has been needed in a buffer other than the goal buffer. This is used in the calculation of the strengths of association. passes on an event.

Parameters:
needed - The new timesNeeded value

getTimesNeeded

int getTimesNeeded()
Return the number of times that this chunk has been needed in a buffer other than the goal buffer.

Returns:
The timesNeeded value

incrementTimesNeeded

void incrementTimesNeeded()
Description of the Method


setTimesInContext

void setTimesInContext(int context)
Set number of times this chunk has been a slot value of a chunk in the goal buffer. passes on an event.

Parameters:
context - The new timesInContext value

getTimesInContext

int getTimesInContext()
Get the number of times this chunk has been a slot value of a chunk in the goal buffer.

Returns:
The timesInContext value

incrementTimesInContext

void incrementTimesInContext()
Description of the Method


getReferences

IReferences getReferences()
The org.jactr.misc.ReferenceList class maintains an optimized list of access times and access counts. These values are used to compute the basic power-law functions of base-level decay etc. This returns the actual list, programmers should be wary not to corrupt the list.

Returns:
The referenceList value

encode

void encode(double when)
Parameters:
when -

accessed

void accessed(double time)
Is called whenever the chunk is accessed (check via a condition or modified via an action in a IProduction) ? it can only be called once per cycle since the ReferenceList maintains a listing of unique access times.

Parameters:
time - TODO

setSourceActivation

void setSourceActivation(double source)
Set the source activation of this chunk. This chunk must be a slot value of another chunk that is in an activation propogating buffer (the goal buffer for instance). This is called by the IActivationBuffer after a call to IActivationBuffer.setSourceChunk(IChunk).

Parameters:
source - The new sourceActivation value

getSourceActivation

double getSourceActivation()
returns the transient amount of source activation

Returns:
The sourceActivation value

getBaseLevelActivation

double getBaseLevelActivation()
Return the current base level activation. This is a function of the current model time and the recency and frequency of access of the chunk.

Returns:
The baseLevelActivation value

setBaseLevelActivation

void setBaseLevelActivation(double base)
Set the base-level activation. If IModel.isBaseLevelLearningEnabled() is true, this value will change on a cycle basis.

Parameters:
base - The new baseLevelActivation value

getSpreadingActivation

double getSpreadingActivation()
Get the transient amount of spreading activation to this chunk. The spreading activation passes from any chunk with a source activation != 0 to all of its associated chunks (via. Actr.chunk.four.Link).

Returns:
The spreadingActivation value

setSpreadingActivation

void setSpreadingActivation(double spread)
Sets the spreadingActivation attribute of the ISubsymbolicChunk object

Parameters:
spread - The new spreadingActivation value

setActivation

void setActivation(double act)
Set the total activation. If none of the activation learning equations are enabled, this value will be passed on to the base-level activation, and all other values will be zeroed.

Parameters:
act - The new activation value

getActivation

double getActivation()
Return the total activation (summation of base-level, spreading, and noise). The activation values are only computed once per cycle and then cached. If this call occurs and the value has not been calculated, it will be calculated, cached and then returned.

Returns:
The activation value

dispose

void dispose()
Description of the Method