#include <stdp_dopamine_synapse.h>

Inheritance diagram for nest::stdp_dopamine_synapse< targetidentifierT >:

Collaboration diagram for nest::stdp_dopamine_synapse< targetidentifierT >:

Classes
class	ConnTestDummyNode

Public Types
typedef STDPDopaCommonProperties	CommonPropertiesType

typedef Connection< targetidentifierT >	ConnectionBase

Public Member Functions
	stdp_dopamine_synapse ()
	Default Constructor.

	stdp_dopamine_synapse (const stdp_dopamine_synapse &)=default
	Copy constructor from a property object.

stdp_dopamine_synapse &	operator= (const stdp_dopamine_synapse &)=default

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

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

void	check_synapse_params (const Dictionary &d) const
	Checks to see if illegal parameters are given in syn_spec.

bool	send (Event &e, size_t t, const STDPDopaCommonProperties &cp)
	Send an event to the receiver of this connection.

void	trigger_update_weight (size_t t, const std::vector< spikecounter > &dopa_spikes, double t_trig, const STDPDopaCommonProperties &cp)

void	check_connection (Node &s, Node &t, size_t receptor_type, const CommonPropertiesType &cp)

void	set_weight (double w)

double	get_delay () const
	Return the delay of the connection in ms.

long	get_delay_steps () const
	Return the delay of the connection in steps.

size_t	get_rport () const

Node *	get_target (const size_t tid) const

Public Member Functions inherited from nest::Connection< targetidentifierT >
	Connection ()

	Connection (const Connection< targetidentifierT > &rhs)=default

Connection &	operator= (const Connection< targetidentifierT > &rhs)=default

std::unique_ptr< SecondaryEvent >	get_secondary_event ()
	Get a pointer to an instance of a SecondaryEvent if this connection supports secondary events.

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

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

void	check_synapse_params (const Dictionary &d) const
	Check syn_spec dictionary for parameters that are not allowed with the given connection.

void	calibrate (const TimeConverter &)
	Calibrate the delay of this connection to the desired resolution.

double	get_delay () const
	Return the delay of the connection in ms.

long	get_delay_steps () const
	Return the delay of the connection in steps.

void	set_delay (const double delay)
	Set the delay of the connection.

void	set_delay_steps (const long delay)
	Set the delay of the connection in steps.

void	set_syn_id (synindex syn_id)
	Set the synapse id of the connection.

synindex	get_syn_id () const
	Get the synapse id of the connection.

long	get_label () const

void	trigger_update_weight (const size_t, const std::vector< spikecounter > &, const double, const CommonSynapseProperties &)
	Triggers an update of a synaptic weight.

Node *	get_target (const size_t tid) const

size_t	get_rport () const

void	set_source_has_more_targets (const bool more_targets)
	Sets a flag in the connection to signal that the following connection has the same source.

bool	source_has_more_targets () const
	Returns a flag denoting whether the connection has source subsequent targets.

void	disable ()
	Disables the connection.

bool	is_disabled () const
	Returns a flag denoting if the connection is disabled.

Static Public Attributes
static constexpr ConnectionModelProperties	properties

Static Public Attributes inherited from nest::Connection< targetidentifierT >
static constexpr ConnectionModelProperties	properties = ConnectionModelProperties::NONE

static constexpr bool	supports_flush_event = false

Private Member Functions
void	update_dopamine_ (const std::vector< spikecounter > &dopa_spikes, const STDPDopaCommonProperties &cp)

void	update_weight_ (double c0, double n0, double minus_dt, const STDPDopaCommonProperties &cp)

void	process_dopa_spikes_ (const std::vector< spikecounter > &dopa_spikes, double t0, double t1, const STDPDopaCommonProperties &cp)

void	facilitate_ (double kplus, const STDPDopaCommonProperties &cp)

void	depress_ (double kminus, const STDPDopaCommonProperties &cp)

Private Attributes
double	weight_

double	Kplus_

double	c_

double	n_

size_t	dopa_spikes_idx_

double	t_last_update_

double	t_lastspike_

Additional Inherited Members
Protected Member Functions inherited from nest::Connection< targetidentifierT >
void	check_connection_ (Node &dummy_target, Node &source, Node &target, const size_t receptor_type)
	This function calls check_connection() on the sender to check if the receiver accepts the event type and receptor type requested by the sender.

Protected Attributes inherited from nest::Connection< targetidentifierT >
targetidentifierT	target_

SynIdDelay	syn_id_delay_

Member Typedef Documentation

◆ CommonPropertiesType

template<typename targetidentifierT >

typedef STDPDopaCommonProperties nest::stdp_dopamine_synapse< targetidentifierT >::CommonPropertiesType

◆ ConnectionBase

template<typename targetidentifierT >

