auryn::AIFGroup Class Reference

A simple extension of IFGroup with spike triggered adaptation. More...

#include <AIFGroup.h>

Inheritance diagram for auryn::AIFGroup:

Collaboration diagram for auryn::AIFGroup:

Public Member Functions
	AIFGroup (NeuronID size, NodeDistributionMode distmode=AUTO)
virtual	~AIFGroup ()
void	set_tau_mem (AurynFloat taum)
AurynFloat	get_tau_mem ()
void	set_tau_ampa (AurynFloat tau)
void	set_tau_gaba (AurynFloat tau)
void	set_tau_nmda (AurynFloat tau)
void	set_tau_adapt (AurynFloat tau)
AurynFloat	get_tau_ampa ()
AurynFloat	get_tau_gaba ()
AurynFloat	get_tau_nmda ()
AurynFloat	get_tau_adapt ()
void	random_adapt (AurynState mean, AurynState sigma)
void	set_ampa_nmda_ratio (AurynFloat ratio)
void	calculate_scale_constants ()
void	clear ()
void	evolve ()
	Virtual pure evolve function which needs to be implemented by derived classes. More...
Public Member Functions inherited from auryn::NeuronGroup
	NeuronGroup (NeuronID n, NodeDistributionMode mode=AUTO)
	Default constructor. More...
	NeuronGroup (NeuronID n, double loadmultiplier, NeuronID total)
	Old default constructor. More...
virtual	~NeuronGroup ()
void	set_state (std::string name, AurynState val)
	Conveniently sets all values in a state vector identified by name in this group. More...
void	set_state (std::string name, NeuronID i, AurynState val)
	Conveniently sets a single value of element i in a state vector identified by name in this group. More...
virtual AurynStateVector *	get_default_exc_target ()
	Returns default exc target input. More...
virtual AurynStateVector *	get_default_inh_target ()
	Returns default inh target input. More...
void	random_mem (AurynState mean=-60e-3, AurynState sigma=5e-3)
virtual void	init_state ()
void	safe_tadd (NeuronID id, AurynWeight amount, TransmitterType t=GLUT)
void	tadd (NeuronID id, AurynWeight amount, TransmitterType t=GLUT)
void	tadd (AurynStateVector *state, NeuronID id, AurynWeight amount)
Public Member Functions inherited from auryn::SpikingGroup
void	add_state_vector (std::string key, AurynStateVector *state_vector)
	Adds a state vector passed as an argument to the dictinary. More...
void	remove_state_vector (std::string key)
	Removes a state vector passed as an argument to the dictinary. More...
AurynStateVector *	find_state_vector (std::string key)
	Returns existing state vector by name or NULL if it does not exist. More...
AurynStateVector *	get_state_vector (std::string key)
	Creates a new or returns an existing state vector by name. More...
AurynStateVector *	get_existing_state_vector (std::string key)
	Returns an existing state with the supplied name. More...
AurynStateVector *	create_state_vector (std::string key)
	Creates a new state vector and throws an exception if a vector with the same name exists. More...
AurynState *	get_state_variable (std::string key)
	Creates a new group-wide state variable or returns an existing group-wide variable by name then returns a pointer to it. More...
void	randomize_state_vector_gauss (std::string state_vector_name, AurynState mean, AurynState sigma, int seed=12239)
	Randomizes the content of a state vector with Gaussian random numbers. Seeding is MPI save. More...
	SpikingGroup (NeuronID size, NodeDistributionMode mode=AUTO)
	Default constructor. More...
virtual	~SpikingGroup ()
	Default destructor. More...
virtual void	evolve_traces ()
	Evolves traces. More...
void	set_name (std::string s)
	Set connection name. More...
std::string	get_name ()
	Retrieves the groups name. More...
std::string	get_file_name ()
	Extracts the class name of the connection from the file name. More...
std::string	get_log_name ()
	Returns a string which is the combination of file and connection name for logging. More...
void	inc_num_spike_attributes (int x)
	Instructs SpikingGroup to increase the number of spike attributes by x. More...
int	get_num_spike_attributes ()
void	conditional_evolve ()
	Conditional evolve functino which is called by System. More...
