nest::stdp_facetshw_synapse_hom< targetidentifierT > Class Template Reference

Class representing an STDP connection with homogeneous parameters, i.e. More...

#include <stdp_facetshw_synapse_hom.h>

Inheritance diagram for nest::stdp_facetshw_synapse_hom< targetidentifierT >:

Collaboration diagram for nest::stdp_facetshw_synapse_hom< targetidentifierT >:

Classes
class	ConnTestDummyNode

Public Types
typedef STDPFACETSHWHomCommonProperties< targetidentifierT >	CommonPropertiesType
typedef Connection< targetidentifierT >	ConnectionBase

Public Member Functions
	stdp_facetshw_synapse_hom ()
	Default Constructor.
	stdp_facetshw_synapse_hom (const stdp_facetshw_synapse_hom &)=default
	Copy constructor from a property object.
stdp_facetshw_synapse_hom &	operator= (const stdp_facetshw_synapse_hom &)=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.
bool	send (Event &e, size_t t, const STDPFACETSHWHomCommonProperties< targetidentifierT > &)
	Send an event to the receiver of this connection.
void	check_connection (Node &s, Node &t, size_t receptor_type, const CommonPropertiesType &)
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
bool	eval_function_ (double a_causal, double a_acausal, double a_thresh_th, double a_thresh_tl, std::vector< long > configbit)
unsigned int	weight_to_entry_ (double weight, double weight_per_lut_entry)
double	entry_to_weight_ (unsigned int discrete_weight, double weight_per_lut_entry)
unsigned int	lookup_ (unsigned int discrete_weight_, std::vector< long > table)

Private Attributes
double	weight_
double	a_causal_
double	a_acausal_
double	a_thresh_th_
double	a_thresh_tl_
bool	init_flag_
long	synapse_id_
double	next_readout_time_
unsigned int	discrete_weight_
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_

Detailed Description

template<typename targetidentifierT>
class nest::stdp_facetshw_synapse_hom< targetidentifierT >

Class representing an STDP connection with homogeneous parameters, i.e.

parameters are the same for all synapses.

Member Typedef Documentation

CommonPropertiesType

template<typename targetidentifierT >

typedef STDPFACETSHWHomCommonProperties< targetidentifierT > nest::stdp_facetshw_synapse_hom< targetidentifierT >::CommonPropertiesType

ConnectionBase

template<typename targetidentifierT >

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

Constructor & Destructor Documentation

stdp_facetshw_synapse_hom() [1/2]

template<typename targetidentifierT >

nest::stdp_facetshw_synapse_hom< targetidentifierT >::stdp_facetshw_synapse_hom

(

)

Default Constructor.

Sets default values for all parameters. Needed by GenericConnectorModel.

stdp_facetshw_synapse_hom() [2/2]

template<typename targetidentifierT >

