#include <network_base_objects.hpp>

Inheritance diagram for cypress::NeuronBase:

[legend]

Collaboration diagram for cypress::NeuronBase:

[legend]

Public Types
using	iterator = iterator_< 1, false >

using	const_iterator = iterator_< 1, true >

using	reverse_iterator = iterator_<-1, false >

using	const_reverse_iterator = iterator_<-1, true >

Public Member Functions
template<typename Parent >
	NeuronBase (const Parent &parent, NeuronIndex nid)

const NeuronType &	type () const

NetworkBase	network () const

PopulationBase	population () const

PopulationIndex	pid () const

NeuronIndex	nid () const

NeuronBase *	operator-> ()

const NeuronBase *	operator-> () const

NeuronBase &	operator* ()

const NeuronBase &	operator* () const

NeuronBase	operator[] (NeuronIndex i)

const NeuronBase	operator[] (NeuronIndex i) const

NeuronBase	operator() (NeuronIndex i)

const NeuronBase	operator() (NeuronIndex i) const

size_t	size ()

iterator	begin ()

const_iterator	begin () const

iterator	end ()

const_iterator	end () const

reverse_iterator	rbegin ()

const_reverse_iterator	rbegin () const

reverse_iterator	rend ()

const_reverse_iterator	rend () const

const_iterator	cbegin () const

const_iterator	cend () const

const_reverse_iterator	crbegin () const

const_reverse_iterator	crend () const

const PopulationViewBase	range (NeuronIndex begin, NeuronIndex end) const

PopulationViewBase	range (NeuronIndex begin, NeuronIndex end)

const PopulationViewBase	operator() (NeuronIndex begin, NeuronIndex end) const

PopulationViewBase	operator() (NeuronIndex begin, NeuronIndex end)

bool	operator== (const Other &o) const

bool	operator!= (const Other &o) const

bool	operator< (const Other &o) const

bool	operator<= (const Other &o) const

bool	operator> (const Other &o) const

bool	operator>= (const Other &o) const

const NeuronParameters	parameters () const

NeuronParameters	parameters ()

const NeuronSignals	signals () const

NeuronSignals	signals ()

NeuronBase &	connect_to (TargetIterator tar_begin, TargetIterator tar_end, std::unique_ptr< Connector > connector, const char *name="")

NeuronBase &	connect_to (const Target &tar, std::unique_ptr< Connector > connector, const char *name="")

Detailed Description

The NeuronBase class represents a generic neuron of any type. If possible, prefer the usage of Neuron<T>.

Member Typedef Documentation

using cypress::IterableMixin< NeuronBase , NeuronBase , Accessor >::const_iterator = iterator_<1, true>

inherited

using cypress::IterableMixin< NeuronBase , NeuronBase , Accessor >::const_reverse_iterator = iterator_<-1, true>

inherited

using cypress::IterableMixin< NeuronBase , NeuronBase , Accessor >::iterator = iterator_<1, false>

inherited

using cypress::IterableMixin< NeuronBase , NeuronBase , Accessor >::reverse_iterator = iterator_<-1, false>

inherited

Constructor & Destructor Documentation

template<typename Parent >

cypress::NeuronBase::NeuronBase	(	const Parent &	parent,
		NeuronIndex	nid
	)

inline

Creates a NeuronBase object pointing at the nid-th neuron in the given neuron population.

Parameters

paraneter	is the neuron population or population view the neuron# is located in.
nid	is the absolute index of the neuron in its population.

Member Function Documentation

iterator cypress::IterableMixin< NeuronBase , NeuronBase , Accessor >::begin ( )

inlineinherited

Returns an iterator at the first neuron in the population. For neurons, returns an iterator pointing at the neuron itself.

const_iterator cypress::IterableMixin< NeuronBase , NeuronBase , Accessor >::begin ( ) const

inlineinherited

const_iterator cypress::IterableMixin< NeuronBase , NeuronBase , Accessor >::cbegin ( ) const

inlineinherited

const_iterator cypress::IterableMixin< NeuronBase , NeuronBase , Accessor >::cend ( ) const

inlineinherited

NeuronBase & cypress::ConnectableMixin< NeuronBase , Accessor >::connect_to	(	TargetIterator	tar_begin,
		TargetIterator	tar_end,
		std::unique_ptr< Connector >	connector,
		const char *	name = `""`
	)

