cypress::LocalConnection Struct Reference

#include <connector.hpp>

Collaboration diagram for cypress::LocalConnection:

Public Member Functions
	LocalConnection (uint32_t src=0, uint32_t tar=0, Real weight=0.0, Real delay=0.0)
	LocalConnection (uint32_t src, uint32_t tar, SynapseBase &synapse)
bool	valid () const
bool	excitatory () const
bool	inhibitory () const
LocalConnection	absolute_connection ()
bool	operator== (const LocalConnection &s) const
bool	operator< (const LocalConnection &s) const

Public Attributes
NeuronIndex	src
NeuronIndex	tar
std::vector< Real >	SynapseParameters

Detailed Description

The LocalConnection class is a stripped-down version of the Connection class which only contains the neuron indices and not the source and target population indices.

Constructor & Destructor Documentation

cypress::LocalConnection::LocalConnection ( uint32_t  src = 0, uint32_t  tar = 0, Real  weight = 0.0, Real  delay = 0.0  )

inline

Constructor of the Connection class. Per default all fields are initialised with zero.

cypress::LocalConnection::LocalConnection ( uint32_t  src, uint32_t  tar, SynapseBase &  synapse  )

inline

Member Function Documentation

LocalConnection cypress::LocalConnection::absolute_connection ( )

inline

Returns a LocalConnection with absolute value of the weight

bool cypress::LocalConnection::excitatory ( ) const

inline

Returns true if the synapse is excitatory.

bool cypress::LocalConnection::inhibitory ( ) const

inline

Returns true if the synapse is inhibitory.

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

inline

Used to sort the connections by their valid status, their population ids and their neuron ids. The precedence of these fields is: validity, psrc, ptar, nsrc, ntar. Invalid neurons are sorted to the end to be able to simply throw them away.

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

inline

Checks whether two Connection instances are equal.

bool cypress::LocalConnection::valid ( ) const

inline

Checks whether the connection is valid.

Member Data Documentation

NeuronIndex cypress::LocalConnection::src

Source neuron index within the specified source population.

std::vector<Real> cypress::LocalConnection::SynapseParameters

Synaptic properties.

NeuronIndex cypress::LocalConnection::tar

Target neuron index within the specified target population.

---

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

• cypress/core/connector.hpp