nest::correlation_detector::State_ Struct Reference

Public Member Functions
	State_ ()
	initialize default state
void	get (Dictionary &) const
void	set (const Dictionary &, const Parameters_ &, bool, Node *)
void	reset (const Parameters_ &)

Public Attributes
std::vector< long >	n_events_
	spike counters
std::vector< SpikelistType >	incoming_
	incoming spikes, sorted
std::vector< double >	histogram_
	Weighted histogram.
std::vector< double >	histogram_correction_
	used for Kahan summation algorithm
std::vector< long >	count_histogram_
	Unweighted histogram.

Detailed Description

Todo:

Is there a replacement for std::list that allows fast insertion inside, fast deletion at the beginning, and maintains sorting?

Note

Constructed with empty structures, which are set to proper sizes by init_buffers_().

State_ only contains read-out values, so we copy-construct using the default c'tor.

Constructor & Destructor Documentation

State_()

nest::correlation_detector::State_::State_

(

)

initialize default state

Member Function Documentation

get()

void nest::correlation_detector::State_::get

(

Dictionary &

d

)

const

References nest::names::count_histogram(), nest::names::histogram(), nest::names::histogram_correction(), and nest::names::n_events().

Referenced by nest::correlation_detector::get_status().

Here is the call graph for this function:

Here is the caller graph for this function:

reset()

void nest::correlation_detector::State_::reset

(

const Parameters_ &

p

)

Referenced by nest::correlation_detector::init_buffers_().

Here is the caller graph for this function:

set()

void nest::correlation_detector::State_::set	(	const Dictionary &	d,
		const Parameters_ &	p,
		bool	reset_required,
		Node *
	)

Parameters

bool	if true, force state reset

References nest::names::n_events().

Referenced by nest::correlation_detector::set_status().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

count_histogram_

std::vector< long > nest::correlation_detector::State_::count_histogram_

Unweighted histogram.

Referenced by nest::correlation_detector::handle().

histogram_

std::vector< double > nest::correlation_detector::State_::histogram_

Weighted histogram.

Note

Data type is double to accommodate weights.

Referenced by nest::correlation_detector::handle().

histogram_correction_

std::vector< double > nest::correlation_detector::State_::histogram_correction_

used for Kahan summation algorithm

Referenced by nest::correlation_detector::handle().

incoming_

std::vector< SpikelistType > nest::correlation_detector::State_::incoming_

incoming spikes, sorted

Referenced by nest::correlation_detector::handle().

n_events_

std::vector< long > nest::correlation_detector::State_::n_events_

spike counters

Referenced by nest::correlation_detector::handle().

---

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

• correlation_detector.h
• correlation_detector.cpp