SpikeDelay.h

Go to the documentation of this file.

/* 
* Copyright 2014-2018 Friedemann Zenke
*
* This file is part of Auryn, a simulation package for plastic
* spiking neural networks.
* 
* Auryn is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
* 
* Auryn is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
* GNU General Public License for more details.
* 
* You should have received a copy of the GNU General Public License
* along with Auryn.  If not, see <http://www.gnu.org/licenses/>.
*
* If you are using Auryn or parts of it for your work please cite:
* Zenke, F. and Gerstner, W., 2014. Limits to high-speed simulations 
* of spiking neural networks using general-purpose computers. 
* Front Neuroinform 8, 76. doi: 10.3389/fninf.2014.00076
*/

#ifndef SPIKEDELAY_H_
#define SPIKEDELAY_H_

#include "auryn_definitions.h"
#include "AurynVector.h"
#include <vector>

#include <boost/serialization/utility.hpp>
#include <boost/serialization/split_member.hpp>

namespace auryn {


class SpikeDelay
{
        private:
                friend class boost::serialization::access;
                template<class Archive>
                void serialize(Archive & ar, const unsigned int version)
                {
                        for (unsigned int i = 0 ; i < ndelay ; ++i ) {
                                SpikeContainer * sc = get_spikes(i);
                                ar & *sc;
                        }

                        for (unsigned int i = 0 ; i < ndelay ; ++i ) {
                                AttributeContainer * ac = get_attributes(i);
                                ar & *ac;
                        }
                }

                SpikeContainer ** delaybuf;
                AttributeContainer ** attribbuf;

                int numSpikeAttributes;

                static AurynTime * clock_ptr;

                unsigned int ndelay;
                void free();

        public:


                SpikeDelay( int delaysteps=MINDELAY );

                virtual ~SpikeDelay();

                void set_delay( int delay );

                int get_delay( );

                void set_clock_ptr(AurynTime * clock);

                void insert_spike(NeuronID i, AurynTime ahead); 

                void insert_spike_and_attrib(NeuronID i, AurynState attr, AurynTime ahead); 

                void push_back(NeuronID i); 

                void push_back(NeuronID i, AurynState attr); 

                void push_back( SpikeContainer * sc ); 

                int get_num_attributes();

                void inc_num_attributes(int x);

                SpikeContainer * get_spikes(unsigned int pos = 1);

                SpikeContainer * get_spikes_immediate();

                AttributeContainer * get_attributes(unsigned int pos = 1);

                AttributeContainer * get_attributes_immediate();

                void print();

                void clear();
};

}


#endif /*SPIKEDELAY_H_*/