RateChecker.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 RATECHECKER_H_
#define RATECHECKER_H_

#include "auryn_definitions.h"
#include "AurynVector.h"
#include "System.h"
#include "Checker.h"
#include "SpikingGroup.h"

namespace auryn {

class RateChecker : public Checker
{
private:
        AurynFloat decay_multiplier;
        AurynDouble popmin;
        AurynDouble popmax;
        AurynDouble state;
        AurynFloat timeconstant;
    NeuronID size;
        void init(AurynFloat min, AurynFloat max, AurynFloat tau);
        
        virtual void virtual_serialize(boost::archive::binary_oarchive & ar, const unsigned int version );
        virtual void virtual_serialize(boost::archive::binary_iarchive & ar, const unsigned int version );
protected:
        SpikingGroup * src;

public:
        RateChecker(SpikingGroup * source, AurynFloat min, AurynFloat max, AurynFloat tau=1.0);
        virtual ~RateChecker();
        virtual bool propagate();
        virtual AurynFloat get_property();
        AurynFloat get_rate();
        void set_rate(AurynFloat r);
        void reset();
};

}

#endif /*RATECHECKER_H_*/