nest::SparseNodeArray::NodeEntry Class Reference

Entry representing individual node. More...

#include <sparse_node_array.h>

Collaboration diagram for nest::SparseNodeArray::NodeEntry:

Public Member Functions
	NodeEntry ()
	NodeEntry (Node &, size_t)
Node *	get_node () const
	return pointer to represented node
size_t	get_node_id () const
	return ID of represented node

Private Attributes
Node *	node_
size_t	node_id_
	store node ID locally for faster searching

Friends
class	SparseNodeArray

Detailed Description

Entry representing individual node.

Note

• The Node ID is stored in the entry to ensure cache locality during lookup.
• Actual entries will always point to valid nodes.
• Must be public to allow iteration by SparseNodeArray-users.

Constructor & Destructor Documentation

NodeEntry() [1/2]

nest::SparseNodeArray::NodeEntry::NodeEntry ( )

inline

Note

This constructor is only provided to allow BlockVector to initialize new blocks with "zero" values.

NodeEntry() [2/2]

nest::SparseNodeArray::NodeEntry::NodeEntry	(	Node &	node,
		size_t	node_id
	)

Parameters

Node	to be represented
Index	of node to be represented

Member Function Documentation

get_node()

Node * nest::SparseNodeArray::NodeEntry::get_node ( ) const

inline

return pointer to represented node

References node_.

Referenced by nest::NodeManager::update_thread_local_node_data().

Here is the caller graph for this function:

get_node_id()

size_t nest::SparseNodeArray::NodeEntry::get_node_id ( ) const

inline

return ID of represented node

Friends And Related Symbol Documentation

SparseNodeArray

friend class SparseNodeArray

friend

Member Data Documentation

node_

Node* nest::SparseNodeArray::NodeEntry::node_

private

Note

pointer to allow zero-entries for BlockVector compatibility

Referenced by get_node().

node_id_

size_t nest::SparseNodeArray::NodeEntry::node_id_

private

store node ID locally for faster searching

---

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

• sparse_node_array.h
• sparse_node_array.cpp