typedef Connection< targetidentifierT > nest::stdp_dopamine_synapse< targetidentifierT >::ConnectionBase

Constructor & Destructor Documentation

◆ stdp_dopamine_synapse() [1/2]

template<typename targetidentifierT >

nest::stdp_dopamine_synapse< targetidentifierT >::stdp_dopamine_synapse ( )

Default Constructor.

Sets default values for all parameters. Needed by GenericConnectorModel.

◆ stdp_dopamine_synapse() [2/2]

template<typename targetidentifierT >

nest::stdp_dopamine_synapse< targetidentifierT >::stdp_dopamine_synapse ( const stdp_dopamine_synapse< targetidentifierT > & )

default

Copy constructor from a property object.

Needs to be defined properly in order for GenericConnector to work.

Member Function Documentation

◆ check_connection()

template<typename targetidentifierT >

void nest::stdp_dopamine_synapse< targetidentifierT >::check_connection	(	Node &	s,
		Node &	t,
		size_t	receptor_type,
		const CommonPropertiesType &	cp
	)

inline

References nest::Connection< targetidentifierT >::check_connection_(), nest::stdp_dopamine_synapse< targetidentifierT >::get_delay(), nest::Node::register_stdp_connection(), nest::stdp_dopamine_synapse< targetidentifierT >::t_lastspike_, and nest::STDPDopaCommonProperties::volume_transmitter_.

Here is the call graph for this function:

◆ check_synapse_params()

template<typename targetidentifierT >

void nest::stdp_dopamine_synapse< targetidentifierT >::check_synapse_params ( const Dictionary & d ) const

Checks to see if illegal parameters are given in syn_spec.

The illegal parameters are: vt, A_minus, A_plus, Wmax, Wmin, b, tau_c, tau_n, tau_plus, c and n. The last two are prohibited only if we have more than one thread.

References nest::names::c(), nest::kernel(), Dictionary::known(), and nest::names::n().

Here is the call graph for this function:

◆ depress_()

template<typename targetidentifierT >

void nest::stdp_dopamine_synapse< targetidentifierT >::depress_	(	double	kminus,
		const STDPDopaCommonProperties &	cp
	)

inlineprivate

References nest::STDPDopaCommonProperties::A_minus_.

◆ facilitate_()

template<typename targetidentifierT >

void nest::stdp_dopamine_synapse< targetidentifierT >::facilitate_	(	double	kplus,
		const STDPDopaCommonProperties &	cp
	)

inlineprivate

References nest::STDPDopaCommonProperties::A_plus_.

◆ get_delay()

template<typename targetidentifierT >

double nest::Connection< targetidentifierT >::get_delay ( ) const

inline

Return the delay of the connection in ms.

Referenced by nest::stdp_dopamine_synapse< targetidentifierT >::check_connection().

Here is the caller graph for this function:

◆ get_delay_steps()

template<typename targetidentifierT >

long nest::Connection< targetidentifierT >::get_delay_steps ( ) const

inline

Return the delay of the connection in steps.

◆ get_rport()

template<typename targetidentifierT >

size_t nest::Connection< targetidentifierT >::get_rport ( ) const

inline

◆ get_status()

template<typename targetidentifierT >

void nest::stdp_dopamine_synapse< targetidentifierT >::get_status ( Dictionary & d ) const

Get all properties of this connection and put them into a dictionary.

References nest::names::c(), nest::names::Kplus(), nest::names::n(), and nest::names::weight().

Here is the call graph for this function:

◆ get_target()

template<typename targetidentifierT >

Node * nest::Connection< targetidentifierT >::get_target ( const size_t tid ) const

inline

◆ operator=()

template<typename targetidentifierT >

stdp_dopamine_synapse & nest::stdp_dopamine_synapse< targetidentifierT >::operator= ( const stdp_dopamine_synapse< targetidentifierT > & )

default

◆ process_dopa_spikes_()

template<typename targetidentifierT >

void nest::stdp_dopamine_synapse< targetidentifierT >::process_dopa_spikes_	(	const std::vector< spikecounter > &	dopa_spikes,
		double	t0,
		double	t1,
		const STDPDopaCommonProperties &	cp
	)

inlineprivate

References nest::kernel(), nest::STDPDopaCommonProperties::tau_c_, and nest::STDPDopaCommonProperties::tau_n_.

Here is the call graph for this function:

◆ send()

template<typename targetidentifierT >

bool nest::stdp_dopamine_synapse< targetidentifierT >::send	(	Event &	e,
		size_t	t,
		const STDPDopaCommonProperties &	cp
	)

inline

Send an event to the receiver of this connection.

Parameters

e	The event to send
e	The event to send
p	The port under which this connection is stored in the Connector.

References nest::volume_transmitter::deliver_spikes(), nest::kernel(), nest::STDPDopaCommonProperties::tau_plus_, and nest::STDPDopaCommonProperties::volume_transmitter_.

