org.jactr.core.module.declarative.six

Class DefaultDeclarativeModule6

java.lang.Object

org.jactr.core.utils.DefaultAdaptable

org.jactr.core.module.AbstractModule

org.jactr.core.module.declarative.basic.AbstractDeclarativeModule

org.jactr.core.module.declarative.basic.DefaultDeclarativeModule

org.jactr.core.module.declarative.six.DefaultDeclarativeModule6

All Implemented Interfaces:

IDeclarativeModule5, IDeclarativeModule4, IDeclarativeModule, IRemovableDeclarativeModule, IModule, IAdaptable, IInitializable, IInstallable, IParameterized

public class DefaultDeclarativeModule6
extends DefaultDeclarativeModule
implements IDeclarativeModule, IDeclarativeModule4, IDeclarativeModule5, IParameterized

Default declarative module for ACT-R 6.
This module uses the IDeclarativeConfigurator to set the chunk's various equations (IBaseLevelActivationEquation, ISpreadingActivationEquation, IRandomActivationEquation). Clients extending this should be sure to delegate to the original configurator as to keep this functionality ( #getConfigurator()).

Parameters

• EnablePartialMatching : Turn on partial matching in searches (values:true/false. default: false)
• ActivationNoise : Transient noise added to activations (value: numeric. default: 0) (note: random module must be present)
• PermanentActivationNoise : Permanent noise added to activations (value: numeric. default:0) (note: random module must be present)
• BaseLevelConstant : Constant added to base level activations (value: numeric. default: 0)
• MismatchPenalty : Penalty applied to all partial match scores on a per mismatch basis (value: numeric. default: 0) (partial matching must be enabled)
• MaximumSimilarity : Similarity score between two perfectly matched slot values (value: numeric. default:0)
• MaximumDifference : Similarity score between two perfectly mismatched slot values (value: numeric. default:0)

Author:

harrison

See Also:

http://jactr.org/node/87

Field Summary

Fields

Modifier and Type	Field and Description
protected double	_activationNoise
protected double	_baseLevelConstant
protected double	_maximumDifference
protected double	_maximumSimilarity
protected double	_mismatchPenalty
protected boolean	_partialMatchingEnabled
protected double	_permanentActivationNoise
protected java.util.Map<Pair,java.lang.Double>	_similarities

Fields inherited from class org.jactr.core.module.declarative.basic.DefaultDeclarativeModule

_allChunks, _allChunkTypes, _chunkLock, _chunkTypeLock, _encodeChunksOnRemove, _searchSystem, CHUNK_CONFIGURATOR_PARAM, CHUNK_FACTORY_PARAM, CHUNK_NAMER_PARAM, CHUNK_TYPE_CONFIGURATOR_PARAM, CHUNK_TYPE_FACTORY_PARAM, CHUNK_TYPE_NAMER_PARAM, SUBSYMBOLIC_CHUNK_FACTORY_PARAM, SUBSYMBOLIC_CHUNK_TYPE_FACTORY_PARAM, SYMBOLIC_CHUNK_FACTORY_PARAM, SYMBOLIC_CHUNK_TYPE_FACTORY_PARAM

Fields inherited from class org.jactr.core.module.declarative.basic.AbstractDeclarativeModule

_activationSorter, SUSPEND_DISPOSAL_KEY

Fields inherited from interface org.jactr.core.module.declarative.four.IDeclarativeModule4

ACTIVATION_NOISE, BASE_LEVEL_CONSTANT, PARTIAL_MATCHING, PERMANENT_ACTIVATION_NOISE

Fields inherited from interface org.jactr.core.module.declarative.five.IDeclarativeModule5

MAXIMUM_DIFFERENCE, MAXIMUM_SIMILARITY, MISMATCH_PENALTY

Constructor Summary

Constructors

Constructor and Description
DefaultDeclarativeModule6()

Method Summary

Modifier and Type	Method and Description
protected void	configure(IChunk newChunk) make sure that the appropriate activation equations are configured for the chunks
void	dispose() release any resources.
double	getActivationNoise()
double	getBaseLevelConstant()
double	getMaximumDifference()
double	getMaximumSimilarity()
double	getMismatchPenalty() return the activation penalty for mismatches this parameter only applies if partial matching is enabled
java.lang.String	getParameter(java.lang.String key) return parameter value - null if not defined.
double	getPermanentActivationNoise()
java.util.Collection<java.lang.String>	getSetableParameters() Return list of all parameters that can be set.
double	getSimilarity(java.lang.Object one, java.lang.Object two)
boolean	isPartialMatchingEnabled()
void	setActivationNoise(double noise)
void	setBaseLevelConstant(double base)
void	setMaximumDifference(double maxDiff)
void	setMaximumSimilarity(double maxSim)
void	setMismatchPenalty(double mismatch) set the activation penalty for a mismatched slot value
void	setParameter(java.lang.String key, java.lang.String value) Set the named parameter
void	setPartialMatchingEnabled(boolean enable)
void	setPermanentActivationNoise(double noise)
void	setSimilarity(java.lang.Object one, java.lang.Object two, double sim)

Methods inherited from class org.jactr.core.module.declarative.basic.DefaultDeclarativeModule

addChunkInternal, addChunkTypeInternal, findExactMatches, findExactMatchesInternal, findPartialMatches, findPartialMatchesInternal, getChunkInternal, getChunksInternal, getChunkTypeInternal, getChunkTypesInternal, getNumberOfChunks, getPossibleParameters, initialize, removeChunk, removeChunkInternal, reset

Methods inherited from class org.jactr.core.module.declarative.basic.AbstractDeclarativeModule

addChunk, addChunkType, addListener, configure, copyChunk, copyChunk, copyChunkInternal, createChunk, createChunkInternal, createChunkType, createChunkType, createChunkTypeInternal, deferredEncode, deferredEncode, dispatch, dispose, disposeInternal, fireChunkAdded, fireChunkCreated, fireChunkDisposed, fireChunkRemoved, fireChunksMerged, fireChunkTypeAdded, fireChunkTypeCreated, fireChunkTypeDisposed, fireChunkTypesMerged, flush, getAssociativeLinkageSystem, getBusyChunk, getChunk, getChunkConfigurator, getChunkFactory, getChunkNamer, getChunks, getChunkType, getChunkTypeConfigurator, getChunkTypeFactory, getChunkTypeNamer, getChunkTypes, getEmptyChunk, getErrorChunk, getFreeChunk, getFullChunk, getNewChunk, getRequestedChunk, getSubsymbolicChunkFactory, getSubsymbolicChunkTypeFactory, getSymbolicChunkFactory, getSymbolicChunkTypeFactory, getUnrequestedChunk, hasListeners, install, isDisposalSuspended, merge, mergeChunksInternal, processPendingDisposals, processPendingEncodingAndDisposals, processPendingEncodings, removeListener, setAssociativeLinkageSystem, setChunkConfigurator, setChunkFactory, setChunkNamer, setChunkTypeConfigurator, setChunkTypeFactory, setChunkTypeNamer, setDisposalSuspended, setSubsymbolicChunkFactory, setSubsymbolicChunkTypeFactory, setSymbolicChunkFactory, setSymbolicChunkTypeFactory, uninstall, willEncode

Methods inherited from class org.jactr.core.module.AbstractModule

createBuffers, delayedFuture, delayedFuture, getExecutor, getModel, getName, getSafeName, immediateFuture, immediateReturn, setExecutor

Methods inherited from class org.jactr.core.utils.DefaultAdaptable

addAdapterFactory, getAdapter, removeAdapterFactory

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.jactr.core.module.declarative.IDeclarativeModule

addChunk, addChunkType, addListener, copyChunk, copyChunk, createChunk, createChunkType, createChunkType, dispose, findExactMatches, findPartialMatches, flush, getAssociativeLinkageSystem, getBusyChunk, getChunk, getChunks, getChunkType, getChunkTypes, getEmptyChunk, getErrorChunk, getFreeChunk, getFullChunk, getNewChunk, getNumberOfChunks, getRequestedChunk, getUnrequestedChunk, removeListener, setAssociativeLinkageSystem, willEncode

Methods inherited from interface org.jactr.core.module.IModule

getModel, getName, initialize, install, reset

Methods inherited from interface org.jactr.core.utils.IInstallable

uninstall

Methods inherited from interface org.jactr.core.utils.IAdaptable

getAdapter

Methods inherited from interface org.jactr.core.utils.parameter.IParameterized

getPossibleParameters

Field Detail

_activationNoise

protected double _activationNoise

_permanentActivationNoise

protected double _permanentActivationNoise

_partialMatchingEnabled

protected boolean _partialMatchingEnabled

_mismatchPenalty

protected double _mismatchPenalty

_baseLevelConstant

protected double _baseLevelConstant

_maximumSimilarity

protected double _maximumSimilarity

_maximumDifference

protected double _maximumDifference

_similarities

protected java.util.Map<Pair,java.lang.Double> _similarities

Constructor Detail

DefaultDeclarativeModule6

public DefaultDeclarativeModule6()

Method Detail

configure

protected void configure(IChunk newChunk)

make sure that the appropriate activation equations are configured for the chunks

Overrides:

configure in class AbstractDeclarativeModule

dispose

public void dispose()

Description copied from interface: IModule

release any resources. this should only be called by the model during its own dispose method (assuming that this module is still installed) and should not result in the propogation of ANY events. The module should dispose of all its resources, including buffers

Specified by:

dispose in interface IModule

Overrides:

dispose in class DefaultDeclarativeModule

getActivationNoise

public double getActivationNoise()

Specified by:

getActivationNoise in interface IDeclarativeModule4

getPermanentActivationNoise

public double getPermanentActivationNoise()

Specified by:

getPermanentActivationNoise in interface IDeclarativeModule4

isPartialMatchingEnabled

public boolean isPartialMatchingEnabled()

Specified by:

isPartialMatchingEnabled in interface IDeclarativeModule4

setActivationNoise

public void setActivationNoise(double noise)

Specified by:

setActivationNoise in interface IDeclarativeModule4

setPartialMatchingEnabled

public void setPartialMatchingEnabled(boolean enable)

Specified by:

setPartialMatchingEnabled in interface IDeclarativeModule4

setPermanentActivationNoise

public void setPermanentActivationNoise(double noise)

Specified by:

setPermanentActivationNoise in interface IDeclarativeModule4

getMismatchPenalty

public double getMismatchPenalty()

Description copied from interface: IDeclarativeModule4

return the activation penalty for mismatches this parameter only applies if partial matching is enabled

Specified by:

getMismatchPenalty in interface IDeclarativeModule5

Specified by:

getMismatchPenalty in interface IDeclarativeModule4

Returns:

The MismatchPenalty value

setMismatchPenalty

public void setMismatchPenalty(double mismatch)

Description copied from interface: IDeclarativeModule4

set the activation penalty for a mismatched slot value

Specified by:

setMismatchPenalty in interface IDeclarativeModule5

Specified by:

setMismatchPenalty in interface IDeclarativeModule4

getMaximumDifference

public double getMaximumDifference()

Specified by:

getMaximumDifference in interface IDeclarativeModule5

getMaximumSimilarity

public double getMaximumSimilarity()

Specified by:

getMaximumSimilarity in interface IDeclarativeModule5

setMaximumDifference

public void setMaximumDifference(double maxDiff)

Specified by:

setMaximumDifference in interface IDeclarativeModule5

setMaximumSimilarity

public void setMaximumSimilarity(double maxSim)

Specified by:

setMaximumSimilarity in interface IDeclarativeModule5

getBaseLevelConstant

public double getBaseLevelConstant()

Specified by:

getBaseLevelConstant in interface IDeclarativeModule4

setBaseLevelConstant

public void setBaseLevelConstant(double base)

Specified by:

setBaseLevelConstant in interface IDeclarativeModule4

getSimilarity

public double getSimilarity(java.lang.Object one,
                            java.lang.Object two)

Specified by:

getSimilarity in interface IDeclarativeModule5

setSimilarity

public void setSimilarity(java.lang.Object one,
                          java.lang.Object two,
                          double sim)

Specified by:

setSimilarity in interface IDeclarativeModule5

getParameter

public java.lang.String getParameter(java.lang.String key)

Description copied from interface: IParameterized

return parameter value - null if not defined.

Specified by:

getParameter in interface IParameterized

Overrides:

getParameter in class DefaultDeclarativeModule

Parameters:

key - Description of the Parameter

Returns:

The parameter value

See Also:

IParameterized.getParameter(java.lang.String)

getSetableParameters

public java.util.Collection<java.lang.String> getSetableParameters()

Description copied from interface: IParameterized

Return list of all parameters that can be set.

Specified by:

getSetableParameters in interface IParameterized

Overrides:

getSetableParameters in class DefaultDeclarativeModule

Returns:

The setableParameters value

See Also:

IParameterized.getSetableParameters()

setParameter

public void setParameter(java.lang.String key,
                         java.lang.String value)

Description copied from interface: IParameterized

Set the named parameter

Specified by:

setParameter in interface IParameterized

Overrides:

setParameter in class DefaultDeclarativeModule

See Also:

IParameterized.setParameter(java.lang.String, java.lang.String)