edu.jhu.mb.ernst.model.synapse

Class ModulatedSynapseImp

java.lang.Object

edu.jhu.mb.ernst.model.synapse.ModulatedSynapseImp

All Implemented Interfaces:

ModulatedSynapse, Synapse, Comparable<Synapse>

public final class ModulatedSynapseImp
extends Object
implements ModulatedSynapse

Modulated Synapse implementation.

This implementation optimizes read performance at the expense of write performance. The accessor methods are fast but the modulation factor mutator methods are slow. Use this implementation when the modulation factors are changed infrequently relative to the number of times the modulated weight is accessed.

This implementation conserves memory by using lazy initialization and by releasing memory allocated to internal data structures when empty.

ModulatedSynapseImp can be used as the default implementation for accessor interface Synapse because its memory consumption and read access performance is similar to MutableSynapseImp when modulation is not used.

Since:

2012-02-19

Version:

$Date: 2012-04-15 13:47:26 -0500 (Sun, 15 Apr 2012) $ $Rev: 9 $ $Author: croft $

Author:

David Wallace Croft

See Also:

MutableSynapseImp

Constructor Summary

Constructors

Constructor and Description
ModulatedSynapseImp(int targetNeuronIndex, byte type, float unmodulatedWeight)

Method Summary

Methods

Modifier and Type	Method and Description
void	clearModulationFactors() The weight is immediately restored to the unmodulated value.
int	compareTo(Synapse other)
int	getTargetNeuronIndex()
byte	getType()
float	getWeight()
void	setModulationFactor(String name, Double peakFactor) The modulation factor is applied immediately to the weight.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ModulatedSynapseImp

public ModulatedSynapseImp(int targetNeuronIndex,
                   byte type,
                   float unmodulatedWeight)

Method Detail

getTargetNeuronIndex

public int getTargetNeuronIndex()

Specified by:

getTargetNeuronIndex in interface Synapse

getType

public byte getType()

Specified by:

getType in interface Synapse

getWeight

public float getWeight()

Specified by:

getWeight in interface Synapse

clearModulationFactors

public void clearModulationFactors()

Description copied from interface: ModulatedSynapse

The weight is immediately restored to the unmodulated value. All previous modulation factors are permanently forgotten.

Specified by:

clearModulationFactors in interface ModulatedSynapse

setModulationFactor

public void setModulationFactor(String name,
                       Double peakFactor)

Description copied from interface: ModulatedSynapse

The modulation factor is applied immediately to the weight.

Specified by:

setModulationFactor in interface ModulatedSynapse

compareTo

public int compareTo(Synapse other)

Specified by:

compareTo in interface Comparable<Synapse>

toString

public String toString()

Overrides:

toString in class Object