Class representing a connection builder which may be bi- or tripartite. More...

#include <conn_builder.h>

Collaboration diagram for nest::ConnBuilder:

Public Member Functions
	ConnBuilder (const std::string &primary_rule, NodeCollectionPTR sources, NodeCollectionPTR targets, const Dictionary &conn_spec, const std::vector< Dictionary > &syn_specs)
	Constructor for bipartite connection.

	ConnBuilder (const std::string &primary_rule, const std::string &third_rule, NodeCollectionPTR sources, NodeCollectionPTR targets, NodeCollectionPTR third, const Dictionary &conn_spec, const Dictionary &third_conn_spec, const std::map< std::string, std::vector< Dictionary > > &syn_specs)
	Constructor for tripartite connection.

	~ConnBuilder ()

void	connect ()
	Connect with or without structural plasticity.

void	disconnect ()
	Delete synapses with or without structural plasticity.

Private Attributes
ThirdInBuilder *	third_in_builder_

ThirdOutBuilder *	third_out_builder_

BipartiteConnBuilder *	primary_builder_

Detailed Description

Class representing a connection builder which may be bi- or tripartite.

A ConnBuilder always has a primary BipartiteConnBuilder. It additionally can have a pair of third_in and third_out Bipartite builders, where the third_in builder must perform one-to-one connections on given source-third pairs.

Constructor & Destructor Documentation

◆ ConnBuilder() [1/2]

nest::ConnBuilder::ConnBuilder	(	const std::string &	primary_rule,
		NodeCollectionPTR	sources,
		NodeCollectionPTR	targets,
		const Dictionary &	conn_spec,
		const std::vector< Dictionary > &	syn_specs
	)

Constructor for bipartite connection.

Parameters

primary_rule	Name of conn rule for primary connection
sources	Source population for primary connection
targets	Target population for primary connection
conn_spec	Connection specification dictionary for tripartite bernoulli rule
syn_spec	Collection of dictionaries with synapse specifications

◆ ConnBuilder() [2/2]

nest::ConnBuilder::ConnBuilder	(	const std::string &	primary_rule,
		const std::string &	third_rule,
		NodeCollectionPTR	sources,
		NodeCollectionPTR	targets,
		NodeCollectionPTR	third,
		const Dictionary &	conn_spec,
		const Dictionary &	third_conn_spec,
		const std::map< std::string, std::vector< Dictionary > > &	syn_specs
	)

Constructor for tripartite connection.

Parameters

primary_rule	Name of conn rule for primary connection
third_rule	Name of conn rule for third-factor connection
sources	Source population for primary connection
targets	Target population for primary connection
third	Third-party population
conn_spec	Connection specification dictionary for tripartite bernoulli rule
syn_specs	Dictionary of synapse specifications for the three connections that may be created. Allowed keys are `"primary"`, `"third_in"`, `"third_out"`, and for each of these the value must be a collection of dictionaries with synapse specifications as for bipartite connectivity.