Trace.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 TRACE_H_
#define TRACE_H_

#include "AurynVector.h"
#include "auryn_definitions.h"

namespace auryn {

class Trace : public AurynStateVector
{
private:
        typedef AurynStateVector super;

protected:
        AurynFloat tau;

public:
        Trace(NeuronID n, AurynFloat timeconstant);

        virtual ~Trace();

        virtual void inc(NeuronID i);

        virtual void inc(SpikeContainer * sc);

        virtual void evolve() = 0;

        virtual void set_timeconstant( AurynFloat timeconstant );

        AurynFloat get_tau();

        virtual AurynFloat normalized_get(NeuronID i);

        virtual AurynStateVector * get_state_ptr();

        virtual void set_target( AurynStateVector * target ) = 0;

        virtual void follow() = 0;

        virtual void follow(AurynVectorFloat * v, const float rate) { super::follow(v, rate); }
};


} // namespace

#endif /*TRACE_H_*/