cypress::StaticSynapse Class Reference

#include <synapses.hpp>

Inheritance diagram for cypress::StaticSynapse:

Collaboration diagram for cypress::StaticSynapse:

Public Member Functions
	StaticSynapse ()
	StaticSynapse (const StaticSynapse &synapse)
const std::string	name () const override
const std::vector< std::string > &	parameter_names () const override
const std::vector< std::string > &	parameter_units () const override
const std::vector< Real > &	parameter_defaults () const override
bool	learning () const override
	NAMED_PARAMETER (weight, 0)
	NAMED_PARAMETER (delay, 1)
const std::vector< Real > &	parameters () const
void	parameters (const std::vector< Real > &params)
Optional< size_t >	parameter_index (const std::string &name) const
void	set (size_t idx, Real value)
Real	operator[] (size_t i) const
const Real *	begin () const
const Real *	end () const
size_t	size () const

Static Public Member Functions
static std::shared_ptr< SynapseBase >	make_shared (SynapseBase &synapse)

Protected Member Functions
void	check_parameter_size ()

Protected Attributes
std::vector< Real >	m_params
bool	m_learning = false

Constructor & Destructor Documentation

cypress::StaticSynapse::StaticSynapse ( )

inline

cypress::StaticSynapse::StaticSynapse ( const StaticSynapse &  synapse )

inline

Member Function Documentation

const Real* cypress::SynapseBase::begin ( ) const

inlineinherited

Returns an iterator allowing to iterate over the parameter vector.

void cypress::SynapseBase::check_parameter_size ( )

inlineprotectedinherited

const Real* cypress::SynapseBase::end ( ) const

inlineinherited

Returns an iterator allowing to iterate over the parameter vector.

bool cypress::StaticSynapse::learning ( ) const

inlineoverridevirtual

Reimplemented from cypress::SynapseBase.

static std::shared_ptr<SynapseBase> cypress::SynapseBase::make_shared ( SynapseBase &  synapse )

staticinherited

Create a shared pointer from a reference. Checks the name of the synapse to create the correct type. This is to avoid creating a copy, which is then of type SynapseBase and member functions pointing to wrong name, parameter_names,...

Parameters

synapse

Reference to the synapse object to be copied and administered by a shared pointer

Returns

Shared pointer to a copy of synapse

const std::string cypress::StaticSynapse::name ( ) const

inlineoverridevirtual

Name of the neuron type.

Reimplemented from cypress::SynapseBase.

cypress::StaticSynapse::NAMED_PARAMETER	(	weight	,
		0
	)

cypress::StaticSynapse::NAMED_PARAMETER	(	delay	,
		1
	)

Real cypress::SynapseBase::operator[] ( size_t  i ) const

inlineinherited

Returns a read-only reference at the i-th element in the parameter vector.

const std::vector<Real>& cypress::StaticSynapse::parameter_defaults ( ) const

inlineoverridevirtual

Contains default values for the neuron parameters.

Reimplemented from cypress::SynapseBase.

Optional<size_t> cypress::SynapseBase::parameter_index ( const std::string &  name ) const

inlineinherited

Resolves the given parameter name into a parameter index.

const std::vector<std::string>& cypress::StaticSynapse::parameter_names ( ) const

inlineoverridevirtual

Name of all neuron parameters.

Reimplemented from cypress::SynapseBase.

const std::vector<std::string>& cypress::StaticSynapse::parameter_units ( ) const

inlineoverridevirtual

Units of all neuron parameters.

Reimplemented from cypress::SynapseBase.

const std::vector<Real>& cypress::SynapseBase::parameters ( ) const

inlineinherited

void cypress::SynapseBase::parameters ( const std::vector< Real > &  params )

inlineinherited

void cypress::SynapseBase::set ( size_t  idx, Real  value  )

inlineinherited

Sets the parameter with the given index to the specified value.

Parameters

idx	is the parameter that should be updated.
value	is the value the parameter should be set to.

size_t cypress::SynapseBase::size ( ) const

inlineinherited

Returns the size of the parameter vector. Aborts if the population is non-uniform.

Member Data Documentation

bool cypress::SynapseBase::m_learning = false

protectedinherited

std::vector<Real> cypress::SynapseBase::m_params

protectedinherited

---

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

• cypress/core/synapses.hpp