Here is the call graph for this function:

◆ set_status()

template<typename targetidentifierT >

void nest::stdp_dopamine_synapse< targetidentifierT >::set_status	(	const Dictionary &	d,
		ConnectorModel &	cm
	)

Set properties of this connection from the values given in dictionary.

References nest::names::c(), nest::names::Kplus(), nest::names::n(), and nest::names::weight().

Here is the call graph for this function:

◆ set_weight()

template<typename targetidentifierT >

void nest::stdp_dopamine_synapse< targetidentifierT >::set_weight ( double w )

inline

References nest::stdp_dopamine_synapse< targetidentifierT >::weight_.

◆ trigger_update_weight()

template<typename targetidentifierT >

void nest::stdp_dopamine_synapse< targetidentifierT >::trigger_update_weight	(	size_t	t,
		const std::vector< spikecounter > &	dopa_spikes,
		double	t_trig,
		const STDPDopaCommonProperties &	cp
	)

inline

References nest::STDPDopaCommonProperties::tau_n_, and nest::STDPDopaCommonProperties::tau_plus_.

◆ update_dopamine_()

template<typename targetidentifierT >

void nest::stdp_dopamine_synapse< targetidentifierT >::update_dopamine_	(	const std::vector< spikecounter > &	dopa_spikes,
		const STDPDopaCommonProperties &	cp
	)

inlineprivate

References nest::STDPDopaCommonProperties::tau_n_.

◆ update_weight_()

template<typename targetidentifierT >

void nest::stdp_dopamine_synapse< targetidentifierT >::update_weight_	(	double	c0,
		double	n0,
		double	minus_dt,
		const STDPDopaCommonProperties &	cp
	)

inlineprivate

References nest::STDPDopaCommonProperties::b_, numerics::expm1(), nest::STDPDopaCommonProperties::tau_c_, nest::STDPDopaCommonProperties::tau_n_, nest::STDPDopaCommonProperties::Wmax_, and nest::STDPDopaCommonProperties::Wmin_.

Here is the call graph for this function:

Member Data Documentation

◆ c_

template<typename targetidentifierT >

double nest::stdp_dopamine_synapse< targetidentifierT >::c_

private

◆ dopa_spikes_idx_

template<typename targetidentifierT >

size_t nest::stdp_dopamine_synapse< targetidentifierT >::dopa_spikes_idx_

private

◆ Kplus_

template<typename targetidentifierT >

double nest::stdp_dopamine_synapse< targetidentifierT >::Kplus_

private

◆ n_

template<typename targetidentifierT >

double nest::stdp_dopamine_synapse< targetidentifierT >::n_

private

◆ properties

template<typename targetidentifierT >

constexpr ConnectionModelProperties nest::stdp_dopamine_synapse< targetidentifierT >::properties

staticconstexpr

Initial value:

= ConnectionModelProperties::HAS_DELAY
    | ConnectionModelProperties::IS_PRIMARY | ConnectionModelProperties::SUPPORTS_HPC
    | ConnectionModelProperties::SUPPORTS_LBL

◆ t_last_update_

template<typename targetidentifierT >

double nest::stdp_dopamine_synapse< targetidentifierT >::t_last_update_

private

◆ t_lastspike_

template<typename targetidentifierT >

double nest::stdp_dopamine_synapse< targetidentifierT >::t_lastspike_

private

Referenced by nest::stdp_dopamine_synapse< targetidentifierT >::check_connection().

◆ weight_

template<typename targetidentifierT >

double nest::stdp_dopamine_synapse< targetidentifierT >::weight_

private

Referenced by nest::stdp_dopamine_synapse< targetidentifierT >::set_weight().

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

stdp_dopamine_synapse.h

	NEST main@caf0ae8

Classes

Public Types

Public Member Functions

Static Public Attributes

Private Member Functions

Private Attributes

Additional Inherited Members

Member Typedef Documentation

◆ CommonPropertiesType

◆ ConnectionBase

Constructor & Destructor Documentation

◆ stdp_dopamine_synapse() [1/2]

◆ stdp_dopamine_synapse() [2/2]

Member Function Documentation

◆ check_connection()

◆ check_synapse_params()

◆ depress_()

◆ facilitate_()

◆ get_delay()

◆ get_delay_steps()

◆ get_rport()

◆ get_status()

◆ get_target()

◆ operator=()

◆ process_dopa_spikes_()

◆ send()

◆ set_status()

◆ set_weight()

◆ trigger_update_weight()

◆ update_dopamine_()

◆ update_weight_()

Member Data Documentation

◆ c_

◆ dopa_spikes_idx_

◆ Kplus_

◆ n_

◆ properties

◆ t_last_update_

◆ t_lastspike_

◆ weight_