#include <SynHandlerBase.h>

Inheritance diagram for SynHandlerBase:

Collaboration diagram for SynHandlerBase:

Public Member Functions
virtual void	addSpike (unsigned int index, double time, double weight)=0

virtual unsigned int	addSynapse ()=0

virtual void	dropSynapse (unsigned int droppedSynNumber)=0

unsigned int	getNumSynapses () const

Synapse *	getSynapse (unsigned int i)

virtual double	getTopSpike (unsigned int index) const =0

void	process (const Eref &e, ProcPtr p)

bool	rangeWarning (const string &field, double value)

void	reinit (const Eref &e, ProcPtr p)

void	setNumSynapses (unsigned int num)

	SynHandlerBase ()

virtual unsigned int	vGetNumSynapses () const =0

virtual Synapse *	vGetSynapse (unsigned int i)=0

virtual void	vProcess (const Eref &e, ProcPtr p)=0

virtual void	vReinit (const Eref &e, ProcPtr p)=0

virtual void	vSetNumSynapses (unsigned int num)=0

virtual	~SynHandlerBase ()

Static Public Member Functions
static SrcFinfo1< double > *	activationOut ()

static const Cinfo *	initCinfo ()

Detailed Description

This is a pure virtual base class for accessing and handling synapses. It provides a uniform interface so that all classes that use synapses can do so without duplication. The derived classes have the responsibility of handling the synaptic events as well as possible return events from the parent.

Definition at line 22 of file SynHandlerBase.h.

Constructor & Destructor Documentation

SynHandlerBase::SynHandlerBase ( )

Definition at line 94 of file SynHandlerBase.cpp.

 {
     ;
 }

SynHandlerBase::~SynHandlerBase ( )

virtual

Definition at line 99 of file SynHandlerBase.cpp.

 {
     ;
 }

Member Function Documentation

SrcFinfo1< double > * SynHandlerBase::activationOut ( )

static

Definition at line 16 of file SynHandlerBase.cpp.

Referenced by initCinfo(), SeqSynHandler::vProcess(), GraupnerBrunel2012CaPlasticitySynHandler::vProcess(), SimpleSynHandler::vProcess(), and STDPSynHandler::vProcess().

 {
     static SrcFinfo1< double > activationOut(
         "activationOut",
         "Sends out level of activation on all synapses converging to "
         "this SynHandler"
     );
     return &activationOut;
 }

Here is the caller graph for this function:

virtual void SynHandlerBase::addSpike	(	unsigned int	index,
		double	time,
		double	weight
	)

pure virtual

Record arrival of a new spike event. The 'time' is time for eventual arrival of the spike, and is typically well in the future. The index specifies which synapse the spike came to.

Implemented in STDPSynHandler, SimpleSynHandler, GraupnerBrunel2012CaPlasticitySynHandler, and SeqSynHandler.

Referenced by Synapse::addSpike().

Here is the caller graph for this function:

virtual unsigned int SynHandlerBase::addSynapse ( )

pure virtual

Adds a new synapse, returns its index. This is triggered by addMsg of inputs to the child synapse. The SynHandler has to ensure that we have enough synapses allocated to handle the new message, and the return value is used so that the new message knows the fieldIndex to send the message to.

Implemented in STDPSynHandler, SimpleSynHandler, GraupnerBrunel2012CaPlasticitySynHandler, and SeqSynHandler.

Referenced by Synapse::addMsgCallback().

Here is the caller graph for this function:

virtual void SynHandlerBase::dropSynapse ( unsigned int droppedSynNumber )

pure virtual

Drops an existing synapse, triggered by deleteMsg of an input to the child synapse. This is a little messy because we can't change the indices of the other synapses. The Handler has to figure out how to handle the 'holes' in its array of synapses.

Implemented in STDPSynHandler, SimpleSynHandler, GraupnerBrunel2012CaPlasticitySynHandler, and SeqSynHandler.

Referenced by Synapse::dropMsgCallback().

Here is the caller graph for this function:

unsigned int SynHandlerBase::getNumSynapses ( ) const

Returns number of synapses defined.

Definition at line 109 of file SynHandlerBase.cpp.

References vGetNumSynapses().

Referenced by SimpleSynHandler::initCinfo(), SeqSynHandler::initCinfo(), initCinfo(), STDPSynHandler::initCinfo(), GraupnerBrunel2012CaPlasticitySynHandler::initCinfo(), and testSetGetVec().

 {
     return vGetNumSynapses();
 }

Here is the call graph for this function:

Here is the caller graph for this function:

Synapse * SynHandlerBase::getSynapse ( unsigned int i )

Gets specified synapse

Definition at line 114 of file SynHandlerBase.cpp.

References vGetSynapse().

Referenced by SimpleSynHandler::initCinfo(), SeqSynHandler::initCinfo(), STDPSynHandler::initCinfo(), and GraupnerBrunel2012CaPlasticitySynHandler::initCinfo().

 {
     return vGetSynapse( i );
 }

Here is the call graph for this function:

Here is the caller graph for this function:

virtual double SynHandlerBase::getTopSpike ( unsigned int index ) const

pure virtual

Implemented in STDPSynHandler, SimpleSynHandler, GraupnerBrunel2012CaPlasticitySynHandler, and SeqSynHandler.

Referenced by Synapse::getTopSpike().

Here is the caller graph for this function:

const Cinfo * SynHandlerBase::initCinfo ( )

static

These are the base set of fields for any object managing synapses. Note that these are duplicated in SynChanBase: if you change anything here it must also be reflected there.

Definition at line 31 of file SynHandlerBase.cpp.

References activationOut(), getNumSynapses(), Neutral::initCinfo(), process(), reinit(), setNumSynapses(), and synHandlerCinfo.

Referenced by SimpleSynHandler::initCinfo(), SeqSynHandler::initCinfo(), STDPSynHandler::initCinfo(), and GraupnerBrunel2012CaPlasticitySynHandler::initCinfo().

 {
     static ValueFinfo< SynHandlerBase, unsigned int > numSynapses(
         "numSynapses",
         "Number of synapses on SynHandler. Duplicate field for num_synapse",
         &SynHandlerBase::setNumSynapses,
         &SynHandlerBase::getNumSynapses
     );
     static DestFinfo process( "process",
                               "Handles 'process' call. Checks if any spike events are due for"
                               "handling at this timestep, and does learning rule stuff if needed",
                               new ProcOpFunc< SynHandlerBase >(& SynHandlerBase::process ) );
     static DestFinfo reinit( "reinit",
                              "Handles 'reinit' call. Initializes all the synapses.",
                              new ProcOpFunc< SynHandlerBase >(& SynHandlerBase::reinit ) );
 
     static Finfo* processShared[] =
     {
         &process, &reinit
     };
     static SharedFinfo proc( "proc",
                              "Shared Finfo to receive Process messages from the clock.",
                              processShared, sizeof( processShared ) / sizeof( Finfo* )
                            );
 
     static Finfo* synHandlerFinfos[] =
     {
         &numSynapses,       // Value
         activationOut(),    // SrcFinfo
         &proc,              // SharedFinfo
     };
 
     static string doc[] =
     {
         "Name", "SynHandlerBase",
         "Author", "Upi Bhalla",
         "Description",
         "Base class for handling synapse arrays converging onto a given "
         "channel or integrate-and-fire neuron. This class provides the "
         "interface for channels/intFires to connect to a range of synapse "
         "types, including simple synapses, synapses with different "
         "plasticity rules, and variants yet to be implemented. "
     };
     static ZeroSizeDinfo< int > dinfo;
     static Cinfo synHandlerCinfo (
         "SynHandlerBase",
         Neutral::initCinfo(),
         synHandlerFinfos,
         sizeof( synHandlerFinfos ) / sizeof ( Finfo* ),
         &dinfo,
         doc,
         sizeof( doc ) / sizeof( string )
     );
 
     return &synHandlerCinfo;
 }

Here is the call graph for this function:

Here is the caller graph for this function:

void SynHandlerBase::process	(	const Eref &	e,
		ProcPtr	p
	)

Definition at line 119 of file SynHandlerBase.cpp.

References vProcess().

Referenced by initCinfo().

 {
     vProcess( e, p );
 }

Here is the call graph for this function:

Here is the caller graph for this function:

bool SynHandlerBase::rangeWarning	(	const string &	field,
		double	value
	)

A utility function to check for assignment to fields that must be > 0

Definition at line 129 of file SynHandlerBase.cpp.

References RANGE.

Referenced by GraupnerBrunel2012CaPlasticitySynHandler::setTauCa(), STDPSynHandler::setTauMinus(), STDPSynHandler::setTauPlus(), and GraupnerBrunel2012CaPlasticitySynHandler::setTauSyn().

 {
     if ( value < RANGE )
     {
         cout << "Warning: Ignored attempt to set " << field <<
              " of SynHandler " <<
              // c->target().e->name() <<
              " to less than " << RANGE << endl;
         return 1;
     }
     return 0;
 }