AllVertices Class Reference

Inheritance diagram for AllVertices:

Public Member Functions
virtual void	setupVertices ()
	Setup the internal structure of the class (allocate memories).
virtual void	printParameters () const
void	loadEpochInputs (uint64_t currentStep, uint64_t endStep)
virtual void	loadEpochInputsToVertices (uint64_t currentStep, uint64_t endStep)
virtual void	loadParameters ()=0
virtual void	createAllVertices (Layout &layout)=0
virtual string	toString (int i) const =0
virtual void	registerHistoryVariables ()=0
template<class Archive >
void	serialize (Archive &archive)
	Cereal serialization method.
virtual void	advanceVertices (AllEdges &edges, const EdgeIndexMap &edgeIndexMap)=0
virtual void	integrateVertexInputs (AllEdges &edges, EdgeIndexMap &edgeIndexMap)=0

Protected Attributes
int	size_
	Total number of vertices.
log4cplus::Logger	fileLogger_
log4cplus::Logger	vertexLogger_
	TODO: Should check to see if this file name "neurons" is hardcoded and change it to vertices.

Detailed Description

Definition at line 43 of file AllVertices.h.

Constructor & Destructor Documentation

AllVertices()

AllVertices::AllVertices

(

)

Definition at line 30 of file AllVertices.cpp.

Member Function Documentation

advanceVertices()

virtual void AllVertices::advanceVertices ( AllEdges & edges, const EdgeIndexMap & edgeIndexMap )

pure virtual

Update internal state of the indexed vertex (called by every simulation step). Notify outgoing edges if vertex has fired.

Parameters

edges	The edge list to search from.
edgeIndexMap	Reference to the EdgeIndexMap.

Implemented in All911Vertices, and AllSpikingNeurons.

createAllVertices()

virtual void AllVertices::createAllVertices ( Layout & layout )

pure virtual

Creates all the Vertices and assigns initial data for them.

Parameters

layout

Layout information of the network.

Implemented in All911Vertices, AllIFNeurons, and AllIZHNeurons.

integrateVertexInputs()

virtual void AllVertices::integrateVertexInputs ( AllEdges & edges, EdgeIndexMap & edgeIndexMap )

pure virtual

Performs an integration operation per vertex using the inputs to the vertex.

Parameters

edges	The edge list to search from.
edgeIndexMap	Reference to the EdgeIndexMap.

Implemented in All911Vertices, and AllSpikingNeurons.

loadEpochInputs()

void AllVertices::loadEpochInputs	(	uint64_t	currentStep,
		uint64_t	endStep )

Loads all inputs scheduled to occur in the upcoming epoch. These are inputs occurring in between curStep (inclusive) and endStep (exclusive)

Parameters

curStep	The current simulation step
endStep	The end of epoch simulation step

Loads all inputs scheduled to occur in the upcoming epoch. These are inputs occurring in between curStep (inclusive) and endStep (exclusive)

Definition at line 94 of file AllVertices.cpp.

loadEpochInputsToVertices()

void AllVertices::loadEpochInputsToVertices ( uint64_t currentStep, uint64_t endStep )

virtual

Loads all inputs scheduled to occur in the upcoming epoch. These are inputs occurring in between curStep (inclusive) and endStep (exclusive)

Parameters

curStep	The current simulation step
endStep	The end of epoch simulation step

Reimplemented in All911Vertices.

Definition at line 102 of file AllVertices.cpp.

loadParameters()

virtual void AllVertices::loadParameters ( )

pure virtual

Load member variables from configuration file. Registered to OperationManager as Operation::loadParameters

Implemented in All911Vertices, and AllIFNeurons.

printParameters()

void AllVertices::printParameters ( ) const

virtual

Prints out all parameters of the vertices to logging file. Registered to OperationManager as Operation::printParameters

Reimplemented in All911Vertices, AllIFNeurons, AllIZHNeurons, and AllLIFNeurons.

Definition at line 86 of file AllVertices.cpp.

registerHistoryVariables()

virtual void AllVertices::registerHistoryVariables ( )

pure virtual

Helper function for recorder to register spike history variables for all vertices. Option 1: Register vertex information in vertexEvents_ one by one. Option 2: Register a vector of EventBuffer variables.

Implemented in All911Vertices, and AllSpikingNeurons.

serialize()

template<class Archive >

void AllVertices::serialize

(

Archive &

archive

)

Cereal serialization method.

Definition at line 180 of file AllVertices.h.

setupVertices()

void AllVertices::setupVertices ( )

virtual

Setup the internal structure of the class (allocate memories).

Setup the internal structure of the class. Allocate memories to store all vertices' state.

Reimplemented in All911Vertices, AllIFNeurons, AllIZHNeurons, and AllSpikingNeurons.

Definition at line 79 of file AllVertices.cpp.

toString()

virtual string AllVertices::toString ( int i ) const

pure virtual

Outputs state of the vertex chosen as a string.

Parameters

i	index of the vertex (in vertices) to output info from.

Returns

the complete state of the vertex.

Implemented in All911Vertices, AllIFNeurons, and AllIZHNeurons.

Member Data Documentation

fileLogger_

log4cplus::Logger AllVertices::fileLogger_

protected

Definition at line 101 of file AllVertices.h.

size_

int AllVertices::size_

protected

Total number of vertices.

Definition at line 98 of file AllVertices.h.

vertexLogger_

log4cplus::Logger AllVertices::vertexLogger_

protected

TODO: Should check to see if this file name "neurons" is hardcoded and change it to vertices.

Definition at line 103 of file AllVertices.h.

---

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

• Simulator/Vertices/AllVertices.h
• Simulator/Vertices/AllVertices.cpp