inlineinherited

Connects all neurons in this Population, PopulationView or Neuron with a range of neurons indicated by the given iterators.

Parameters

tar_begin	is an iterator pointing at the first neuron in the target population that should be connected.
tar_end	is an iterator pointing at the last neuron in the target population that should be connected.
connector	is the object establishing the actual connections.

Returns: a reference at this object for function chaining.

NeuronBase & cypress::ConnectableMixin< NeuronBase , Accessor >::connect_to	(	const Target &	tar,
		std::unique_ptr< Connector >	connector,
		const char *	name = `""`
	)

inlineinherited

Connects all neurons in this Population, PopulationView or Neuron with the given target, which may be a Population, PopulationView or a single neuron.

Parameters

tar	is the object this object should be connected with.
connector	is the object establishing the actual connections.

Returns: a reference at this object for function chaining.

const_reverse_iterator cypress::IterableMixin< NeuronBase , NeuronBase , Accessor >::crbegin ( ) const

inlineinherited

const_reverse_iterator cypress::IterableMixin< NeuronBase , NeuronBase , Accessor >::crend ( ) const

inlineinherited

iterator cypress::IterableMixin< NeuronBase , NeuronBase , Accessor >::end ( )

inlineinherited

Returns an iterator at the last-plus-one neuron in the population.

const_iterator cypress::IterableMixin< NeuronBase , NeuronBase , Accessor >::end ( ) const

inlineinherited

NetworkBase cypress::NeuronBase::network ( ) const

inline

Returns a reference at the network instance the neuron is part of.

NeuronIndex cypress::NeuronBase::nid ( ) const

inline

Returns the index of this neuron within its population. Note that this index is never relative to the start index of a population view but always relative to the population itself.

bool cypress::DataMixin< NeuronBase , Accessor, NeuronParameters , NeuronSignals >::operator!= ( const Other & o ) const

inlineinherited

const PopulationViewBase cypress::ViewableMixin< NeuronBase , PopulationViewBase , Accessor >::operator()	(	NeuronIndex	begin,
		NeuronIndex	end
	)		const

inlineinherited

Returns a constant View object representing a range of neurons relative to this object.

Parameters

begin	is the index of the first neuron in the resulting view, relative to the first neuron in this object.
end	is the index of the last-plus-one neuron in the resulting view, relative to the first neuron in this object.

Returns: a new view representing only the given range of neurons.

PopulationViewBase cypress::ViewableMixin< NeuronBase , PopulationViewBase , Accessor >::operator()	(	NeuronIndex	begin,
		NeuronIndex	end
	)

inlineinherited

Returns a View object representing a range of neurons relative to this object.

Parameters

begin	is the index of the first neuron in the resulting view, relative to the first neuron in this object.
end	is the index of the last-plus-one neuron in the resulting view, relative to the first neuron in this object.

Returns: a new view representing only the given range of neurons.

NeuronBase cypress::IterableMixin< NeuronBase , NeuronBase , Accessor >::operator() ( NeuronIndex i )

inlineinherited

Returns a reference at the i-th neuron in the Population or PopulationView. For neurons, only the index zero is allowed, providing access at the neuron itself.

const NeuronBase cypress::IterableMixin< NeuronBase , NeuronBase , Accessor >::operator() ( NeuronIndex i ) const

inlineinherited

Returns a const-reference at the i-th neuron. For neurons, only the index zero is allowed, providing access at the neuron itself.

NeuronBase & cypress::NeuronMixin< NeuronBase >::operator* ( )

inlineinherited

const NeuronBase & cypress::NeuronMixin< NeuronBase >::operator* ( ) const

inlineinherited

NeuronBase * cypress::NeuronMixin< NeuronBase >::operator-> ( )

inlineinherited

const NeuronBase * cypress::NeuronMixin< NeuronBase >::operator-> ( ) const

inlineinherited

bool cypress::DataMixin< NeuronBase , Accessor, NeuronParameters , NeuronSignals >::operator< ( const Other & o ) const

inlineinherited

bool cypress::DataMixin< NeuronBase , Accessor, NeuronParameters , NeuronSignals >::operator<= ( const Other & o ) const

inlineinherited

