#include <SimpleSynHandler.h>

Inheritance diagram for SimpleSynHandler:

Collaboration diagram for SimpleSynHandler:

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

unsigned int	addSynapse ()
	Adds a new synapse, returns its index. More...

void	dropSynapse (unsigned int droppedSynNumber)

double	getTopSpike (unsigned int index) const

SimpleSynHandler &	operator= (const SimpleSynHandler &other)

	SimpleSynHandler ()

unsigned int	vGetNumSynapses () const

Synapse *	vGetSynapse (unsigned int i)

void	vProcess (const Eref &e, ProcPtr p)

void	vReinit (const Eref &e, ProcPtr p)

void	vSetNumSynapses (unsigned int num)

	~SimpleSynHandler ()

Public Member Functions inherited from SynHandlerBase
unsigned int	getNumSynapses () const

Synapse *	getSynapse (unsigned int i)

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	~SynHandlerBase ()

Static Public Member Functions
static const Cinfo *	initCinfo ()

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

static const Cinfo *	initCinfo ()

Private Attributes
priority_queue< SynEvent, vector< SynEvent > , CompareSynEvent >	events_

vector< Synapse >	synapses_

Detailed Description

This handles simple synapses without plasticity. It uses a priority queue to manage them. This gets inefficient for large numbers of synapses but is pretty robust.

Definition at line 47 of file SimpleSynHandler.h.

Constructor & Destructor Documentation

SimpleSynHandler::SimpleSynHandler ( )

Definition at line 57 of file SimpleSynHandler.cpp.

58 { ; }

SimpleSynHandler::~SimpleSynHandler ( )

Definition at line 60 of file SimpleSynHandler.cpp.

61 { ; }

Member Function Documentation

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

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.

Implements SynHandlerBase.

Definition at line 100 of file SimpleSynHandler.cpp.

References events_, and synapses_.

 {
     assert( index < synapses_.size() );
     events_.push( SynEvent( time, weight ) );
 }

unsigned int SimpleSynHandler::addSynapse ( )

virtual

Adds a new synapse, returns its index.

Implements SynHandlerBase.

Definition at line 138 of file SimpleSynHandler.cpp.

References synapses_.

 {
     unsigned int newSynIndex = synapses_.size();
     synapses_.resize( newSynIndex + 1 );
     synapses_[newSynIndex].setHandler( this );
     return newSynIndex;
 }

void SimpleSynHandler::dropSynapse ( unsigned int droppedSynNumber )

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.

Implements SynHandlerBase.

Definition at line 147 of file SimpleSynHandler.cpp.

References synapses_.

 {
     assert( msgLookup < synapses_.size() );
     synapses_[msgLookup].setWeight( -1.0 );
 }

double SimpleSynHandler::getTopSpike ( unsigned int index ) const

virtual

Implements SynHandlerBase.

Definition at line 107 of file SimpleSynHandler.cpp.

References events_.

 {
     if ( events_.empty() )
         return 0.0;
     return events_.top().time;
 }

const Cinfo * SimpleSynHandler::initCinfo ( )

static

Definition at line 17 of file SimpleSynHandler.cpp.

References SynHandlerBase::getNumSynapses(), SynHandlerBase::getSynapse(), Synapse::initCinfo(), SynHandlerBase::initCinfo(), SynHandlerBase::setNumSynapses(), and synHandlerCinfo.

