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

#include <network_mixins.hpp>

Public Member Functions

const View range (NeuronIndex begin, NeuronIndex end) const
 
View range (NeuronIndex begin, NeuronIndex end)
 
const View operator() (NeuronIndex begin, NeuronIndex end) const
 
View operator() (NeuronIndex begin, NeuronIndex end)
 

Detailed Description

template<typename Impl, typename View, typename Accessor>
class cypress::ViewableMixin< Impl, View, Accessor >

Mixin used by the PopulationBase, PopulationViewBase, NeuronBase, Population, PopulationView and Neuron class to allow to provide a view (a subrange) of neurons in the object.

Member Function Documentation

template<typename Impl, typename View, typename Accessor>
const View cypress::ViewableMixin< Impl, View, Accessor >::operator() ( NeuronIndex  begin,
NeuronIndex  end 
) const
inline

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

Parameters
beginis the index of the first neuron in the resulting view, relative to the first neuron in this object.
endis 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.
template<typename Impl, typename View, typename Accessor>
View cypress::ViewableMixin< Impl, View, Accessor >::operator() ( NeuronIndex  begin,
NeuronIndex  end 
)
inline

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

Parameters
beginis the index of the first neuron in the resulting view, relative to the first neuron in this object.
endis 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.
template<typename Impl, typename View, typename Accessor>
const View cypress::ViewableMixin< Impl, View, Accessor >::range ( NeuronIndex  begin,
NeuronIndex  end 
) const
inline

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

Parameters
beginis the index of the first neuron in the resulting view, relative to the first neuron in this object.
endis 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.
template<typename Impl, typename View, typename Accessor>
View cypress::ViewableMixin< Impl, View, Accessor >::range ( NeuronIndex  begin,
NeuronIndex  end 
)
inline

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

Parameters
beginis the index of the first neuron in the resulting view, relative to the first neuron in this object.
endis 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.

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