bool cypress::DataMixin< NeuronBase , Accessor, NeuronParameters , NeuronSignals >::operator== ( const Other & o ) const

inlineinherited

bool cypress::DataMixin< NeuronBase , Accessor, NeuronParameters , NeuronSignals >::operator> ( const Other & o ) const

inlineinherited

bool cypress::DataMixin< NeuronBase , Accessor, NeuronParameters , NeuronSignals >::operator>= ( const Other & o ) const

inlineinherited

NeuronBase cypress::IterableMixin< NeuronBase , NeuronBase , Accessor >::operator[] ( NeuronIndex i )

inlineinherited

Returns a reference at the i-th neuron in the Population or PopulationView. For neurons, only the index zero is allowed, providing access at the neuron itself.

const NeuronBase cypress::IterableMixin< NeuronBase , NeuronBase , Accessor >::operator[] ( NeuronIndex i ) const

inlineinherited

Returns a const-reference at the i-th neuron. For neurons, only the index zero is allowed, providing access at the neuron itself.

const NeuronParameters cypress::DataMixin< NeuronBase , Accessor, NeuronParameters , NeuronSignals >::parameters ( ) const

inlineinherited

Returns an object which can be used for reading the parameters of the neurons represented by this object. Note that read access may be constrained when the parameters in the underlying neurons do not possess the same parameters.

NeuronParameters cypress::DataMixin< NeuronBase , Accessor, NeuronParameters , NeuronSignals >::parameters ( )

inlineinherited

Returns an object which can be used for setting the parameters of the neurons. Note that read access may be constrained when the parameters in the underlying neurons do not possess the same parameters.

PopulationIndex cypress::NeuronBase::pid ( ) const

inline

Returns the population index of the population this neuron belongs to.

PopulationBase cypress::NeuronBase::population ( ) const

inline

Returns a handle pointing at the population this neuron is located in.

Returns: a PopulationBase object pointing at the population this neuron is located in.

const PopulationViewBase cypress::ViewableMixin< NeuronBase , PopulationViewBase , Accessor >::range	(	NeuronIndex	begin,
		NeuronIndex	end
	)		const

inlineinherited

Returns a constant View object representing a range of neurons relative to this object.

Parameters

begin	is the index of the first neuron in the resulting view, relative to the first neuron in this object.
end	is the index of the last-plus-one neuron in the resulting view, relative to the first neuron in this object.

Returns: a new view representing only the given range of neurons.

PopulationViewBase cypress::ViewableMixin< NeuronBase , PopulationViewBase , Accessor >::range	(	NeuronIndex	begin,
		NeuronIndex	end
	)

inlineinherited

Returns a View object representing a range of neurons relative to this object.

Parameters

begin	is the index of the first neuron in the resulting view, relative to the first neuron in this object.
end	is the index of the last-plus-one neuron in the resulting view, relative to the first neuron in this object.

Returns: a new view representing only the given range of neurons.

reverse_iterator cypress::IterableMixin< NeuronBase , NeuronBase , Accessor >::rbegin ( )

inlineinherited

const_reverse_iterator cypress::IterableMixin< NeuronBase , NeuronBase , Accessor >::rbegin ( ) const

inlineinherited

reverse_iterator cypress::IterableMixin< NeuronBase , NeuronBase , Accessor >::rend ( )

inlineinherited

const_reverse_iterator cypress::IterableMixin< NeuronBase , NeuronBase , Accessor >::rend ( ) const

inlineinherited

const NeuronSignals cypress::DataMixin< NeuronBase , Accessor, NeuronParameters , NeuronSignals >::signals ( ) const

inlineinherited

Returns an object which can be used for reading the record flags and the recorded data.

NeuronSignals cypress::DataMixin< NeuronBase , Accessor, NeuronParameters , NeuronSignals >::signals ( )

inlineinherited

Returns an object which can be used for reading and writing the record flags and the recorded data.

size_t cypress::IterableMixin< NeuronBase , NeuronBase , Accessor >::size ( )

inlineinherited

Returns the size of the population or population view. For single neurons the size is always one.

const NeuronType& cypress::NeuronBase::type ( ) const

inline

Returns the type of the neuron.

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

cypress/core/network_base_objects.hpp

Public Types

Public Member Functions

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation