TripletConnection.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 TRIPLETCONNECTION_H_
#define TRIPLETCONNECTION_H_

#include "auryn_definitions.h"
#include "AurynVector.h"
#include "DuplexConnection.h"
#include "Trace.h"
#include "LinearTrace.h"
#include "SpikeDelay.h"


namespace auryn {

class TripletConnection : public DuplexConnection
{

private:
        void virtual_serialize(boost::archive::binary_oarchive & ar, const unsigned int version ) 
        {
                DuplexConnection::virtual_serialize(ar,version);
        }

        void virtual_serialize(boost::archive::binary_iarchive & ar, const unsigned int version ) 
        {
                DuplexConnection::virtual_serialize(ar,version);
                DuplexConnection::compute_reverse_matrix(); // just in case the buffer location has changed 
        }

        void init(AurynFloat tau_hom, AurynFloat eta, AurynFloat kappa, AurynFloat maxweight);
        void init_shortcuts();

        virtual AurynWeight get_hom(NeuronID i);

protected:

        AurynFloat tau_plus;
        AurynFloat tau_minus;
        AurynFloat tau_long;

        AurynFloat tau_homeostatic;

        NeuronID * fwd_ind; 
        AurynWeight * fwd_data;

        NeuronID * bkw_ind; 
        AurynWeight ** bkw_data;

        AurynDouble hom_fudge;

        void clip_weight( AurynWeight * weight );

        void propagate_forward();

        void propagate_backward();


        AurynWeight dw_pre(NeuronID post);

        AurynWeight dw_post(NeuronID pre, NeuronID post);


public:
        AurynFloat A3_plus;

        /* Definitions of presynaptic traces */
        Trace * tr_pre;

        /* Definitions of postsynaptic traces */
        Trace * tr_post;
        Trace * tr_post2;
        Trace * tr_post_hom;

        bool stdp_active;

        TripletConnection(SpikingGroup * source, NeuronGroup * destination, 
                        TransmitterType transmitter=GLUT);

        TripletConnection(SpikingGroup * source, NeuronGroup * destination, 
                        const char * filename, 
                        AurynFloat tau_hom=10, 
                        AurynFloat eta=1, 
                        AurynFloat kappa=3., AurynFloat maxweight=1. , 
                        TransmitterType transmitter=GLUT);

        TripletConnection(SpikingGroup * source, NeuronGroup * destination, 
                        AurynWeight weight, AurynFloat sparseness=0.05, 
                        AurynFloat tau_hom=10, 
                        AurynFloat eta=1, 
                        AurynFloat kappa=3., AurynFloat maxweight=1. , 
                        TransmitterType transmitter=GLUT,
                        string name = "TripletConnection" );

        virtual ~TripletConnection();
        virtual void finalize();
        void free();

        void set_hom_trace(AurynFloat freq);

        virtual void propagate();
        virtual void evolve();

};

}

#endif /*TRIPLETCONNECTION_H_*/