#include <network_base_objects.hpp>

Inheritance diagram for cypress::PopulationBase:

[legend]

Collaboration diagram for cypress::PopulationBase:

[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
	PopulationBase (const NetworkBase &network, PopulationIndex pid)

NetworkBase	network () const

PopulationIndex	pid () const

const std::string &	name () const

PopulationBase &	name (const std::string &name)

size_t	size () const

bool	homogeneous_parameters () const

bool	homogeneous_record () const

bool	homogeneous_data () 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 NeuronType &	type () const

const NeuronParameters	parameters () const

NeuronParameters	parameters ()

const NeuronSignals	signals () const

NeuronSignals	signals ()

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

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

Detailed Description

The PopulationBase class represents a generic neuron population of neurons of any type. If possible, prefer the usage of Population<T>.

Member Typedef Documentation

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

inherited

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

inherited

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

inherited

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

inherited

Constructor & Destructor Documentation

cypress::PopulationBase::PopulationBase	(	const NetworkBase &	network,
		PopulationIndex	pid
	)

inline

Creates a population as a handle pointing at an already existing population with the given population index.

Parameters

network is the network in which the population is located. pid is the population index of the already existing population in the referenced network.

Member Function Documentation

iterator cypress::IterableMixin< PopulationBase , 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< PopulationBase , NeuronBase , Accessor >::begin ( ) const

inlineinherited

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

inlineinherited

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

inlineinherited

PopulationBase & cypress::ConnectableMixin< PopulationBase , 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.

PopulationBase & cypress::ConnectableMixin< PopulationBase , 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< PopulationBase , NeuronBase , Accessor >::crbegin ( ) const

inlineinherited

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

inlineinherited

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

inlineinherited

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

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

inlineinherited

bool cypress::PopulationMixin< PopulationBase , Accessor >::homogeneous_data ( ) const

inlineinherited

Returns true if the population possesses homogeneous data.

bool cypress::PopulationMixin< PopulationBase , Accessor >::homogeneous_parameters ( ) const

inlineinherited

Returns true if the population possesses homogeneous neuron parameters.

bool cypress::PopulationMixin< PopulationBase , Accessor >::homogeneous_record ( ) const

inlineinherited

Returns true if the population possesses homogeneous record flags.

const std::string& cypress::PopulationMixin< PopulationBase , Accessor >::name ( ) const

inlineinherited

Returns the name of the population.

PopulationBase & cypress::PopulationMixin< PopulationBase , Accessor >::name ( const std::string & name )

inlineinherited

Sets the name of the population and returns a reference at the population object.

NetworkBase cypress::PopulationBase::network ( ) const

inline

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

Returns: a NetworkBase object pointing at the network this neuron is located in.

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

inlineinherited

const PopulationViewBase cypress::ViewableMixin< PopulationBase , 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< PopulationBase , 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< PopulationBase , 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< PopulationBase , 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.

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

inlineinherited

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

inlineinherited

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

inlineinherited

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

inlineinherited

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

inlineinherited

NeuronBase cypress::IterableMixin< PopulationBase , 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< PopulationBase , 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< PopulationBase , 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< PopulationBase , 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::PopulationBase::pid ( ) const

inline

Returns the population index of this population.

Returns: the population index of this population.

const PopulationViewBase cypress::ViewableMixin< PopulationBase , 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< PopulationBase , 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< PopulationBase , NeuronBase , Accessor >::rbegin ( )

inlineinherited

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

inlineinherited

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

inlineinherited

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

inlineinherited

const NeuronSignals cypress::DataMixin< PopulationBase , 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< PopulationBase , 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::PopulationMixin< PopulationBase , Accessor >::size ( ) const

inlineinherited

Returns the number of neurons in the population.

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

inlineinherited

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

const NeuronType& cypress::DataMixin< PopulationBase , Accessor, NeuronParameters , NeuronSignals >::type ( ) const

inlineinherited

Returns the type of the population. All neurons share the same type.

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