unsigned int	get_locked_rank ()
	Returns locked rank for SpikingGroups which are not distributed across all ranks. More...
unsigned int	get_locked_range ()
	Returns locked range of ranks for SpikingGroups which are not distributed across all ranks. More...
SpikeContainer *	get_spikes ()
	Returns pointer to a spike container that contains spikes which arrive in this timestep from all neurons in this group. More...
SpikeContainer *	get_spikes_immediate ()
	Returns pointer to SpikeContainer of spikes generated during the last evolve() step. More...
AttributeContainer *	get_attributes ()
	Returns pointer to Attributecontainer for usage in propagating Connection objects. Same as get_spikes_immediate(), however might be overwritten to contain Spikes that have been delayed. More...
AttributeContainer *	get_attributes_immediate ()
	Returns pointer to Attributecontainer of spikes generated during the last evolve() step. More...
NeuronID	get_size ()
	Returns the size of the group. More...
NeuronID	get_pre_size ()
	Returns the size of the group. More...
NeuronID	calculate_rank_size (int rank=-1)
	Determines rank size and stores it in local variable. More...
NeuronID	get_rank_size ()
	Returns the size on this rank. More...
NeuronID	get_post_size ()
	Returns the size on this rank. More...
void	set_clock_ptr (AurynTime *clock)
bool	evolve_locally ()
	Returns true if the calling instance has units which are integrated on the current rank. More...
NeuronID	get_uid ()
	Get the unique ID of the class. More...
Trace *	get_pre_trace (AurynFloat x)
	Returns a pre trace with time constant x. More...
void	add_pre_trace (Trace *tr)
	Adds trace to pretrace stack of a connection. More...
Trace *	get_post_trace (AurynFloat x)
	Returns a post trace with time constant x. More...
void	add_post_trace (Trace *tr)
	Adds trace to posttrace stack of a connection. More...
void	push_spike (NeuronID spike)
	Pushes a local NeuronID as spike into the axonal SpikeDelay buffer. More...
void	push_attribute (AurynFloat attrib)
	Pushes a spike attribute into the axonal SpikeDelay buffer. More...
void	clear_spikes ()
	Clears all spikes stored in the delays which is useful to reset a network during runtime. More...
Trace *	get_post_state_trace (std::string state_name="mem", AurynFloat tau=10e-3, AurynFloat b=0.0)
	Returns a post trace of a neuronal state variable e.g. the membrane potential with time constant tau. More...
Trace *	get_post_state_trace (AurynStateVector *state, AurynFloat tau=10e-3, AurynFloat b=0.0)
	Returns a post trace of a neuronal state variable specified by pointer. More...
void	set_delay (int d)
	Sets axonal delay for this SpikingGroup. More...
virtual bool	write_to_file (const char *filename)
	Writes current states of SpikingGroup to human-readible textfile if implemented in derived class. More...
virtual bool	load_from_file (const char *filename)
	Reads current states of SpikingGroup to human-readible textfile if implemented in derived class. More...
NeuronID	ranksize ()
	Returns size (num of neurons) on the current rank. More...
NeuronID	global2rank (NeuronID i)
	Converts global NeuronID within the SpikingGroup to the local NeuronID on this rank. More...
NeuronID	rank2global (NeuronID i)
	Converts local NeuronID from the local rank to a global NeuronID. More...
bool	localrank (NeuronID i)
	Checks if the global NeuronID i is integrated on this MPI rank. More...
NeuronID	get_vector_size ()
	Rank size but rounded up to multiples of 4 (or potentially some other and larger number in future versions) for SSE compatibility. More...

Public Attributes
AurynFloat	dg_adapt1
Public Attributes inherited from auryn::NeuronGroup
AurynStateVector *	mem
AurynStateVector *	g_ampa
AurynStateVector *	g_gaba
AurynStateVector *	g_nmda
AurynStateVector *	thr
Public Attributes inherited from auryn::SpikingGroup
SpikeDelay *	delay
bool	active
	Toggles group active. More...
std::map< std::string, AurynStateVector * >	state_vectors
std::map< std::string, AurynState >	state_variables

