AbstractInterface Class Reference

Abstract Interface to third-party MVA libraries. More...

#include <Interface.h>

Inheritance diagram for AbstractInterface:

Collaboration diagram for AbstractInterface:

Public Member Functions
	AbstractInterface (const std::string &name)
	Creates a new Interface to a third-party library.
virtual	~AbstractInterface ()
	Virtual destructor.
std::string	getName () const
	Returns the name of the third-party MVA library.
virtual std::unique_ptr< SpecificOptions >	getOptions () const =0
	Get Options of this MVA library.
virtual std::unique_ptr< Teacher >	getTeacher (const GeneralOptions &general_options, const SpecificOptions &specific_options) const =0
	Get Teacher of this MVA library.
virtual std::unique_ptr< MVA::Expert >	getExpert () const =0
	Get Exoert of this MVA library.

Static Public Member Functions
static std::map< std::string, AbstractInterface * >	getSupportedInterfaces ()
	Returns interfaces supported by the MVA Interface.
static void	initSupportedInterfaces ()
	Static function which initliazes all supported interfaces, has to be called once before getSupportedInterfaces can be used.

Private Attributes
std::string	m_name
	Name of the third-party library.

Static Private Attributes
static std::map< std::string, AbstractInterface * >	s_supported_interfaces
	Map of supported interfaces.

Detailed Description

Abstract Interface to third-party MVA libraries.

Definition at line 30 of file Interface.h.

Constructor & Destructor Documentation

AbstractInterface()

AbstractInterface ( const std::string &  name )

explicit

Creates a new Interface to a third-party library.

Parameters

name	of the third-party MVA library

Definition at line 27 of file Interface.cc.

                                                              : m_name(name)
    {
      if (s_supported_interfaces.find(m_name) != s_supported_interfaces.end()) {
        B2WARNING("An interface with the name " << m_name << " already exists!");
      } else {
        s_supported_interfaces.insert(std::make_pair(name, this));
      }
    }

~AbstractInterface()

~AbstractInterface ( )

virtual

Virtual destructor.

Definition at line 36 of file Interface.cc.

    {
      s_supported_interfaces.erase(m_name);
    }

Member Function Documentation

getExpert()

virtual std::unique_ptr< MVA::Expert > getExpert ( ) const

pure virtual

Get Exoert of this MVA library.

Implemented in Interface< TemplateOptions, TemplateTeacher, TemplateExpert >.

getName()

std::string getName

(

)

const

Returns the name of the third-party MVA library.

Returns

name of the third-party MVA library

Definition at line 41 of file Interface.cc.

{ return m_name; }

getOptions()

virtual std::unique_ptr< SpecificOptions > getOptions ( ) const

pure virtual

Get Options of this MVA library.

Implemented in Interface< TemplateOptions, TemplateTeacher, TemplateExpert >.

getSupportedInterfaces()

static std::map< std::string, AbstractInterface * > getSupportedInterfaces ( )

inlinestatic

Returns interfaces supported by the MVA Interface.

Returns

supported interfaces

Definition at line 53 of file Interface.h.

{ return s_supported_interfaces; }

getTeacher()

virtual std::unique_ptr< Teacher > getTeacher ( const GeneralOptions &  general_options, const SpecificOptions &  specific_options  ) const

pure virtual

Get Teacher of this MVA library.

Parameters

general_options	shared options of all libraries
specific_options	specific options for this library

Implemented in Interface< TemplateOptions, TemplateTeacher, TemplateExpert >.

initSupportedInterfaces()

void initSupportedInterfaces ( )

static

Static function which initliazes all supported interfaces, has to be called once before getSupportedInterfaces can be used.

It is save to call it multiple times

Definition at line 45 of file Interface.cc.

    {
      static Interface<FastBDTOptions, FastBDTTeacher, FastBDTExpert> interface_FastBDT;
      static Interface<RegressionFastBDTOptions, RegressionFastBDTTeacher, RegressionFastBDTExpert> interface_RegressionFastBDT;
      static Interface<FANNOptions, FANNTeacher, FANNExpert> interface_FANN;
      static Interface<TMVAOptionsClassification, TMVATeacherClassification, TMVAExpertClassification>
      interface_TMVAClassification;
      static Interface<TMVAOptionsRegression, TMVATeacherRegression, TMVAExpertRegression> interface_TMVARegression;
      static Interface<TMVAOptionsMulticlass, TMVATeacherMulticlass, TMVAExpertMulticlass> interface_TMVAMulticlass;
      static Interface<PythonOptions, PythonTeacher, PythonExpert> interface_Python;
      static Interface<PDFOptions, PDFTeacher, PDFExpert> interface_PDF;
      static Interface<CombinationOptions, CombinationTeacher, CombinationExpert> interface_Combination;
      static Interface<ReweighterOptions, ReweighterTeacher, ReweighterExpert> interface_Reweighter;
      static Interface<TrivialOptions, TrivialTeacher, TrivialExpert> interface_Trivial;
    }

Member Data Documentation

m_name

std::string m_name

private

Name of the third-party library.

Definition at line 84 of file Interface.h.

s_supported_interfaces

std::map< std::string, AbstractInterface * > s_supported_interfaces

staticprivate

Map of supported interfaces.

Definition at line 89 of file Interface.h.

---

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

• mva/interface/include/Interface.h
• mva/interface/src/Interface.cc