MPILib::populist::ProbabilityQueue Class Reference

#include <libs/MPILib/include/ProbabilityQueue.hpp>

Collaboration diagram for MPILib::populist::ProbabilityQueue:

Public Member Functions
	ProbabilityQueue (Time time_step=TIME_REFRACT_MIN)
	~ProbabilityQueue ()
Probability	CollectAndRemove (Time)
bool	HasProbability (Time) const
bool	IsConsistent () const
void	push (const StampedProbability &prob)
void	Scale (double)
Time	TBatch () const
Time	TimeCurrent () const
Probability	TotalProbability () const

Private Attributes
Probability	_prob_current_batch
std::queue< StampedProbability >	_queue
double	_scale
Time	_t_batch_size
Time	_t_current
Time	_t_current_batch
Probability	_total

Detailed Description

A queue to store probability density, effectively a pipeline.

ProbabilityQueue stores StampedProbability instances.

Definition at line 35 of file ProbabilityQueue.hpp.

Constructor & Destructor Documentation

ProbabilityQueue::ProbabilityQueue

(

Time

time_step = TIME_REFRACT_MIN

)

Probability is grouped in batches.

Definition at line 26 of file ProbabilityQueue.cpp.

MPILib::populist::ProbabilityQueue::~ProbabilityQueue ( )

inline

destructor

Definition at line 41 of file ProbabilityQueue.hpp.

Member Function Documentation

Probability ProbabilityQueue::CollectAndRemove

(

Time

time

)

add all probability that is batched below the current time and remove it from the queue

Definition at line 58 of file ProbabilityQueue.cpp.

References _prob_current_batch, _queue, _scale, _t_batch_size, _t_current_batch, and _total.

Referenced by GeomLib::SpikingOdeSystem::RetrieveFromQueue().

bool ProbabilityQueue::HasProbability

(

Time

time

)

const

if there is time stamped probability that would be retrieved by CollectAndRemove before this will return true, false otherwise

Definition at line 79 of file ProbabilityQueue.cpp.

References _queue.

bool MPILib::populist::ProbabilityQueue::IsConsistent

(

)

const

Stamped Probability must entered in the queue in the right time order.

void ProbabilityQueue::push

(

const StampedProbability &

prob

)

push time stamped probability on the queue

Definition at line 39 of file ProbabilityQueue.cpp.

References MPILib::populist::StampedProbability::_prob, _prob_current_batch, _queue, _t_batch_size, _t_current, _t_current_batch, MPILib::populist::StampedProbability::_time, and _total.

Referenced by GeomLib::SpikingOdeSystem::StoreInQueue().

void ProbabilityQueue::Scale

(

double

scale

)

Sometimes, after rebinning the probability in the queue needs to be rescaled.

Definition at line 86 of file ProbabilityQueue.cpp.

References _scale.

Time MPILib::populist::ProbabilityQueue::TBatch ( ) const

inline

Definition at line 64 of file ProbabilityQueue.hpp.

References _t_batch_size.

Referenced by GeomLib::SpikingOdeSystem::RetrieveFromQueue(), and GeomLib::QifOdeSystem::TBatch().

Time MPILib::populist::ProbabilityQueue::TimeCurrent ( ) const

inline

Current time based on last CollectAndRemove call.

Definition at line 59 of file ProbabilityQueue.hpp.

References _t_current.

Probability MPILib::populist::ProbabilityQueue::TotalProbability ( ) const

inline

Total probability in queue.

Definition at line 53 of file ProbabilityQueue.hpp.

References _scale, and _total.

Member Data Documentation

Probability MPILib::populist::ProbabilityQueue::_prob_current_batch

private

Definition at line 73 of file ProbabilityQueue.hpp.

Referenced by CollectAndRemove(), and push().

std::queue<StampedProbability> MPILib::populist::ProbabilityQueue::_queue

private

Definition at line 76 of file ProbabilityQueue.hpp.

Referenced by CollectAndRemove(), HasProbability(), and push().

double MPILib::populist::ProbabilityQueue::_scale

private

Definition at line 68 of file ProbabilityQueue.hpp.

Referenced by CollectAndRemove(), Scale(), and TotalProbability().

Time MPILib::populist::ProbabilityQueue::_t_batch_size

private

Definition at line 69 of file ProbabilityQueue.hpp.

Referenced by CollectAndRemove(), push(), and TBatch().

Time MPILib::populist::ProbabilityQueue::_t_current

private

Definition at line 70 of file ProbabilityQueue.hpp.

Referenced by push(), and TimeCurrent().

Time MPILib::populist::ProbabilityQueue::_t_current_batch

private

Definition at line 71 of file ProbabilityQueue.hpp.

Referenced by CollectAndRemove(), and push().

Probability MPILib::populist::ProbabilityQueue::_total

private

Definition at line 74 of file ProbabilityQueue.hpp.

Referenced by CollectAndRemove(), push(), and TotalProbability().

---

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

• /Users/scsmdk/miind-git/libs/MPILib/include/ProbabilityQueue.hpp
• /Users/scsmdk/miind-git/libs/MPILib/src/ProbabilityQueue.cpp