Protected Member Functions
void	init ()
void	vector_scale (float mul, auryn_vector_float *v)
void	integrate_linear_nmda_synapses ()
void	integrate_membrane ()
	Integrate the internal state. More...
void	check_thresholds ()
Protected Member Functions inherited from auryn::NeuronGroup
void	init ()
void	free ()
Protected Member Functions inherited from auryn::SpikingGroup
virtual void	load_input_line (NeuronID i, const char *buf)
virtual std::string	get_output_line (NeuronID i)
virtual void	virtual_serialize (boost::archive::binary_oarchive &ar, const unsigned int version)
	Implementatinon of serialize function for writing. More...
virtual void	virtual_serialize (boost::archive::binary_iarchive &ar, const unsigned int version)
	Implementatinon of serialize function for reading. More...
void	free ()
	Frees potentially allocated memory. More...

Protected Attributes
AurynStateVector *	dmem
AurynStateVector *	t_leak
AurynStateVector *	t_exc
AurynStateVector *	t_inh
AurynStateVector *	g_adapt1
AurynFloat	scale_ampa
AurynFloat	scale_gaba
AurynFloat	scale_thr
AurynFloat	scale_adapt1
AurynFloat	tau_adapt1
AurynFloat	e_rest
AurynFloat	e_rev
AurynFloat	thr_rest
AurynFloat	tau_mem
AurynFloat	tau_thr
AurynFloat	dthr
AurynFloat	tau_ampa
AurynFloat	tau_gaba
AurynFloat	tau_nmda
AurynFloat	A_ampa
AurynFloat	A_nmda
Protected Attributes inherited from auryn::NeuronGroup
AurynStateVector *	default_exc_target_state
AurynStateVector *	default_inh_target_state
Protected Attributes inherited from auryn::SpikingGroup
std::vector< Trace * >	pretraces
	Pretraces. More...
std::vector< Trace * >	posttraces
	Posttraces. More...
std::vector< Trace * >	post_state_traces
	Post state traces. More...
std::vector< AurynFloat >	post_state_traces_spike_biases
std::vector< AurynStateVector * >	post_state_traces_states
std::string	group_name
	Identifying name for object. More...
NeuronID	size
	Stores the size of the group. More...
NeuronID	rank_size
	Stores the size of the group on this rank. More...
SpikeContainer *	spikes
	SpikeContainers to store spikes produced during one step of evolve. More...
AttributeContainer *	attribs

Additional Inherited Members
Static Protected Attributes inherited from auryn::SpikingGroup
static AurynTime *	clock_ptr = NULL

Detailed Description

A simple extension of IFGroup with spike triggered adaptation.

Constructor & Destructor Documentation

AIFGroup()

AIFGroup::AIFGroup	(	NeuronID	size,
		NodeDistributionMode	distmode = AUTO
	)

                                                                : NeuronGroup(size,distmode)
{
        auryn::sys->register_spiking_group(this);
        if ( evolve_locally() ) init();
}

Here is the call graph for this function:

~AIFGroup()

AIFGroup::~AIFGroup ( )

virtual

{
        if ( evolve_locally() ) free();
}

Here is the call graph for this function:

Member Function Documentation

calculate_scale_constants()

void AIFGroup::calculate_scale_constants

(

)

{
        scale_ampa =  exp(-auryn_timestep/tau_ampa) ;
        scale_gaba =  exp(-auryn_timestep/tau_gaba) ;
        scale_thr = exp(-auryn_timestep/tau_thr) ;
        scale_adapt1 = exp(-auryn_timestep/tau_adapt1);
}

check_thresholds()

void AIFGroup::check_thresholds ( )

protected

{
        mem->clip( e_rev, 0.0 );

        AurynState * thr_ptr = thr->data;
        for ( AurynState * i = mem->data ; i != mem->data+get_rank_size() ; ++i ) { // it's important to use rank_size here otherwise there might be spikes from units that do not exist
        if ( *i > ( thr_rest + *thr_ptr ) ) {
                        NeuronID unit = i-mem->data;
                        push_spike(unit);
                    mem->set( unit, e_rest); // reset
                thr->set( unit, dthr); //refractory
                        g_adapt1->add_specific( unit, dg_adapt1);
                } 
                thr_ptr++;
        }

}

