Base class implementing common properties for e-prop synapses. More...

#include <eprop_synapse_bsshslm_2020.h>

Inheritance diagram for nest::EpropSynapseBSSHSLM2020CommonProperties:

Collaboration diagram for nest::EpropSynapseBSSHSLM2020CommonProperties:

Public Member Functions
	EpropSynapseBSSHSLM2020CommonProperties ()

	EpropSynapseBSSHSLM2020CommonProperties (const EpropSynapseBSSHSLM2020CommonProperties &)
	Copy constructor.

EpropSynapseBSSHSLM2020CommonProperties &	operator= (const EpropSynapseBSSHSLM2020CommonProperties &)=delete
	Assignment operator.

	~EpropSynapseBSSHSLM2020CommonProperties ()
	Destructor.

void	get_status (Dictionary &d) const
	Get parameter dictionary.

void	set_status (const Dictionary &d, ConnectorModel &cm)
	Update values in parameter dictionary.

Public Member Functions inherited from nest::CommonSynapseProperties
	CommonSynapseProperties ()
	Standard constructor.

	~CommonSynapseProperties ()

void	get_status (Dictionary &d) const
	Get all properties and put them into a dictionary.

void	set_status (const Dictionary &d, ConnectorModel &cm)
	Set properties from the values given in dictionary.

void	calibrate (const TimeConverter &)
	Calibrate all time objects, which might be contained in this object.

long	get_vt_node_id () const
	Get node ID of volume transmitter.

weight_recorder *	get_weight_recorder () const
	Get weight_recorder.

Public Attributes
bool	average_gradient_
	If True, average the gradient over the learning window.

WeightOptimizerCommonProperties *	optimizer_cp_
	Pointer to common properties object for weight optimizer.

Detailed Description

Base class implementing common properties for e-prop synapses.

Base class implementing common properties for the e-prop synapse model according to Bellec et al. (2020).

This class in particular manages a pointer to weight-optimizer common properties to support exchanging the weight optimizer at runtime. Setting the weight-optimizer common properties determines the WO type. It can only be exchanged as long as no synapses for the model exist. The WO CP object is responsible for providing individual optimizer objects to synapses upon connection.

See also: WeightOptimizerCommonProperties

Constructor & Destructor Documentation

◆ EpropSynapseBSSHSLM2020CommonProperties() [1/2]

nest::EpropSynapseBSSHSLM2020CommonProperties::EpropSynapseBSSHSLM2020CommonProperties ( )

◆ EpropSynapseBSSHSLM2020CommonProperties() [2/2]

nest::EpropSynapseBSSHSLM2020CommonProperties::EpropSynapseBSSHSLM2020CommonProperties ( const EpropSynapseBSSHSLM2020CommonProperties & cp )

Copy constructor.

◆ ~EpropSynapseBSSHSLM2020CommonProperties()

nest::EpropSynapseBSSHSLM2020CommonProperties::~EpropSynapseBSSHSLM2020CommonProperties ( )

Destructor.

References optimizer_cp_.

Member Function Documentation

◆ get_status()

void nest::EpropSynapseBSSHSLM2020CommonProperties::get_status ( Dictionary & d ) const

Get parameter dictionary.

References nest::names::average_gradient(), average_gradient_, nest::WeightOptimizerCommonProperties::get_status(), nest::CommonSynapseProperties::get_status(), nest::names::optimizer(), and optimizer_cp_.

Here is the call graph for this function:

◆ operator=()

EpropSynapseBSSHSLM2020CommonProperties & nest::EpropSynapseBSSHSLM2020CommonProperties::operator= ( const EpropSynapseBSSHSLM2020CommonProperties & )

delete

Assignment operator.

◆ set_status()

void nest::EpropSynapseBSSHSLM2020CommonProperties::set_status	(	const Dictionary &	d,
		ConnectorModel &	cm
	)

Update values in parameter dictionary.

References nest::names::average_gradient(), average_gradient_, nest::KernelManager::connection_manager, nest::WeightOptimizerCommonProperties::get_name(), nest::ConnectionManager::get_num_connections(), nest::ConnectorModel::get_syn_id(), nest::kernel(), nest::names::optimizer(), optimizer_cp_, nest::WeightOptimizerCommonProperties::set_status(), nest::CommonSynapseProperties::set_status(), nest::names::type(), and Dictionary::update_value().

Here is the call graph for this function:

Member Data Documentation

◆ average_gradient_

bool nest::EpropSynapseBSSHSLM2020CommonProperties::average_gradient_

If True, average the gradient over the learning window.

Referenced by get_status(), nest::eprop_synapse_bsshslm_2020< targetidentifierT >::send(), and set_status().

◆ optimizer_cp_

WeightOptimizerCommonProperties* nest::EpropSynapseBSSHSLM2020CommonProperties::optimizer_cp_

Pointer to common properties object for weight optimizer.

Note: Must only be changed as long as no synapses of the model exist.

Referenced by nest::eprop_synapse_bsshslm_2020< targetidentifierT >::check_connection(), get_status(), nest::eprop_synapse_bsshslm_2020< targetidentifierT >::send(), set_status(), and ~EpropSynapseBSSHSLM2020CommonProperties().

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

	NEST main@caf0ae8

Public Member Functions

Public Attributes