ECF 1.5
Public Member Functions | List of all members
Operator Class Referenceabstract

Abstract operator class. More...

#include <Operator.h>

Inheritance diagram for Operator:
EvaluateAlternate HallOfFame Migration StatCalc TermFitnessValOp TermMaxEvalOp TermMaxGenOp TermMaxTimeOp TermStagnationOp WriteBest WriteBest WriteBest WriteBest WriteTT

Public Member Functions

virtual bool operate (StateP)=0
 perform the designated operation More...
 
virtual bool initialize (StateP)
 Perform initialization. Called before Operator::operate. By default, if the return value is false, the operator will not be used! More...
 
virtual void registerParameters (StateP)
 Register parameters with the Registry. Called before Operator::initialize. More...
 
virtual void write (XMLNode &)
 Write operator state to XMLNode or the Registry. Called after Operator::initialize. More...
 
virtual void read (XMLNode &)
 Read operator state from XMLNode or the Registry. Called after Operator::initialize. More...
 

Detailed Description

Abstract operator class.

Encapsulates calls to parameter registration, initialization and operation.

Definition at line 10 of file Operator.h.

Constructor & Destructor Documentation

◆ ~Operator()

virtual Operator::~Operator ( )
inlinevirtual

Definition at line 44 of file Operator.h.

Member Function Documentation

◆ initialize()

virtual bool Operator::initialize ( StateP  )
inlinevirtual

Perform initialization. Called before Operator::operate. By default, if the return value is false, the operator will not be used!

Returns
initialization success

Reimplemented in WriteTT, WriteBest, EvaluateAlternate, WriteBest, WriteBest, WriteBest, HallOfFame, Migration, StatCalc, TermFitnessValOp, TermMaxEvalOp, TermMaxGenOp, TermMaxTimeOp, and TermStagnationOp.

Definition at line 20 of file Operator.h.

◆ operate()

virtual bool Operator::operate ( StateP  )
pure virtual

◆ read()

virtual void Operator::read ( XMLNode &  )
inlinevirtual

Read operator state from XMLNode or the Registry. Called after Operator::initialize.

Reimplemented in HallOfFame.

Definition at line 41 of file Operator.h.

◆ registerParameters()

virtual void Operator::registerParameters ( StateP  )
inlinevirtual

Register parameters with the Registry. Called before Operator::initialize.

Reimplemented in EvaluateAlternate, Migration, StatCalc, TermFitnessValOp, TermMaxEvalOp, TermMaxGenOp, TermMaxTimeOp, and TermStagnationOp.

Definition at line 27 of file Operator.h.

◆ write()

virtual void Operator::write ( XMLNode &  )
inlinevirtual

Write operator state to XMLNode or the Registry. Called after Operator::initialize.

Reimplemented in HallOfFame.

Definition at line 34 of file Operator.h.


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