Here is the call graph for this function:

clear()

void AIFGroup::clear ( )

virtual

Implements auryn::NeuronGroup.

{
        clear_spikes();
        mem->set_all(e_rest);
        thr->set_all(0.);
        g_ampa->set_all(0.);
        g_gaba->set_all(0.);
        g_nmda->set_all(0.);
        g_adapt1->set_all(0.);

}

Here is the call graph for this function:

evolve()

void AIFGroup::evolve ( )

virtual

Virtual pure evolve function which needs to be implemented by derived classes.

The evolve function is called during simulations in every timestep by the System class. It updates the internal state of the spiking group and pushes spikes which are generated in this timestep to the axonal output delay (SpikeDelay).

Implements auryn::SpikingGroup.

{
        integrate_linear_nmda_synapses();
        integrate_membrane();
        check_thresholds();
}

Here is the call graph for this function:

get_tau_adapt()

AurynFloat AIFGroup::get_tau_adapt

(

)

{
        return tau_adapt1;
}

get_tau_ampa()

AurynFloat AIFGroup::get_tau_ampa

(

)

{
        return tau_ampa;
}

get_tau_gaba()

AurynFloat AIFGroup::get_tau_gaba

(

)

{
        return tau_gaba;
}

get_tau_mem()

AurynFloat auryn::AIFGroup::get_tau_mem

(

)

get_tau_nmda()

AurynFloat AIFGroup::get_tau_nmda

(

)

{
        return tau_nmda;
}

init()

void AIFGroup::init ( )

protected

{
        e_rest = -70e-3;
        e_rev = -80e-3;
        thr_rest = -50e-3;
        dthr = 100e-3;
        tau_thr = 5e-3;
        tau_mem = 20e-3;
        tau_ampa = 5e-3;
        tau_gaba = 10e-3;
        tau_nmda = 100e-3;

        set_ampa_nmda_ratio(1.0);

        tau_adapt1 = 0.1;
        dg_adapt1  = 0.1;
 
        calculate_scale_constants();

        t_leak = get_state_vector("t_leak");
        t_exc  =  get_state_vector("t_exc");
        t_inh  = get_state_vector("t_inh");
        g_adapt1 = get_state_vector("g_adapt1");

        clear();
}

Here is the call graph for this function:

integrate_linear_nmda_synapses()

void AIFGroup::integrate_linear_nmda_synapses ( )

protected

{
        // decay of ampa and gaba channel, i.e. multiply by exp(-auryn_timestep/tau)
        g_ampa->scale(scale_ampa);
        g_gaba->scale(scale_gaba);
        g_adapt1->scale(scale_adapt1);

    // compute dg_nmda = (g_ampa-g_nmda)*auryn_timestep/tau_nmda and add to g_nmda
        const AurynFloat mul_nmda = auryn_timestep/tau_nmda;
        g_nmda->saxpy(mul_nmda, g_ampa);
        g_nmda->saxpy(-mul_nmda, g_nmda);

    // excitatory
        t_exc->copy(g_ampa);
        t_exc->scale(-A_ampa);
        t_exc->saxpy(-A_nmda,g_nmda);
        t_exc->mul(mem);
    
    // inhibitory
    t_leak->copy(g_gaba); // using t_leak as temp here
    t_leak->saxpy(1.0, g_adapt1); 
        t_inh->diff(mem,e_rev);
        t_inh->mul(t_leak);
}

Here is the call graph for this function:

integrate_membrane()

void AIFGroup::integrate_membrane ( )

protected

Integrate the internal state.

This method applies the Euler integration step to the membrane dynamics.

{
        // moving threshold
        thr->scale(scale_thr);
    
    // leak
        t_leak->diff(mem,e_rest);
    
    // membrane dynamics
        const AurynFloat mul_tau_mem = auryn_timestep/tau_mem;
    mem->saxpy(mul_tau_mem,t_exc);
    mem->saxpy(-mul_tau_mem,t_inh);
    mem->saxpy(-mul_tau_mem,t_leak);
}