Referenced by testCinfoFields(), testFinfoFields(), testSetGetSynapse(), testSetGetVec(), testSetRepeat(), and testSparseMsg().

 {
     static string doc[] =
     {
         "Name", "SimpleSynHandler",
         "Author", "Upi Bhalla",
         "Description",
         "The SimpleSynHandler handles simple synapses without plasticity. "
         "It uses a priority queue to manage them."
     };
 
     static FieldElementFinfo< SynHandlerBase, Synapse > synFinfo(
         "synapse",
         "Sets up field Elements for synapse",
         Synapse::initCinfo(),
         &SynHandlerBase::getSynapse,
         &SynHandlerBase::setNumSynapses,
         &SynHandlerBase::getNumSynapses
     );
 
     static Finfo* synHandlerFinfos[] = {
         &synFinfo           // FieldElement
     };
 
     static Dinfo< SimpleSynHandler > dinfo;
     static Cinfo synHandlerCinfo (
         "SimpleSynHandler",
         SynHandlerBase::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:

SimpleSynHandler & SimpleSynHandler::operator= ( const SimpleSynHandler & other )

Definition at line 63 of file SimpleSynHandler.cpp.

References events_, and synapses_.

 {
     synapses_ = ssh.synapses_;
     for ( vector< Synapse >::iterator
                     i = synapses_.begin(); i != synapses_.end(); ++i )
             i->setHandler( this );
 
     // For no apparent reason, priority queues don't have a clear operation.
     while( !events_.empty() )
         events_.pop();
 
     return *this;
 }

unsigned int SimpleSynHandler::vGetNumSynapses ( ) const

virtual

Implements SynHandlerBase.

Definition at line 85 of file SimpleSynHandler.cpp.

References synapses_.

 {
     return synapses_.size();
 }

Synapse * SimpleSynHandler::vGetSynapse ( unsigned int i )

virtual

Implements SynHandlerBase.

Definition at line 90 of file SimpleSynHandler.cpp.

References dummy, and synapses_.

 {
     static Synapse dummy;
     if ( i < synapses_.size() )
         return &synapses_[i];
     cout << "Warning: SimpleSynHandler::getSynapse: index: " << i <<
         " is out of range: " << synapses_.size() << endl;
     return &dummy;
 }

void SimpleSynHandler::vProcess	(	const Eref &	e,
		ProcPtr	p
	)

virtual

Implements SynHandlerBase.

Definition at line 114 of file SimpleSynHandler.cpp.

References SynHandlerBase::activationOut(), ProcInfo::currTime, ProcInfo::dt, and events_.

 {
     double activation = 0.0;
     while( !events_.empty() && events_.top().time <= p->currTime ) {
         // Send out weight / dt for every spike
         //      Since it is an impulse active only for one dt,
         //      need to send it divided by dt.
         // Can connect activation to SynChan (double exp)
         //      or to LIF as an impulse to voltage.
         // See: http://www.genesis-sim.org/GENESIS/Hyperdoc/Manual-26.html#synchan
         activation += events_.top().weight / p->dt;
         events_.pop();
     }
     if ( activation != 0.0 )
         SynHandlerBase::activationOut()->send( e, activation );
 }

Here is the call graph for this function:

void SimpleSynHandler::vReinit	(	const Eref &	e,
		ProcPtr	p
	)

virtual

Implements SynHandlerBase.

Definition at line 131 of file SimpleSynHandler.cpp.

References events_.

 {
     // For no apparent reason, priority queues don't have a clear operation.
     while( !events_.empty() )
         events_.pop();
 }

void SimpleSynHandler::vSetNumSynapses ( unsigned int num )

virtual

Implements SynHandlerBase.

Definition at line 77 of file SimpleSynHandler.cpp.

References synapses_.

 {
     unsigned int prevSize = synapses_.size();
     synapses_.resize( v );
     for ( unsigned int i = prevSize; i < v; ++i )
         synapses_[i].setHandler( this );
 }

Member Data Documentation

priority_queue< SynEvent, vector< SynEvent >, CompareSynEvent > SimpleSynHandler::events_

private

Definition at line 71 of file SimpleSynHandler.h.

Referenced by addSpike(), getTopSpike(), operator=(), vProcess(), and vReinit().

vector< Synapse > SimpleSynHandler::synapses_

private

Definition at line 70 of file SimpleSynHandler.h.

Referenced by addSpike(), addSynapse(), dropSynapse(), operator=(), vGetNumSynapses(), vGetSynapse(), and vSetNumSynapses().

The documentation for this class was generated from the following files:

moose-core/synapse/SimpleSynHandler.h
moose-core/synapse/SimpleSynHandler.cpp

Public Member Functions

Static Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation