AllNeuroEdges Class Reference

Inheritance diagram for AllNeuroEdges:

Collaboration diagram for AllNeuroEdges:

Public Member Functions
virtual void	setupEdges () override
	Setup the internal structure of the class (allocate memories and initialize them).
virtual void	resetEdge (BGSIZE iEdg, BGFLOAT deltaT)
int	edgSign (const edgeType type)
virtual void	printSynapsesProps () const
	Prints SynapsesProps data to console.
template<class Archive >
void	serialize (Archive &archive)
	Cereal serialization method.
Public Member Functions inherited from AllEdges
	AllEdges (int numVertices, int maxEdges)
virtual void	loadParameters ()
virtual void	printParameters () const
virtual BGSIZE	addEdge (edgeType type, int srcVertex, int destVertex, BGFLOAT deltaT)
virtual void	createEdge (BGSIZE iEdg, int srcVertex, int destVertex, BGFLOAT deltaT, edgeType type)=0
virtual void	createEdgeIndexMap (EdgeIndexMap &edgeIndexMap)
	Populate a edge index map.
template<class Archive >
void	serialize (Archive &archive)
	Cereal serialization method.
virtual void	advanceEdges (AllVertices &vertices, EdgeIndexMap &edgeIndexMap)
virtual void	advanceEdge (BGSIZE iEdg, AllVertices &vertices)=0
virtual void	eraseEdge (int neuronIndex, BGSIZE iEdg)

Public Attributes
vector< BGFLOAT >	psr_
Public Attributes inherited from AllEdges
vector< int >	sourceVertexIndex_
	The location of the edge.
vector< int >	destVertexIndex_
	The coordinates of the summation point.
vector< BGFLOAT >	W_
	The weight (scaling factor, strength, maximal amplitude) of the edge.
vector< edgeType >	type_
	Synapse type.
vector< unsigned char >	inUse_
	The value indicating the entry in the array is in use.
vector< BGSIZE >	edgeCounts_
BGSIZE	totalEdgeCount_
	The total number of active edges.
BGSIZE	maxEdgesPerVertex_
	The maximum number of edges for each vertex.
int	countVertices_

Static Public Attributes
static constexpr BGFLOAT	SYNAPSE_STRENGTH_ADJUSTMENT = 1.0e-8
	The factor to adjust overlapping area to edge weight.

Protected Member Functions
virtual void	setupEdges (int numVertices, int maxEdges) override
	Setup the internal structure of the class (allocate memories and initialize them).
virtual void	readEdge (istream &input, BGSIZE iEdg) override
virtual void	writeEdge (ostream &output, BGSIZE iEdg) const override
Protected Member Functions inherited from AllEdges
edgeType	edgeOrdinalToType (int typeOrdinal)

Additional Inherited Members
Protected Attributes inherited from AllEdges
log4cplus::Logger	fileLogger_
	Loggers used to print to using log4cplus logging macros, prints to Results/Debug/logging.txt.
log4cplus::Logger	edgeLogger_

Detailed Description

Definition at line 50 of file AllNeuroEdges.h.

Member Function Documentation

edgSign()

int AllNeuroEdges::edgSign

(

const edgeType

type

)

Get the sign of the edgeType.

Parameters

type	edgeType I to I, I to E, E to I, or E to E

Returns

1 or -1, or 0 if error

Definition at line 83 of file AllNeuroEdges.cpp.

printSynapsesProps()

void AllNeuroEdges::printSynapsesProps ( ) const

virtual

Prints SynapsesProps data to console.

Reimplemented in AllDSSynapses, AllDynamicSTDPSynapses, AllSpikingSynapses, and AllSTDPSynapses.

Definition at line 102 of file AllNeuroEdges.cpp.

readEdge()

void AllNeuroEdges::readEdge ( istream & input, BGSIZE iEdg )

overrideprotectedvirtual

Sets the data for Synapse to input's data.

Parameters

input	istream to read from.
iEdg	Index of the edge to set.

Reimplemented from AllEdges.

Reimplemented in AllDSSynapses, AllDynamicSTDPSynapses, AllSpikingSynapses, and AllSTDPSynapses.

Definition at line 44 of file AllNeuroEdges.cpp.

resetEdge()

void AllNeuroEdges::resetEdge ( BGSIZE iEdg, BGFLOAT deltaT )

virtual

Reset time varying state vars and recompute decay.

Parameters

iEdg	Index of the edge to set.
deltaT	Inner simulation step duration

Reimplemented in AllDSSynapses, AllDynamicSTDPSynapses, AllSpikingSynapses, and AllSTDPSynapses.

Definition at line 35 of file AllNeuroEdges.cpp.

serialize()

template<class Archive >

void AllNeuroEdges::serialize

(

Archive &

archive

)

Cereal serialization method.

Definition at line 157 of file AllNeuroEdges.h.

setupEdges() [1/2]

void AllNeuroEdges::setupEdges ( )

overridevirtual

Setup the internal structure of the class (allocate memories and initialize them).

Reimplemented from AllEdges.

Reimplemented in AllDSSynapses, AllDynamicSTDPSynapses, AllSpikingSynapses, and AllSTDPSynapses.

Definition at line 12 of file AllNeuroEdges.cpp.

setupEdges() [2/2]

void AllNeuroEdges::setupEdges ( int numVertices, int maxEdges )

overrideprotectedvirtual

Setup the internal structure of the class (allocate memories and initialize them).

Setup the internal structure of the class (allocate memories and initialize them).

Parameters

numVertices	Total number of vertices in the network.
maxEdges	Maximum number of edges per vertex.

Reimplemented from AllEdges.

Reimplemented in AllDSSynapses, AllDynamicSTDPSynapses, AllSpikingSynapses, and AllSTDPSynapses.

Definition at line 20 of file AllNeuroEdges.cpp.

writeEdge()

void AllNeuroEdges::writeEdge ( ostream & output, BGSIZE iEdg ) const

overrideprotectedvirtual

Write the edge data to the stream.

Parameters

output	stream to print out to.
iEdg	Index of the edge to print out.

Reimplemented from AllEdges.

Reimplemented in AllDSSynapses, AllDynamicSTDPSynapses, AllSpikingSynapses, and AllSTDPSynapses.

Definition at line 69 of file AllNeuroEdges.cpp.

Member Data Documentation

psr_

vector<BGFLOAT> AllNeuroEdges::psr_

The post-synaptic response is the result of whatever computation is going on in the edge.

Definition at line 111 of file AllNeuroEdges.h.

SYNAPSE_STRENGTH_ADJUSTMENT

BGFLOAT AllNeuroEdges::SYNAPSE_STRENGTH_ADJUSTMENT = 1.0e-8

staticconstexpr

The factor to adjust overlapping area to edge weight.

Definition at line 108 of file AllNeuroEdges.h.

---

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

• Simulator/Edges/Neuro/AllNeuroEdges.h
• Simulator/Edges/Neuro/AllNeuroEdges.cpp