AnimatLab  2
Test
PropagatedSpikeBuffer Class Reference

Schedule/Store spikes to be delivered at a later point in the simulation. More...

#include <PropagatedSpikeBuffer.h>

+ Collaboration diagram for PropagatedSpikeBuffer:

Classes

class  const_iterator
 Iterator to loop over the scheduled spikes at a certain delay. More...
 
struct  StgNode
 Structure which stores the index of the spike target group and a pointer to the next element in various lists. More...
 

Public Member Functions

 PropagatedSpikeBuffer (int minDelay, int maxDelay, int chunkSize=PROPAGATED_SPIKE_BUFFER_CHUNK_SIZE)
 New spike buffer. More...
 
virtual ~PropagatedSpikeBuffer ()
 Destructor: Deletes all scheduled spikes.
 
const_iterator beginSpikeTargetGroups (int stepOffset=0)
 Returns an iterator to loop over all scheduled spike target groups. More...
 
const_iterator endSpikeTargetGroups ()
 End iterator corresponding to beginSynapseGroups.
 
size_t length ()
 Return the actual length of the buffer.
 
void nextTimeStep ()
 Must be called to tell the buffer that it should move on to the next time step.
 
void reset (int minDelay, int maxDelay)
 Must be called at the begin (reset) of a simulation. More...
 
void scheduleSpikeTargetGroup (spikegroupid_t stg, delaystep_t delay)
 Schedule a group of spike targets to get a spike at time t + delay. More...
 

Detailed Description

Schedule/Store spikes to be delivered at a later point in the simulation.

Definition at line 35 of file PropagatedSpikeBuffer.h.

Constructor & Destructor Documentation

PropagatedSpikeBuffer::PropagatedSpikeBuffer ( int  minDelay,
int  maxDelay,
int  chunkSize = PROPAGATED_SPIKE_BUFFER_CHUNK_SIZE 
)

New spike buffer.

Parameters
minDelayMinimum delay (in number of time steps) the buffer can handle
maxDelayMaximum delay (in number of time steps) the buffer can handle
chunkSizeConstant used for internal memory management. Should increase with increasing number of synapses and exptected number of spikes.

Definition at line 13 of file PropagatedSpikeBuffer.cpp.

References reset().

+ Here is the call graph for this function:

Member Function Documentation

const_iterator PropagatedSpikeBuffer::beginSpikeTargetGroups ( int  stepOffset = 0)
inline

Returns an iterator to loop over all scheduled spike target groups.

Parameters
stepOffsetDetermines at which position ( current timestep + stepOffset ) the spike target groups are read of

Definition at line 93 of file PropagatedSpikeBuffer.h.

References length().

+ Here is the call graph for this function:

void PropagatedSpikeBuffer::reset ( int  minDelay,
int  maxDelay 
)

Must be called at the begin (reset) of a simulation.

Parameters
minDelayMinimum delay (in number of time steps) the buffer can handle
maxDelayMaximum delay (in number of time steps) the buffer can handle

Definition at line 67 of file PropagatedSpikeBuffer.cpp.

Referenced by PropagatedSpikeBuffer().

+ Here is the caller graph for this function:

void PropagatedSpikeBuffer::scheduleSpikeTargetGroup ( spikegroupid_t  stg,
delaystep_t  delay 
)

Schedule a group of spike targets to get a spike at time t + delay.

Parameters
stgThe identifier of the spike target group to be used as identifier in SpikeTargetGroupPool::beginSpikeTarget( stg )
delayThe number of time steps to delay the deliver of the spike

Definition at line 115 of file PropagatedSpikeBuffer.cpp.


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