verve::Connection Class Reference

A synaptic connection between two Neurons. More...

#include <Connection.h>

Inheritance diagram for verve::Connection:

verve::TDConnection List of all members.

Public Member Functions

VERVE_DECL Connection (Neuron *preNeuron, Neuron *postNeuron)
virtual VERVE_DECL ~Connection ()
virtual VERVE_DECL void VERVE_CALL resetShortTermMemory ()
virtual VERVE_DECL void VERVE_CALL setWeight (real value)
virtual VERVE_DECL real VERVE_CALL getWeight () const
virtual VERVE_DECL void VERVE_CALL addToWeight (real delta)
virtual VERVE_DECL Neuron
*VERVE_CALL 
getPreNeuron () const
virtual VERVE_DECL Neuron
*VERVE_CALL 
getPostNeuron () const

Protected Attributes

real mWeight
NeuronmPreNeuron
NeuronmPostNeuron

Detailed Description

A synaptic connection between two Neurons.

Definition at line 34 of file Connection.h.


Constructor & Destructor Documentation

verve::Connection::Connection Neuron preNeuron,
Neuron postNeuron
 

The pre-synaptic and post-synaptic Neuron pointers here must be non-NULL.

Definition at line 29 of file Connection.cpp.

References mPostNeuron, mPreNeuron, and mWeight.

verve::Connection::~Connection  )  [virtual]
 

Deallocates any dynamically allocated memory.

This object should never be destroyed by the user calling 'delete' because memory allocated within the DLL should also be destroyed within the DLL.

Definition at line 42 of file Connection.cpp.


Member Function Documentation

void verve::Connection::addToWeight real  delta  )  [virtual]
 

Adds a value to the weight.

Automatically updates the input sums of all post-synaptic Neurons.

Definition at line 76 of file Connection.cpp.

References verve::Neuron::addToSynapticInputSum(), verve::Neuron::getFiringRate(), mPostNeuron, mPreNeuron, and mWeight.

Referenced by verve::TDConnection::applyTDLearning().

Neuron * verve::Connection::getPostNeuron  )  const [virtual]
 

Returns the post-synaptic Neuron.

Definition at line 101 of file Connection.cpp.

References mPostNeuron.

Neuron * verve::Connection::getPreNeuron  )  const [virtual]
 

Returns the pre-synaptic Neuron.

Definition at line 96 of file Connection.cpp.

References mPreNeuron.

real verve::Connection::getWeight  )  const [virtual]
 

Returns the weight.

Definition at line 50 of file Connection.cpp.

References mWeight.

void verve::Connection::resetShortTermMemory  )  [virtual]
 

Resets temporary dynamics without affecting learned parameters.

Reimplemented in verve::TDConnection.

Definition at line 46 of file Connection.cpp.

Referenced by verve::TDConnection::resetShortTermMemory().

void verve::Connection::setWeight real  value  )  [virtual]
 

Sets the weight.

Automatically updates the input sums of all post-synaptic Neurons.

Definition at line 55 of file Connection.cpp.

References verve::Neuron::addToSynapticInputSum(), verve::Neuron::getFiringRate(), mPostNeuron, mPreNeuron, and mWeight.

Referenced by verve::Projection::setInitialConnectionWeight().


Member Data Documentation

Neuron* verve::Connection::mPostNeuron [protected]
 

The post-synaptic Neuron.

Definition at line 81 of file Connection.h.

Referenced by addToWeight(), Connection(), getPostNeuron(), verve::TDConnection::increaseETrace(), and setWeight().

Neuron* verve::Connection::mPreNeuron [protected]
 

The pre-synaptic Neuron.

Definition at line 78 of file Connection.h.

Referenced by addToWeight(), Connection(), getPreNeuron(), verve::TDConnection::increaseETrace(), and setWeight().

real verve::Connection::mWeight [protected]
 

The Connection weight.

Definition at line 75 of file Connection.h.

Referenced by addToWeight(), Connection(), getWeight(), and setWeight().


The documentation for this class was generated from the following files:
Generated on Tue Jan 24 21:46:39 2006 for Verve by  doxygen 1.4.6-NO