/***************************************************************************
* SRMTimeDrivenModel.h *
* ------------------- *
* copyright : (C) 2011 by Jesus Garrido and Francisco Naveros *
* email : jgarrido@atc.ugr.es, fnaveros@atc.ugr.es *
***************************************************************************/
/***************************************************************************
* *
* This program 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. *
* *
***************************************************************************/
#ifndef SRMTIMEDRIVENMODEL_H_
#define SRMTIMEDRIVENMODEL_H_
/*!
* \file SRMTimeDrivenModel.h
*
* \author Jesus Garrido
* \author Francisco Naveros
* \date January 2011
*
* This file declares a class which implements a SRM (Spike response model) time-driven neuron
* model.
*
* \note: this class has been modified to use the class VectorSRMState and VectorBufferState
* instead of SRMState and BufferState.
*/
#include "./TimeDrivenNeuronModel.h"
#include "../spike/EDLUTFileException.h"
class VectorSRMState;
class VectorBufferedState;
class Interconnection;
/*!
* \class SRMTimeDrivenModel
*
* \brief Spike Response time-driven neuron model non-based in look-up tables.
*
* This class implements the behavior of a neuron in a spiking neural network.
* It includes internal model functions which define the behavior of the model
* (initialization, update of the state, synapses effect...).
* This behavior is calculated based in a buffer of activity.
*
* \author Jesus Garrido
* \date January 2010
*/
class SRMTimeDrivenModel: public TimeDrivenNeuronModel {
private:
/*!
* \brief Number of channels in the neuron model
*/
unsigned int NumberOfChannels;
/*!
* \brief Decay time constant of the EPSP
*/
float * tau;
/*!
* \brief Resting potential
*/
float vr;
/*!
* \brief Synaptic efficacy
*/
float * W;
/*!
* \brief Spontaneous firing rate
*/
float r0;
/*!
* \brief Probabilistic threshold potential
*/
float v0;
/*!
* \brief Gain factor
*/
float vf;
/*!
* \brief Absolute refractory period
*/
float tauabs;
/*!
* \brief Relative refractory period
*/
float taurel;
protected:
/*!
* \brief It calculates the potential difference between resting and the potential in the defined time.
*
* It calculates the potential difference between resting and the potential in the defined time.
*
* \param index The cell index inside the VectorSRMState.
* \param State Cells state vector.
*
* \return The potential difference between resting and the potential in the defined time.
*/
float PotentialIncrement(int index, VectorSRMState * State);
/*!
* \brief It checks if an spike is fired in the defined time.
*
* It checks if an spike is fired in the defined time.
*
* \param index The cell index inside the VectorSRMState.
* \param State Cell current state.
* \param CurrentTime Current simulation time.
*
* \return True if an spike is fired in the defined time. False in otherwise.
*/
bool CheckSpikeAt(int index, VectorSRMState * State, double CurrentTime);
/*!
* \brief It loads the neuron model description.
*
* It loads the neuron type description from the file .cfg.
*
* \param ConfigFile Name of the neuron description file (*.cfg).
*
* \throw EDLUTFileException If something wrong has happened in the file load.
*/
void LoadNeuronModel(string ConfigFile) throw (EDLUTFileException);
/*!
* \brief It abstracts the effect of an input spike in the cell.
*
* It abstracts the effect of an input spike in the cell.
*
* \param index The cell index inside the VectorSRMState.
* \param State Cell current state.
* \param InputConnection Input connection from which the input spike has got the cell.
*/
void SynapsisEffect(int index, Interconnection * InputConnection);
public:
/*!
* \brief Default constructor with parameters.
*
* It generates a new neuron model object.
*
* \param NeuronTypeID Neuron type identificator
* \param NeuronModelID Neuron model identificator.
*/
SRMTimeDrivenModel(string NeuronTypeID, string NeuronModelID);
/*!
* \brief Class destructor.
*
* It destroys an object of this class.
*/
~SRMTimeDrivenModel();
/*!
* \brief It loads the neuron model description and tables (if necessary).
*
* It loads the neuron model description and tables (if necessary).
*
* \throw EDLUTFileException If something wrong has happened in the file load.
*/
virtual void LoadNeuronModel() throw (EDLUTFileException);
/*!
* \brief It return the Neuron Model VectorNeuronState
*
* It return the Neuron Model VectorNeuronState
*
*/
virtual VectorNeuronState * InitializeState();
/*!
* \brief It processes a propagated spike (input spike in the cell).
*
* It processes a propagated spike (input spike in the cell).
*
* \note This function doesn't generate the next propagated spike. It must be externally done.
*
* \param inter the interconection which propagate the spike
* \param target the neuron which receives the spike
* \param time the time of the spike.
*
* \return A new internal spike if someone is predicted. 0 if none is predicted.
*/
virtual InternalSpike * ProcessInputSpike(Interconnection * inter, Neuron * target, double time);
/*!
* \brief Update the neuron state variables.
*
* It updates the neuron state variables.
*
* \param index The cell index inside the VectorNeuronState. if index=-1, updating all cell.
* \param The current neuron state.
* \param CurrentTime Current time.
*
* \return True if an output spike have been fired. False in other case.
*/
virtual bool UpdateState(int index, VectorNeuronState * State, double CurrentTime);
/*!
* \brief It prints the time-driven model info.
*
* It prints the current time-driven model characteristics.
*
* \param out The stream where it prints the information.
*
* \return The stream after the printer.
*/
virtual ostream & PrintInfo(ostream & out);
/*!
* \brief It initialice VectorNeuronState.
*
* It initialice VectorSRMState.
*
* \param N_neurons cell number inside the VectorNeuronState.
*/
void InitializeStates(int N_neurons, int OpenMPQueueIndex);
/*!
* \brief It evaluates the differential equation in NeuronState and it stores the results in AuxNeuronState.
*
* It evaluates the differential equation in NeuronState and it stores the results in AuxNeuronState.
*
* \param NeuronState value of the neuron state variables where differential equations are evaluated.
* \param AuxNeuronState results of the differential equations evaluation.
*
* \Note: this function it is not necesary for this neuron model because this one does not use integration method.
*/
void EvaluateDifferentialEcuation(float * NeuronState, float * AuxNeuronState){};
/*!
* \brief It evaluates the time depedendent ecuation in NeuronState for elapsed_time and it stores the results in NeuronState.
*
* It evaluates the time depedendent ecuation in NeuronState for elapsed_time and it stores the results in NeuronState.
*
* \param NeuronState value of the neuron state variables where time dependent equations are evaluated.
* \param elapsed_time integration time step.
*
* \Note: this function it is not necesary for this neuron model because this one does not use integration method.
*/
void EvaluateTimeDependentEcuation(float * NeuronState, float elapsed_time){};
/*!
* \brief It Checks if the neuron model has this connection type.
*
* It Checks if the neuron model has this connection type.
*
* \param Type input connection type.
*
* \return A a valid connection type for this neuron model.
*/
virtual int CheckSynapseTypeNumber(int Type);
};
#endif /* SRMTIMEDRIVENMODEL_H_ */