Cypress  1.0
C++ Spiking Neural Network Simulation Framework
Classes | Public Types | Public Member Functions | List of all members
cypress::IterableMixin< Impl, Value, Accessor > Class Template Reference

#include <network_mixins.hpp>

Classes

class  iterator_
 

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

Value operator[] (NeuronIndex i)
 
const Value operator[] (NeuronIndex i) const
 
Value operator() (NeuronIndex i)
 
const Value operator() (NeuronIndex i) const
 
size_t size ()
 
iterator begin ()
 
iterator end ()
 
reverse_iterator rbegin ()
 
reverse_iterator rend ()
 
const_iterator begin () const
 
const_iterator end () const
 
const_reverse_iterator rbegin () const
 
const_reverse_iterator rend () const
 
const_iterator cbegin () const
 
const_iterator cend () const
 
const_reverse_iterator crbegin () const
 
const_reverse_iterator crend () const
 

Detailed Description

template<typename Impl, typename Value, typename Accessor>
class cypress::IterableMixin< Impl, Value, Accessor >

Mixin used by the PopulationBase, PopulationViewBase, NeuronBase, Population, PopulationView and Neuron class to allow to provide exactly the same interface for iterating.

Member Typedef Documentation

template<typename Impl, typename Value, typename Accessor>
using cypress::IterableMixin< Impl, Value, Accessor >::const_iterator = iterator_<1, true>
template<typename Impl, typename Value, typename Accessor>
using cypress::IterableMixin< Impl, Value, Accessor >::const_reverse_iterator = iterator_<-1, true>
template<typename Impl, typename Value, typename Accessor>
using cypress::IterableMixin< Impl, Value, Accessor >::iterator = iterator_<1, false>
template<typename Impl, typename Value, typename Accessor>
using cypress::IterableMixin< Impl, Value, Accessor >::reverse_iterator = iterator_<-1, false>

Member Function Documentation

template<typename Impl, typename Value, typename Accessor>
iterator cypress::IterableMixin< Impl, Value, Accessor >::begin ( )
inline

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

template<typename Impl, typename Value, typename Accessor>
const_iterator cypress::IterableMixin< Impl, Value, Accessor >::begin ( ) const
inline
template<typename Impl, typename Value, typename Accessor>
const_iterator cypress::IterableMixin< Impl, Value, Accessor >::cbegin ( ) const
inline
template<typename Impl, typename Value, typename Accessor>
const_iterator cypress::IterableMixin< Impl, Value, Accessor >::cend ( ) const
inline
template<typename Impl, typename Value, typename Accessor>
const_reverse_iterator cypress::IterableMixin< Impl, Value, Accessor >::crbegin ( ) const
inline
template<typename Impl, typename Value, typename Accessor>
const_reverse_iterator cypress::IterableMixin< Impl, Value, Accessor >::crend ( ) const
inline
template<typename Impl, typename Value, typename Accessor>
iterator cypress::IterableMixin< Impl, Value, Accessor >::end ( )
inline

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

template<typename Impl, typename Value, typename Accessor>
const_iterator cypress::IterableMixin< Impl, Value, Accessor >::end ( ) const
inline
template<typename Impl, typename Value, typename Accessor>
Value cypress::IterableMixin< Impl, Value, Accessor >::operator() ( NeuronIndex  i)
inline

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.

template<typename Impl, typename Value, typename Accessor>
const Value cypress::IterableMixin< Impl, Value, Accessor >::operator() ( NeuronIndex  i) const
inline

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

template<typename Impl, typename Value, typename Accessor>
Value cypress::IterableMixin< Impl, Value, Accessor >::operator[] ( NeuronIndex  i)
inline

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.

template<typename Impl, typename Value, typename Accessor>
const Value cypress::IterableMixin< Impl, Value, Accessor >::operator[] ( NeuronIndex  i) const
inline

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

template<typename Impl, typename Value, typename Accessor>
reverse_iterator cypress::IterableMixin< Impl, Value, Accessor >::rbegin ( )
inline
template<typename Impl, typename Value, typename Accessor>
const_reverse_iterator cypress::IterableMixin< Impl, Value, Accessor >::rbegin ( ) const
inline
template<typename Impl, typename Value, typename Accessor>
reverse_iterator cypress::IterableMixin< Impl, Value, Accessor >::rend ( )
inline
template<typename Impl, typename Value, typename Accessor>
const_reverse_iterator cypress::IterableMixin< Impl, Value, Accessor >::rend ( ) const
inline
template<typename Impl, typename Value, typename Accessor>
size_t cypress::IterableMixin< Impl, Value, Accessor >::size ( )
inline

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


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