|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectclarion.system.AbstractImplicitModule
public abstract class AbstractImplicitModule
This class implements an implicit module within CLARION. This class is abstract and therefore cannot be instantiated on its own.
Usage:
Any class that extends an abstract implicit module can be used in the bottom level of the CLARION subsystems. This class acts as the base foundation for building implicit modules to use in the bottom level. All modules that are used within the bottom level of CLARION MUST extend from this class.
The CLARION Library is very loose about what a user can define as an implicit module on the bottom level. As long as your user defined implicit module extends from this class, you are free to implement just about any type of structure you would like.
The following structures come pre-defined for you to use within the CLARION Library:
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.
Field Summary | |
---|---|
double |
ACTUATION_TIME
Actuation time. |
protected AbstractOutputChunk |
ChosenOutput
The index of the output node relating to the chosen output. |
double |
DECISION_TIME
Decision time. |
static double |
GLOBAL_ACTUATION_TIME
Actuation time. |
static double |
GLOBAL_DECISION_TIME
Decision time. |
static double |
GLOBAL_PERCEPTION_TIME
Perception time. |
protected DimensionValueCollection |
InputAsCollection
The input layer represented as a collection. |
protected AbstractOutputChunkCollection<? extends AbstractOutputChunk> |
Output
The output layer. |
double |
PERCEPTION_TIME
Perception time. |
Constructor Summary | |
---|---|
AbstractImplicitModule(java.util.Collection<Dimension> InputSpace,
AbstractOutputChunkCollection<? extends AbstractOutputChunk> Outputs)
Initializes an implicit module. |
Method Summary | |
---|---|
abstract void |
forwardPass()
Performs a forward pass from the input to output of the implicit module. |
AbstractOutputChunk |
getChosenOutput()
Gets the chosen output that was last provided to the implicit module. |
java.util.Collection<Dimension> |
getInput()
Gets the input nodes in the form of a dimension-value collection. |
int |
getNumInput()
Gets the number of input nodes. |
int |
getNumOutput()
Gets the number of output nodes. |
java.util.Collection<? extends AbstractOutputChunk> |
getOutput()
Gets the current output. |
AbstractOutputChunk |
getOutput(java.lang.Object ID)
Gets the output chunk with the specified ID. |
double |
getResponseTime()
Gets the response time for the implicit module. |
void |
setChosenOutput(AbstractOutputChunk chosenOut)
Sets the chosen output for this implicit module. |
void |
setInput(DimensionValueCollection input)
Sets the activations for the input layer to the specified input. |
void |
setInput(java.lang.Object ID,
Value val)
Sets the activation of the input node for the dimension with the specified ID to the activation of the specified value. |
void |
setInput(Value val)
Sets the activation of the input nodes that equal the specified value to the activation of the specified value. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected DimensionValueCollection InputAsCollection
protected AbstractOutputChunkCollection<? extends AbstractOutputChunk> Output
protected AbstractOutputChunk ChosenOutput
public static double GLOBAL_PERCEPTION_TIME
public double PERCEPTION_TIME
public static double GLOBAL_DECISION_TIME
public double DECISION_TIME
public static double GLOBAL_ACTUATION_TIME
public double ACTUATION_TIME
Constructor Detail |
---|
public AbstractImplicitModule(java.util.Collection<Dimension> InputSpace, AbstractOutputChunkCollection<? extends AbstractOutputChunk> Outputs) throws InvalidFormatException
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.
InputSpace
- The input space for the implicit module.Outputs
- The outputs for the implicit module.
InvalidFormatException
- If the input or output space contain dimensions or chunks respectively that
have the same ID.Method Detail |
---|
public java.util.Collection<Dimension> getInput()
public void setInput(DimensionValueCollection input)
input
- The input from which to set the activations on the input layer.public void setInput(Value val)
In general, this method should NOT be used from outside of the CLARION library. This method will set the activation of ANY and ALL values within the input layer that match the ID of the specified value regardless of the dimension to which they belong. This method should only be used if you know for sure that the input layer does not contain values with the same ID or you want to set ALL of the values in the input layer with the same ID to the activation of the specified value.
val
- The value related to the input nodes whose activations you wish to set.public void setInput(java.lang.Object ID, Value val)
ID
- The ID of the dimension where the value you wish to set is located.val
- The value related to the input node whose activation you wish to set.public int getNumInput()
public int getNumOutput()
public AbstractOutputChunk getOutput(java.lang.Object ID)
ID
- The ID of the output chunk to get.
public java.util.Collection<? extends AbstractOutputChunk> getOutput()
public AbstractOutputChunk getChosenOutput()
public void setChosenOutput(AbstractOutputChunk chosenOut)
chosenOut
- The chosen output.public double getResponseTime()
public abstract void forwardPass()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |