A Checker class that tracks the meain weight of a Connection and breaks a run if it goes out of bound. More...

#include <WeightChecker.h>

Inheritance diagram for auryn::WeightChecker:

Collaboration diagram for auryn::WeightChecker:

Public Member Functions
	WeightChecker (Connection *source, AurynFloat max)
	The default constructor. More...

	WeightChecker (Connection *source, AurynFloat min, AurynFloat max, AurynFloat timestep=10.0)
	A more elaborate constructor specifying also a minimum weight to guard against silent networks. More...

virtual	~WeightChecker ()

virtual bool	propagate ()

Public Member Functions inherited from auryn::Checker
	Checker ()

virtual	~Checker ()

Detailed Description

A Checker class that tracks the meain weight of a Connection and breaks a run if it goes out of bound.

Constructor & Destructor Documentation

◆ WeightChecker() [1/2]

WeightChecker::WeightChecker	(	Connection *	source,
		AurynFloat	max
	)

The default constructor.

Parameters

source	the source group to monitor.
max	the maximum mean weight above which the Checker signals a break of the simulation.

                                                                 : Checker()
 {
         init(source,0.,max,10.);
 }

◆ WeightChecker() [2/2]

WeightChecker::WeightChecker	(	Connection *	source,
		AurynFloat	min,
		AurynFloat	max,
		AurynFloat	timestep = `10.0`
	)

A more elaborate constructor specifying also a minimum weight to guard against silent networks.

Parameters

source	the source group to monitor.
min	the minimum mean weight below which the Checker signals a break of the simulation.
max	the maximum mean weight above which the Checker signals a break of the simulation.
timestep	Check weights every timestep seconds (default = 10s because weight checking is expensive).

                                                                                                      : Checker()
 {
         init(source,min,max,timestep);
 }

◆ ~WeightChecker()

WeightChecker::~WeightChecker ( )

virtual

41 {

42 }

Here is the call graph for this function:

Member Function Documentation

◆ propagate()

bool WeightChecker::propagate ( )

virtual

The propagate function required for internal use.

Implements auryn::Checker.

 {
 
         if ( (sys->get_clock()%timestep_) == 0 ) {
                 AurynDouble mean, std;
                 source_->stats(mean, std);
                 if ( mean<wmin || mean>wmax ) { 
                         std::stringstream oss;
                         oss << "WeightChecker:: Detected mean weight of " << mean ;
                         logger->msg(oss.str(),WARNING);
                         return false; // break run
                 }
         }
 
         return true; 
 }