SG++-Doxygen-Documentation
Loading...
Searching...
No Matches
python.controller.InfoToGraph.InfoToGraph Class Reference

This class processes the information about the current state of the learning process and presents it in form of a graph. More...

Inheritance diagram for python.controller.InfoToGraph.InfoToGraph:

Public Member Functions

 __init__ (self, learnerFilename="learner_progress.eps", solverFilename="solver_progress.eps")
 Constuctor.
 
 handleLearningEvent (self, subject, status)
 Handles events from Learner.
 
 handleSolvingEvent (self, subject, status)
 Handles events from Linear Solver.
 

Public Attributes

 LEARNER_FIGURE
 
 SOLVER_FIGURE
 

Static Public Attributes

int LEARNER_FIGURE = 1
 The constant figure ID of the plot with learner information.
 
int SOLVER_FIGURE = 2
 The constant figure ID of the plot with solver information.
 

Detailed Description

This class processes the information about the current state of the learning process and presents it in form of a graph.

In order to use this class the matplotlib library is required.

Constructor & Destructor Documentation

◆ __init__()

python.controller.InfoToGraph.InfoToGraph.__init__ (   self,
  learnerFilename = "learner_progress.eps",
  solverFilename = "solver_progress.eps" 
)

Constuctor.

Parameters
learnerFilenamefile name where learner progress information has to be stored (eps file)
solverFilenamefile name where solver progress information has to be stored (eps file)

References python.controller.InfoToGraph.InfoToGraph.__learnerFigure, python.controller.InfoToGraph.InfoToGraph.__learnerFilename, python.controller.InfoToGraph.InfoToGraph.__learnerTestResiduum, python.controller.InfoToGraph.InfoToGraph.__learnerTrainResiduum, python.controller.InfoToGraph.InfoToGraph.__solverFigure, python.controller.InfoToGraph.InfoToGraph.__solverFilename, python.controller.InfoToGraph.InfoToGraph.__solverResiduum, python.controller.InfoToGraph.InfoToGraph.LEARNER_FIGURE, and python.controller.InfoToGraph.InfoToGraph.SOLVER_FIGURE.

Member Function Documentation

◆ handleLearningEvent()

python.controller.InfoToGraph.InfoToGraph.handleLearningEvent (   self,
  subject,
  status 
)

Handles events from Learner.

Parameters
subjectLearner object
statusEvent Status of type LearnerEvents

◆ handleSolvingEvent()

python.controller.InfoToGraph.InfoToGraph.handleSolvingEvent (   self,
  subject,
  status 
)

Handles events from Linear Solver.

Parameters
subjectLinear Solver object
statusEvent Status of type LinearSolverEvents

Member Data Documentation

◆ LEARNER_FIGURE [1/2]

int python.controller.InfoToGraph.InfoToGraph.LEARNER_FIGURE = 1
static

The constant figure ID of the plot with learner information.

Referenced by python.controller.InfoToGraph.InfoToGraph.__init__().

◆ LEARNER_FIGURE [2/2]

python.controller.InfoToGraph.InfoToGraph.LEARNER_FIGURE

◆ SOLVER_FIGURE [1/2]

int python.controller.InfoToGraph.InfoToGraph.SOLVER_FIGURE = 2
static

The constant figure ID of the plot with solver information.

Referenced by python.controller.InfoToGraph.InfoToGraph.__init__().

◆ SOLVER_FIGURE [2/2]

python.controller.InfoToGraph.InfoToGraph.SOLVER_FIGURE

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