GClasses

GClasses::SOM::Reporter Class Reference

Reports periodically on the training of a self-organizing map - writing status to a stream every so many seconds or iterations, writing visualizations of the network or the network itself to sequentially named files. More...

#include <GSelfOrganizingMap.h>

Inheritance diagram for GClasses::SOM::Reporter:
GClasses::SOM::IterationIntervalReporter GClasses::SOM::NoReporting GClasses::SOM::ReporterChain GClasses::SOM::SVG2DWeightReporter

List of all members.

Public Member Functions

virtual void start (const GMatrix *trainingData, int maxIterations=-1, int maxSubIterations=-1)
 Reset this reporter to the beginning and tell it that there will be maxIterations iterations each consisting of maxSubIterations sub-iterations. (An iteration count is unknown if given as -1). Give the reporter access to the training data on which the map will be trained. The reporter does not own the training data.
virtual void newStatus (unsigned iteration, unsigned subIteration, const GSelfOrganizingMap &map)=0
 Tell the reporter the current status of the training.
virtual void stop (unsigned iteration, unsigned subIteration, const GSelfOrganizingMap &map)
 Tell the reporter that the training has stopped at the given iteration and sub-iteration.
virtual ~Reporter ()
 Destruct this reporter object.

Detailed Description

Reports periodically on the training of a self-organizing map - writing status to a stream every so many seconds or iterations, writing visualizations of the network or the network itself to sequentially named files.

TODO: write class for print stream reporters, network writing reporters and visualization writing reporters, and classes for only calling reporters at different intervals


Constructor & Destructor Documentation

virtual GClasses::SOM::Reporter::~Reporter ( ) [inline, virtual]

Destruct this reporter object.


Member Function Documentation

virtual void GClasses::SOM::Reporter::newStatus ( unsigned  iteration,
unsigned  subIteration,
const GSelfOrganizingMap map 
) [pure virtual]
virtual void GClasses::SOM::Reporter::start ( const GMatrix trainingData,
int  maxIterations = -1,
int  maxSubIterations = -1 
) [inline, virtual]

Reset this reporter to the beginning and tell it that there will be maxIterations iterations each consisting of maxSubIterations sub-iterations. (An iteration count is unknown if given as -1). Give the reporter access to the training data on which the map will be trained. The reporter does not own the training data.

Reimplemented in GClasses::SOM::IterationIntervalReporter, GClasses::SOM::ReporterChain, GClasses::SOM::SVG2DWeightReporter, and GClasses::SOM::NoReporting.

virtual void GClasses::SOM::Reporter::stop ( unsigned  iteration,
unsigned  subIteration,
const GSelfOrganizingMap map 
) [inline, virtual]

Tell the reporter that the training has stopped at the given iteration and sub-iteration.

Reimplemented in GClasses::SOM::IterationIntervalReporter, GClasses::SOM::ReporterChain, GClasses::SOM::SVG2DWeightReporter, and GClasses::SOM::NoReporting.