Here is the call graph for this function:

random_adapt()

void AIFGroup::random_adapt	(	AurynState	mean,
		AurynState	sigma
	)

{
        boost::mt19937 ng_gen(42); // produces same series every time 
        boost::normal_distribution<> dist((double)mean, (double)sigma);
        boost::variate_generator<boost::mt19937&, boost::normal_distribution<> > die(ng_gen, dist);
        AurynState rv;

        for ( AurynLong i = 0 ; i<get_rank_size() ; ++i ) {
                rv = die();
                if ( rv>0 ) 
                        g_adapt1->set( i, rv ); 
        }

        init_state();
}

Here is the call graph for this function:

set_ampa_nmda_ratio()

void AIFGroup::set_ampa_nmda_ratio

(

AurynFloat

ratio

)

{
        A_ampa = ratio/(ratio+1.0);
        A_nmda = 1./(ratio+1.0);
}

set_tau_adapt()

void AIFGroup::set_tau_adapt

(

AurynFloat

tau

)

{
        tau_adapt1 = taua;
        calculate_scale_constants();
}

Here is the call graph for this function:

set_tau_ampa()

void AIFGroup::set_tau_ampa

(

AurynFloat

tau

)

{
        tau_ampa = taum;
        calculate_scale_constants();
}

Here is the call graph for this function:

set_tau_gaba()

void AIFGroup::set_tau_gaba

(

AurynFloat

tau

)

{
        tau_gaba = taum;
        calculate_scale_constants();
}

Here is the call graph for this function:

set_tau_mem()

void AIFGroup::set_tau_mem

(

AurynFloat

taum

)

{
        tau_mem = taum;
        calculate_scale_constants();
}

Here is the call graph for this function:

set_tau_nmda()

void AIFGroup::set_tau_nmda

(

AurynFloat

tau

)

{
        tau_nmda = taum;
        calculate_scale_constants();
}

Here is the call graph for this function:

vector_scale()

void auryn::AIFGroup::vector_scale ( float  mul, auryn_vector_float *  v  )

protected

Member Data Documentation

A_ampa

AurynFloat auryn::AIFGroup::A_ampa

protected

A_nmda

AurynFloat auryn::AIFGroup::A_nmda

protected

dg_adapt1

AurynFloat auryn::AIFGroup::dg_adapt1

dmem

AurynStateVector* auryn::AIFGroup::dmem

protected

dthr

AurynFloat auryn::AIFGroup::dthr

protected

e_rest

AurynFloat auryn::AIFGroup::e_rest

protected

e_rev

AurynFloat auryn::AIFGroup::e_rev

protected

g_adapt1

AurynStateVector* auryn::AIFGroup::g_adapt1

protected

scale_adapt1

AurynFloat auryn::AIFGroup::scale_adapt1

protected

scale_ampa

AurynFloat auryn::AIFGroup::scale_ampa

protected

scale_gaba

AurynFloat auryn::AIFGroup::scale_gaba

protected

scale_thr

AurynFloat auryn::AIFGroup::scale_thr

protected

t_exc

AurynStateVector* auryn::AIFGroup::t_exc

protected

t_inh

AurynStateVector* auryn::AIFGroup::t_inh

protected

t_leak

AurynStateVector* auryn::AIFGroup::t_leak

protected

tau_adapt1

AurynFloat auryn::AIFGroup::tau_adapt1

protected

tau_ampa

AurynFloat auryn::AIFGroup::tau_ampa

protected

tau_gaba

AurynFloat auryn::AIFGroup::tau_gaba

protected

tau_mem

AurynFloat auryn::AIFGroup::tau_mem

protected

tau_nmda

AurynFloat auryn::AIFGroup::tau_nmda

protected

tau_thr

AurynFloat auryn::AIFGroup::tau_thr

protected

thr_rest

AurynFloat auryn::AIFGroup::thr_rest

protected

---

The documentation for this class was generated from the following files:

• /home/zenke/auryn/src/auryn/AIFGroup.h
• /home/zenke/auryn/src/auryn/AIFGroup.cpp