Cypress  1.0
C++ Spiking Neural Network Simulation Framework
Public Member Functions | Protected Member Functions | List of all members
cypress::transformations::CFToSA Class Referenceabstract

#include <spike_sources.hpp>

Inheritance diagram for cypress::transformations::CFToSA:
Inheritance graph
[legend]
Collaboration diagram for cypress::transformations::CFToSA:
Collaboration graph
[legend]

Public Member Functions

std::string id () const override
 
 ~CFToSA ()
 
virtual TransformationProperties properties () const
 
NetworkBase transform (const NetworkBase &src, TransformationAuxData &aux)
 
void copy_results (const NetworkBase &src, NetworkBase &tar) const
 

Protected Member Functions

void do_transform_parameters (const SpikeSourceConstFreqParameters &src, SpikeSourceArrayParameters tar) override
 
bool do_dehomogenise_parameters (const SpikeSourceConstFreqParameters &src) override
 
void do_transform_signals (const SpikeSourceConstFreqSignals &src, SpikeSourceArraySignals tar) override
 
const NeuronTypesrc_type ()
 
const NeuronTypetar_type ()
 
NetworkBase do_transform (const NetworkBase &src, TransformationAuxData &) override
 
virtual void do_transform_parameters (const typename SpikeSourceConstFreq::Parameters &src, typename SpikeSourceArray::Parameters tar)=0
 
virtual bool do_dehomogenise_parameters (const typename SpikeSourceConstFreq::Parameters &)
 
virtual void do_transform_signals (const typename SpikeSourceConstFreq::Signals &src, typename SpikeSourceArray::Signals tar)=0
 
virtual void do_copy_results (const NetworkBase &src, NetworkBase &tar) const
 

Detailed Description

Transforms a SpikeSourceConstFreq neuron to a SpikeSourceArray neuron.

Constructor & Destructor Documentation

cypress::transformations::CFToSA::~CFToSA ( )
inline

Member Function Documentation

void cypress::Transformation::copy_results ( const NetworkBase src,
NetworkBase tar 
) const
inherited

Copys the results from a transformed network to the original network.

virtual void cypress::Transformation::do_copy_results ( const NetworkBase src,
NetworkBase tar 
) const
protectedvirtualinherited

Function called after the network was executed. This function should copy recorded data from the actually executed network to the target network. This function must be overriden if the network topology (including the neuron type) was changed by the transformation. Otherwise a default implementation is used.

virtual bool cypress::NeuronTypeTransformation< SpikeSourceConstFreq , SpikeSourceArray >::do_dehomogenise_parameters ( const typename SpikeSourceConstFreq ::Parameters &  )
inlineprotectedvirtualinherited
bool cypress::transformations::CFToSA::do_dehomogenise_parameters ( const SpikeSourceConstFreqParameters src)
overrideprotected
NetworkBase cypress::NeuronTypeTransformation< SpikeSourceConstFreq , SpikeSourceArray >::do_transform ( const NetworkBase src,
TransformationAuxData  
)
inlineoverrideprotectedvirtualinherited

Function which should be overriden by child classes. This function should perform the actual transformation an remember which changes were done.

Parameters
srcis the network which should be modified.
Returns
is a new Network instance which contains the transformed data.

Implements cypress::Transformation.

virtual void cypress::NeuronTypeTransformation< SpikeSourceConstFreq , SpikeSourceArray >::do_transform_parameters ( const typename SpikeSourceConstFreq ::Parameters &  src,
typename SpikeSourceArray ::Parameters  tar 
)
protectedpure virtualinherited
void cypress::transformations::CFToSA::do_transform_parameters ( const SpikeSourceConstFreqParameters src,
SpikeSourceArrayParameters  tar 
)
overrideprotected
void cypress::transformations::CFToSA::do_transform_signals ( const SpikeSourceConstFreqSignals src,
SpikeSourceArraySignals  tar 
)
overrideprotected
virtual void cypress::NeuronTypeTransformation< SpikeSourceConstFreq , SpikeSourceArray >::do_transform_signals ( const typename SpikeSourceConstFreq ::Signals &  src,
typename SpikeSourceArray ::Signals  tar 
)
protectedpure virtualinherited
std::string cypress::transformations::CFToSA::id ( ) const
inlineoverridevirtual

Returns an id which can for example be used to explicitly disable certain transformations.

Returns
a unique ID describing this transformation.

Implements cypress::Transformation.

virtual TransformationProperties cypress::Transformation::properties ( ) const
inlinevirtualinherited

Returns a structure describing the transformation, e.g. whether it is lossy or the priority with which it should be applied.

Returns
an instance of Transformation properties which contains information about this particular transformation.

Reimplemented in cypress::transformations::LIFToIFFH1.

const NeuronType* cypress::NeuronTypeTransformation< SpikeSourceConstFreq , SpikeSourceArray >::src_type ( )
inlineprotectedinherited
const NeuronType* cypress::NeuronTypeTransformation< SpikeSourceConstFreq , SpikeSourceArray >::tar_type ( )
inlineprotectedinherited
NetworkBase cypress::Transformation::transform ( const NetworkBase src,
TransformationAuxData aux 
)
inherited

Performs the transformation on the given network instance.

Parameters
srcis the network which should be modified.
auxis some auxiliary data which may be modified by the transformation.
Returns
is a new Network instance which contains the transformed data.

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