auryn::Checker Class Reference

The abstract base class for all checkers. More...

#include <Checker.h>

Inheritance diagram for auryn::Checker:

Public Member Functions
	Checker ()
virtual	~Checker ()
virtual bool	propagate ()=0

Friends
class	boost::serialization::access

Detailed Description

The abstract base class for all checkers.

Checkers are online monitors that can be used to break a run. In many simulations involving plasticity it is for instance useful to monitor the average firing rate of the network. If it drops to zero or explodes this can trigger the abortion of the run to avoid hammering of the fileserver or other loss of resources. The most dominant checker for this purpose is RateChecker that should be included in every simulation.

Constructor & Destructor Documentation

Checker()

Checker::Checker

(

)

{
}

~Checker()

Checker::~Checker ( )

virtual

{
}

Member Function Documentation

propagate()

virtual bool auryn::Checker::propagate ( )

pure virtual

The propagate function of Checkers is for internal use. It is called by System and returns true to signal a break. If checking is enabled for it will stop the current run.

Implemented in auryn::RateChecker, and auryn::WeightChecker.

Friends And Related Function Documentation

boost::serialization::access

friend class boost::serialization::access

friend

---

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

• /home/zenke/auryn/src/auryn/Checker.h
• /home/zenke/auryn/src/auryn/Checker.cpp