#include <connector.hpp>

Public Member Functions
	ConnectionDescriptor (uint32_t pid_src, uint32_t nid_src0, uint32_t nid_src1, uint32_t pid_tar, uint32_t nid_tar0, uint32_t nid_tar1, std::shared_ptr< Connector > connector=nullptr, const char *label="")

PopulationIndex	pid_src () const

NeuronIndex	nid_src0 () const

NeuronIndex	nid_src1 () const

PopulationIndex	pid_tar () const

NeuronIndex	nid_tar0 () const

NeuronIndex	nid_tar1 () const

Connector &	connector () const

void	update_connector (std::shared_ptr< Connector > connector)

void	connect (std::vector< LocalConnection > &tar) const

bool	valid () const

NeuronIndex	nsrc () const

NeuronIndex	ntar () const

bool	operator== (const ConnectionDescriptor &s) const

bool	operator< (const ConnectionDescriptor &s) const

size_t	size ()

const std::string &	label () const

Detailed Description

The ConnectionDescriptor represents a user-defined connection between two neuron populations.

Constructor & Destructor Documentation

cypress::ConnectionDescriptor::ConnectionDescriptor	(	uint32_t	pid_src,
		uint32_t	nid_src0,
		uint32_t	nid_src1,
		uint32_t	pid_tar,
		uint32_t	nid_tar0,
		uint32_t	nid_tar1,
		std::shared_ptr< Connector >	connector = `nullptr`,
		const char *	label = `""`
	)

inline

Constructor of the ConnectionDescriptor class.

Member Function Documentation

void cypress::ConnectionDescriptor::connect ( std::vector< LocalConnection > & tar ) const

inline

Tells the Connector to actually create the neuron-to-neuron connections between certain neurons.

Parameters

tar	is the target vector to which the connections should be written.

Connector& cypress::ConnectionDescriptor::connector ( ) const

inline

Returns a const reference at the underlying connector instance – the class which actually fills the connection table.

const std::string& cypress::ConnectionDescriptor::label ( ) const

inline

Return custom connection label

Returns: label of the connection

NeuronIndex cypress::ConnectionDescriptor::nid_src0 ( ) const

inline

Index of the first neuron in the source population involved in the connection.

NeuronIndex cypress::ConnectionDescriptor::nid_src1 ( ) const

inline

Index of the last-plus-one neuron in the target population involved in the connection.

NeuronIndex cypress::ConnectionDescriptor::nid_tar0 ( ) const

inline

Index of the first neuron in the target population involved in the connection.

NeuronIndex cypress::ConnectionDescriptor::nid_tar1 ( ) const

inline

Index of the last-plus-one neuron in the target population involved in the connection.

NeuronIndex cypress::ConnectionDescriptor::nsrc ( ) const

inline

Returns the number of neurons in the source population.

NeuronIndex cypress::ConnectionDescriptor::ntar ( ) const

inline

Returns the number of neurons in the target population.

bool cypress::ConnectionDescriptor::operator< ( const ConnectionDescriptor & s ) const

inline

Used to sort the connections by their source id.

bool cypress::ConnectionDescriptor::operator== ( const ConnectionDescriptor & s ) const

inline

Checks whether two Connection instances are equal, apart from the connector.

PopulationIndex cypress::ConnectionDescriptor::pid_src ( ) const

inline

The source population id.

PopulationIndex cypress::ConnectionDescriptor::pid_tar ( ) const

inline

The target population id.

size_t cypress::ConnectionDescriptor::size ( )

inline

void cypress::ConnectionDescriptor::update_connector ( std::shared_ptr< Connector > connector )

inline

Change the underlying connector

bool cypress::ConnectionDescriptor::valid ( ) const

inline

Returns true if the connector is valid.

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

cypress/core/connector.hpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation