SymmetricSTDPConnection.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 SYMMETRICSTDPCONNECTION_H_
#define SYMMETRICSTDPCONNECTION_H_

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

namespace auryn {


class SymmetricSTDPConnection : public DuplexConnection
{

public:
        AurynFloat learning_rate;
        AurynFloat target;
        AurynFloat kappa_fudge;

        Trace * tr_pre;
        Trace * tr_post;

        inline AurynWeight dw_pre(NeuronID post);
        inline AurynWeight dw_post(NeuronID pre);

        inline void propagate_forward();
        inline void propagate_backward();

        bool stdp_active;

        SymmetricSTDPConnection(SpikingGroup * source, NeuronGroup * destination, 
                        AurynWeight weight, AurynFloat sparseness=0.05,
                        AurynFloat eta=1e-3, AurynFloat kappa=5., AurynFloat tau_stdp=20e-3,
                        AurynWeight maxweight=10. , TransmitterType transmitter=GABA, string name="SymmetricSTDPConnection");

        SymmetricSTDPConnection(SpikingGroup * source, NeuronGroup * destination, 
                        const char * filename, 
                        AurynFloat eta=1e-3, AurynFloat kappa=5., AurynFloat tau_stdp=20e-3, 
                        AurynWeight maxweight=10 , TransmitterType transmitter=GABA);

        virtual ~SymmetricSTDPConnection();
        void init(AurynFloat eta, AurynFloat kappa, AurynFloat tau_stdp, AurynWeight maxweight);
        void free();

        virtual void propagate();

};

}

#endif /*SYMMETRICSTDPCONNECTION_H_*/