CEBL  2.1
Public Member Functions | Protected Member Functions | Protected Attributes
CEBL::Plugin Class Reference

#include <Plugin.hpp>

Public Member Functions

 Plugin ()
virtual ~Plugin ()
void halt ()
 tell classifier to halt
string getName () const
 get the name of the plugin
virtual std::map< std::string,
CEBL::Param
getParamsList ()
 get the parameter list
virtual void setParamsList (std::map< std::string, CEBL::Param > &)
 set the parameter list
virtual map< string,
SerializedObject
save () const
 save plugin to list, and return it
virtual void load (map< string, SerializedObject > objects)
 load plugin from list of objects

Protected Member Functions

void inturruptionPoint ()

Protected Attributes

string plugin_name
bool should_halt

Detailed Description

Definition at line 44 of file Plugin.hpp.


Constructor & Destructor Documentation

CEBL::Plugin::Plugin ( )
inline

Definition at line 62 of file Plugin.hpp.

References plugin_name, and should_halt.

virtual CEBL::Plugin::~Plugin ( )
inlinevirtual

Definition at line 63 of file Plugin.hpp.


Member Function Documentation

string CEBL::Plugin::getName ( ) const
inline

get the name of the plugin

Definition at line 69 of file Plugin.hpp.

References plugin_name.

virtual std::map<std::string, CEBL::Param> CEBL::Plugin::getParamsList ( )
inlinevirtual

get the parameter list

Reimplemented in CEBL::IncrementalSVD, CEBL::MSPRT, CEBL::LDA, CEBL::SimpleMax, CEBL::max_var, CEBL::QDA, CEBL::QDA, CEBL::Lag, and CEBL::WindowedSVD.

Definition at line 75 of file Plugin.hpp.

Referenced by ClassifiersConfig::getParams().

void CEBL::Plugin::halt ( )
inline

tell classifier to halt

Definition at line 66 of file Plugin.hpp.

References should_halt.

Referenced by ClassifiersConfig::haltTrain().

void CEBL::Plugin::inturruptionPoint ( )
inlineprotected

Definition at line 51 of file Plugin.hpp.

References plugin_name, and should_halt.

virtual void CEBL::Plugin::load ( map< string, SerializedObject objects)
inlinevirtual

load plugin from list of objects

Reimplemented in CEBL::MNF, and CEBL::Lag.

Definition at line 91 of file Plugin.hpp.

virtual map<string, SerializedObject> CEBL::Plugin::save ( ) const
inlinevirtual

save plugin to list, and return it

Reimplemented in CEBL::MNF, CEBL::IncrementalSVD, CEBL::MSPRT, CEBL::LDA, CEBL::SimpleMax, CEBL::QDA, CEBL::QDA, CEBL::Lag, and CEBL::WindowedSVD.

Definition at line 84 of file Plugin.hpp.

virtual void CEBL::Plugin::setParamsList ( std::map< std::string, CEBL::Param > &  )
inlinevirtual

set the parameter list

Reimplemented in CEBL::IncrementalSVD, CEBL::MSPRT, CEBL::LDA, CEBL::SimpleMax, CEBL::max_var, CEBL::QDA, CEBL::QDA, CEBL::Lag, and CEBL::WindowedSVD.

Definition at line 81 of file Plugin.hpp.

Referenced by ClassifiersConfig::setParams().


Field Documentation

string CEBL::Plugin::plugin_name
protected
bool CEBL::Plugin::should_halt
protected

Definition at line 48 of file Plugin.hpp.

Referenced by halt(), inturruptionPoint(), and Plugin().


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