nest::SourceTablePosition Struct Reference

Three-tuple to store position in 3d vector of sources. More...

#include <source_table_position.h>

Public Member Functions
	SourceTablePosition ()
	SourceTablePosition (const long tid, const long syn_id, const long lcid)
	SourceTablePosition (const SourceTablePosition &rhs)=default
SourceTablePosition &	operator= (const SourceTablePosition &rhs)=default
void	seek_to_next_valid_index (const std::vector< std::vector< BlockVector< Source > > > &sources)
	Decreases indices until a valid entry is found.
void	decrease ()
	Decreases the inner most index (lcid).
bool	is_invalid () const
	Returns true if the indices point outside the SourceTable, e.g., to signal that the end was reached.

Public Attributes
long	tid
	thread index
long	syn_id
	synapse-type index
long	lcid
	local connection index

Detailed Description

Three-tuple to store position in 3d vector of sources.

Constructor & Destructor Documentation

SourceTablePosition() [1/3]

nest::SourceTablePosition::SourceTablePosition ( )

inline

SourceTablePosition() [2/3]

nest::SourceTablePosition::SourceTablePosition ( const long  tid, const long  syn_id, const long  lcid  )

inline

SourceTablePosition() [3/3]

nest::SourceTablePosition::SourceTablePosition ( const SourceTablePosition &  rhs )

default

Member Function Documentation

decrease()

void nest::SourceTablePosition::decrease ( )

inline

Decreases the inner most index (lcid).

References lcid.

Referenced by nest::SourceTable::get_next_target_data().

Here is the caller graph for this function:

is_invalid()

bool nest::SourceTablePosition::is_invalid ( ) const

inline

Returns true if the indices point outside the SourceTable, e.g., to signal that the end was reached.

References lcid, syn_id, and tid.

Referenced by nest::SourceTable::get_next_target_data(), nest::SourceTable::next_entry_has_same_source_(), and nest::SourceTable::previous_entry_has_same_source_().

Here is the caller graph for this function:

operator=()

SourceTablePosition & nest::SourceTablePosition::operator= ( const SourceTablePosition &  rhs )

default

seek_to_next_valid_index()

void nest::SourceTablePosition::seek_to_next_valid_index ( const std::vector< std::vector< BlockVector< Source > > > &  sources )

inline

Decreases indices until a valid entry is found.

References lcid, syn_id, and tid.

Referenced by nest::SourceTable::get_next_target_data().

Here is the caller graph for this function:

Member Data Documentation

lcid

long nest::SourceTablePosition::lcid

local connection index

Referenced by nest::SourceTable::clean(), decrease(), nest::SourceTable::get_next_target_data(), is_invalid(), nest::SourceTable::next_entry_has_same_source_(), nest::operator<(), nest::operator==(), nest::SourceTable::populate_target_data_fields_(), nest::SourceTable::previous_entry_has_same_source_(), and seek_to_next_valid_index().

syn_id

long nest::SourceTablePosition::syn_id

synapse-type index

Referenced by nest::SourceTable::clean(), nest::SourceTable::get_next_target_data(), is_invalid(), nest::SourceTable::next_entry_has_same_source_(), nest::operator<(), nest::operator==(), nest::SourceTable::populate_target_data_fields_(), nest::SourceTable::previous_entry_has_same_source_(), and seek_to_next_valid_index().

tid

long nest::SourceTablePosition::tid

thread index

Referenced by nest::SourceTable::clean(), nest::SourceTable::get_next_target_data(), is_invalid(), nest::SourceTable::next_entry_has_same_source_(), nest::operator<(), nest::operator==(), nest::SourceTable::populate_target_data_fields_(), nest::SourceTable::previous_entry_has_same_source_(), and seek_to_next_valid_index().

---

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

• source_table_position.h