cypress::ConstantSizeNeuronParametersBase< Impl, Type, Size > Class Template Reference

#include <neurons_base.hpp>

Inheritance diagram for cypress::ConstantSizeNeuronParametersBase< Impl, Type, Size >:

Collaboration diagram for cypress::ConstantSizeNeuronParametersBase< Impl, Type, Size >:

Public Types
using	Type = Type

Public Member Functions
	ConstantSizeNeuronParametersBase ()=default
	ConstantSizeNeuronParametersBase (const std::vector< Real > &parameters)
const std::vector< Real > &	parameters () const
void	parameters (std::vector< Real > parameters)
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 constexpr size_t	size ()

Protected Member Functions
const PopulationData &	population_data () const
PopulationData &	population_data ()
size_t	get_parameters_size () const
size_t	get_record_size () const
size_t	get_data_size () const
const auto &	read_parameters () const
const auto &	read_record () const
const auto &	read_data () const
auto	write_parameters (bool partial=true)
auto	write_record (bool partial=true)
auto	write_data (bool partial=true)

Static Protected Member Functions
template<typename Seq >
static Seq::value_type	from_sequence (Seq list)

Detailed Description

template<typename Impl, typename Type, size_t Size>
class cypress::ConstantSizeNeuronParametersBase< Impl, Type, Size >

Template class for building a parameter vector which has a pre-defined size.

Member Typedef Documentation

using cypress::NeuronParametersBase< Impl, Type >::Type = Type

inherited

The neuron type associated with this NeuronSignals class.

Constructor & Destructor Documentation

template<typename Impl, typename Type, size_t Size>

cypress::ConstantSizeNeuronParametersBase< Impl, Type, Size >::ConstantSizeNeuronParametersBase ( )

default

Default constructor.

template<typename Impl, typename Type, size_t Size>

cypress::ConstantSizeNeuronParametersBase< Impl, Type, Size >::ConstantSizeNeuronParametersBase ( const std::vector< Real > &  parameters )

inline

Constructor allowing to set the neuron parameters to the given values.

Member Function Documentation

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

inlineinherited

Returns an iterator allowing to iterate over the parameter vector.

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

inlineinherited

Returns an iterator allowing to iterate over the parameter vector.

template<typename Seq >

static Seq::value_type cypress::PopulationDataView::from_sequence ( Seq  list )

inlinestaticprotectedinherited

Templated method which allows to construct a PopulationDataView with its own data from a list of PopulationData objects. This method is used by the various neuron parameter and signal implementations to be able to supply a list of parameters/signals to the various constructors.

size_t cypress::PopulationDataView::get_data_size ( ) const

inlineprotectedinherited

Returns the size of the record vector. Throws an exception if the neurons in the given range do not share parameters of the same size.

Returns

the number of entires in the data array.

size_t cypress::PopulationDataView::get_parameters_size ( ) const

inlineprotectedinherited

Returns the size of the parameter vector. Throws an exception if the neurons in the given range do not share parameters of the same size.

Returns

the number of parameters in the parameter array.

size_t cypress::PopulationDataView::get_record_size ( ) const

inlineprotectedinherited

Returns the size of the record vector. Throws an exception if the neurons in the given range do not share parameters of the same size.

Returns

the number of entires in the record array.

Real cypress::NeuronParameters::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::NeuronParameters::parameters ( ) const

inlineinherited

Returns a read-only reference at the parameter vector.

void cypress::NeuronParameters::parameters ( std::vector< Real >  parameters )

inlineinherited

Sets the all parameters at once. Use with caution, parameters have to be in the correct order

Parameters

parameters

vector of parameters

const PopulationData& cypress::PopulationDataView::population_data ( ) const

inlineprotectedinherited

Returns a const reference at the underlying PopulationData.

PopulationData& cypress::PopulationDataView::population_data ( )

inlineprotectedinherited

Returns a reference at the underlying PopulationData.

const auto& cypress::PopulationDataView::read_data ( ) const

inlineprotectedinherited

Returns a const-reference at the vector containing the recorded data for the neurons represented by this view. Throws an exception if the neurons in this view do not share the same record flags.

Returns

the record data shared by the neurons in the given range.

const auto& cypress::PopulationDataView::read_parameters ( ) const

inlineprotectedinherited

Returns a const-reference at the parameter vector for the neurons represented by this view. Throws an exception if the neurons in this view do not share the same parameters.

Returns

the parameters shared by the neurons in the given range.

const auto& cypress::PopulationDataView::read_record ( ) const

inlineprotectedinherited

Returns a const-reference at the vector specifying whether a signal should be recorded or not for the neurons represented by this view. Throws an exception if the neurons in this view do not share the same record flags.

Returns

the record flags shared by the neurons in the given range.

void cypress::NeuronParameters::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::NeuronParameters::size ( ) const

inlineinherited

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

template<typename Impl, typename Type, size_t Size>

static constexpr size_t cypress::ConstantSizeNeuronParametersBase< Impl, Type, Size >::size ( )

inlinestatic

Returns the constant size of the parameter vector.

auto cypress::PopulationDataView::write_data ( bool  partial = true )

inlineprotectedinherited

Returns an iteratble range allowing to write the recorded data for the range of neurons represented by this vie2. Assumes that the data is being set to the same value for the specified range.

Parameters

partial

if true, indicates that the record data is not entirely overridden, preventing the method from re-homogenising the data.

Returns

an iterable object pointing at the recorded data for the specified neuron range.

auto cypress::PopulationDataView::write_parameters ( bool  partial = true )

inlineprotectedinherited

Returns an iterable range allowing to modify the parameters for the range of neurons represented by this view. Assumes that the data is being set to the same value for the specified range.

Parameters

partial

if true, indicates that the parameters are not entirely overridden, preventing the method from re-homogenising the data.

Returns

an iterable object pointing at the parameters for the specified neuron range.

auto cypress::PopulationDataView::write_record ( bool  partial = true )

inlineprotectedinherited

Returns an iteratble range allowing to modify the record flags for the range of neurons represented by this view. Assumes that the data is being set to the same value for the specified range.

Parameters

partial

if true, indicates that the record flags are not entirely overridden, preventing the method from re-homogenising the data.

Returns

an iterable object pointing at the record flags for the specified neuron range.

---

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

• cypress/core/neurons_base.hpp