nest::FixedOutDegreeBuilder Class Reference

#include <conn_builder.h>

Inheritance diagram for nest::FixedOutDegreeBuilder:

Collaboration diagram for nest::FixedOutDegreeBuilder:

Public Member Functions
	FixedOutDegreeBuilder (NodeCollectionPTR, NodeCollectionPTR, ThirdOutBuilder *third_out, const Dictionary &, const std::vector< Dictionary > &)
Public Member Functions inherited from nest::BipartiteConnBuilder
virtual void	connect ()
	Connect with or without structural plasticity.
virtual void	disconnect ()
	Delete synapses with or without structural plasticity.
	BipartiteConnBuilder (NodeCollectionPTR sources, NodeCollectionPTR targets, ThirdOutBuilder *third_out, const Dictionary &conn_spec, const std::vector< Dictionary > &syn_specs)
virtual	~BipartiteConnBuilder ()
size_t	get_synapse_model () const
bool	get_default_delay () const
void	set_synaptic_element_names (const std::string &pre_name, const std::string &post_name)
bool	change_connected_synaptic_elements (size_t snode_id, size_t tnode_id, const size_t tid, int update)
	Updates the number of connected synaptic elements in the target and the source.
virtual bool	supports_symmetric () const
	Return true if rule allows creation of symmetric connectivity.
virtual bool	is_symmetric () const
	Return true if rule automatically creates symmetric connectivity.
bool	allows_autapses () const
bool	allows_multapses () const
virtual bool	requires_proxies () const
	Return true if rule is applicable only to nodes with proxies.

Protected Member Functions
void	connect_ () override
	Implements the actual connection algorithm.
Protected Member Functions inherited from nest::BipartiteConnBuilder
bool	all_parameters_scalar_ () const
virtual void	sp_connect_ ()
virtual void	disconnect_ ()
virtual void	sp_disconnect_ ()
void	update_param_dict_ (size_t snode_id, Node &target, size_t target_thread, RngPtr rng, size_t indx)
void	single_connect_ (size_t, Node &, size_t, RngPtr)
	Create connection between given nodes, fill parameter values.
void	single_disconnect_ (size_t, Node &, size_t)
void	skip_conn_parameter_ (size_t, size_t n_skip=1)
	Moves pointer in parameter array.
bool	loop_over_targets_ () const
	Returns true if conventional looping over targets is indicated.

Private Attributes
ParameterPTR	outdegree_

Additional Inherited Members
Protected Attributes inherited from nest::BipartiteConnBuilder
NodeCollectionPTR	sources_
	Population to connect from.
NodeCollectionPTR	targets_
	Population to connect to.
ThirdOutBuilder *	third_out_
	To be triggered when primary connection is created.
bool	allow_autapses_
bool	allow_multapses_
bool	make_symmetric_
bool	creates_symmetric_connections_
std::vector< std::exception_ptr >	exceptions_raised_
	buffer for exceptions raised in threads
std::string	pre_synaptic_element_name_
std::string	post_synaptic_element_name_
bool	use_structural_plasticity_
std::vector< ConnParameter * >	parameters_requiring_skipping_
	Pointers to connection parameters specified as arrays.
std::vector< size_t >	synapse_model_id_
std::vector< std::vector< Dictionary > >	param_dicts_
	Dictionaries to pass to connect function, one per thread for every syn_spec.

Constructor & Destructor Documentation

FixedOutDegreeBuilder()

nest::FixedOutDegreeBuilder::FixedOutDegreeBuilder	(	NodeCollectionPTR	sources,
		NodeCollectionPTR	targets,
		ThirdOutBuilder *	third_out,
		const Dictionary &	conn_spec,
		const std::vector< Dictionary > &	syn_specs
	)

References nest::BipartiteConnBuilder::allow_autapses_, nest::BipartiteConnBuilder::allow_multapses_, Dictionary::at(), Dictionary::get(), LOG, nest::names::outdegree(), outdegree_, nest::BipartiteConnBuilder::targets_, and nest::WARNING.

Here is the call graph for this function:

Member Function Documentation

connect_()

void nest::FixedOutDegreeBuilder::connect_ ( )

overrideprotectedvirtual

Implements the actual connection algorithm.

Implements nest::BipartiteConnBuilder.

References nest::BipartiteConnBuilder::allow_autapses_, nest::BipartiteConnBuilder::allow_multapses_, nest::BipartiteConnBuilder::exceptions_raised_, nest::NodeManager::get_node_or_proxy(), nest::get_rank_synced_rng(), nest::VPManager::get_thread_id(), nest::get_vp_specific_rng(), nest::kernel(), nest::KernelManager::node_manager, outdegree_, nest::BipartiteConnBuilder::single_connect_(), nest::BipartiteConnBuilder::skip_conn_parameter_(), nest::BipartiteConnBuilder::sources_, nest::BipartiteConnBuilder::targets_, nest::BaseRandomGenerator::ulrand(), and nest::KernelManager::vp_manager.

Here is the call graph for this function:

Member Data Documentation

outdegree_

ParameterPTR nest::FixedOutDegreeBuilder::outdegree_

private

Referenced by connect_(), and FixedOutDegreeBuilder().

---

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

• conn_builder.h
• conn_builder.cpp