nest::stdp_facetshw_synapse_hom< targetidentifierT >::stdp_facetshw_synapse_hom ( const stdp_facetshw_synapse_hom< 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_facetshw_synapse_hom< targetidentifierT >::check_connection ( Node &  s, Node &  t, size_t  receptor_type, const CommonPropertiesType &    )

inline

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

Here is the call graph for this function:

entry_to_weight_()

template<typename targetidentifierT >

double nest::stdp_facetshw_synapse_hom< targetidentifierT >::entry_to_weight_ ( unsigned int  discrete_weight, double  weight_per_lut_entry  )

inlineprivate

eval_function_()

template<typename targetidentifierT >

bool nest::stdp_facetshw_synapse_hom< targetidentifierT >::eval_function_ ( double  a_causal, double  a_acausal, double  a_thresh_th, double  a_thresh_tl, std::vector< long >  configbit  )

inlineprivate

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_facetshw_synapse_hom< 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_facetshw_synapse_hom< targetidentifierT >::get_status

(

Dictionary &

d

)

const

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

References nest::names::a_acausal(), nest::names::a_causal(), nest::names::a_thresh_th(), nest::names::a_thresh_tl(), nest::names::init_flag(), nest::names::next_readout_time(), nest::names::synapse_id(), 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

lookup_()

template<typename targetidentifierT >

unsigned int nest::stdp_facetshw_synapse_hom< targetidentifierT >::lookup_ ( unsigned int  discrete_weight_, std::vector< long >  table  )

inlineprivate

operator=()

template<typename targetidentifierT >

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

default

send()

template<typename targetidentifierT >

bool nest::stdp_facetshw_synapse_hom< targetidentifierT >::send ( Event &  e, size_t  t, const STDPFACETSHWHomCommonProperties< targetidentifierT > &  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::STDPFACETSHWHomCommonProperties< targetidentifierT >::calc_readout_cycle_duration_(), nest::STDPFACETSHWHomCommonProperties< targetidentifierT >::configbit_0_, nest::STDPFACETSHWHomCommonProperties< targetidentifierT >::configbit_1_, nest::STDPFACETSHWHomCommonProperties< targetidentifierT >::driver_readout_time_, nest::Time::get_ms(), nest::kernel(), nest::STDPFACETSHWHomCommonProperties< targetidentifierT >::lookuptable_0_, nest::STDPFACETSHWHomCommonProperties< targetidentifierT >::lookuptable_1_, nest::STDPFACETSHWHomCommonProperties< targetidentifierT >::lookuptable_2_, nest::STDPFACETSHWHomCommonProperties< targetidentifierT >::no_synapses_, nest::STDPFACETSHWHomCommonProperties< targetidentifierT >::readout_cycle_duration_, nest::STDPFACETSHWHomCommonProperties< targetidentifierT >::reset_pattern_, nest::STDPFACETSHWHomCommonProperties< targetidentifierT >::synapses_per_driver_, nest::STDPFACETSHWHomCommonProperties< targetidentifierT >::tau_minus_, nest::STDPFACETSHWHomCommonProperties< targetidentifierT >::tau_plus_, and nest::STDPFACETSHWHomCommonProperties< targetidentifierT >::weight_per_lut_entry_.

Here is the call graph for this function:

set_status()

template<typename targetidentifierT >

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

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

References nest::names::a_acausal(), nest::names::a_causal(), nest::names::a_thresh_th(), nest::names::a_thresh_tl(), nest::names::init_flag(), nest::names::next_readout_time(), nest::names::synapse_id(), and nest::names::weight().

Here is the call graph for this function:

set_weight()

template<typename targetidentifierT >

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

inline

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

weight_to_entry_()

template<typename targetidentifierT >

unsigned int nest::stdp_facetshw_synapse_hom< targetidentifierT >::weight_to_entry_ ( double  weight, double  weight_per_lut_entry  )

inlineprivate

Member Data Documentation

a_acausal_

template<typename targetidentifierT >

double nest::stdp_facetshw_synapse_hom< targetidentifierT >::a_acausal_

private

a_causal_

template<typename targetidentifierT >

double nest::stdp_facetshw_synapse_hom< targetidentifierT >::a_causal_

private

a_thresh_th_

template<typename targetidentifierT >

double nest::stdp_facetshw_synapse_hom< targetidentifierT >::a_thresh_th_

private

a_thresh_tl_

template<typename targetidentifierT >

double nest::stdp_facetshw_synapse_hom< targetidentifierT >::a_thresh_tl_

private

discrete_weight_

template<typename targetidentifierT >

unsigned int nest::stdp_facetshw_synapse_hom< targetidentifierT >::discrete_weight_

private

init_flag_

template<typename targetidentifierT >

bool nest::stdp_facetshw_synapse_hom< targetidentifierT >::init_flag_

private

next_readout_time_

template<typename targetidentifierT >

double nest::stdp_facetshw_synapse_hom< targetidentifierT >::next_readout_time_

private

properties

template<typename targetidentifierT >

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

staticconstexpr

Initial value:

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

synapse_id_

template<typename targetidentifierT >

long nest::stdp_facetshw_synapse_hom< targetidentifierT >::synapse_id_

private

t_lastspike_

template<typename targetidentifierT >

double nest::stdp_facetshw_synapse_hom< targetidentifierT >::t_lastspike_

private

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

weight_

template<typename targetidentifierT >

double nest::stdp_facetshw_synapse_hom< targetidentifierT >::weight_

private

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

---

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

• stdp_facetshw_synapse_hom.h
• stdp_facetshw_synapse_hom_impl.h