Belle II Software  release-08-01-10
Interface< TemplateOptions, TemplateTeacher, TemplateExpert > Class Template Reference

Template class to easily construct a interface for an MVA library using a library-specific Options, Teacher and Expert class. More...

#include <Interface.h>

Inheritance diagram for Interface< TemplateOptions, TemplateTeacher, TemplateExpert >:
Collaboration diagram for Interface< TemplateOptions, TemplateTeacher, TemplateExpert >:

Public Member Functions

 Interface ()
 Constructs a new interface with the given name. More...
 
virtual std::unique_ptr< SpecificOptionsgetOptions () const override
 Get Options of this MVA library.
 
virtual std::unique_ptr< TeachergetTeacher (const GeneralOptions &general_options, const SpecificOptions &specific_options) const override
 Get Teacher of this MVA library. More...
 
virtual std::unique_ptr< MVA::ExpertgetExpert () const override
 Get Exoert of this MVA library.
 
std::string getName () const
 Returns the name of the third-party MVA library. More...
 

Static Public Member Functions

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

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

template<class TemplateOptions, class TemplateTeacher, class TemplateExpert>
class Belle2::MVA::Interface< TemplateOptions, TemplateTeacher, TemplateExpert >

Template class to easily construct a interface for an MVA library using a library-specific Options, Teacher and Expert class.

Definition at line 99 of file Interface.h.

Constructor & Destructor Documentation

◆ Interface()

Interface ( )
inline

Constructs a new interface with the given name.

Parameters
nameof the interface

Definition at line 105 of file Interface.h.

Member Function Documentation

◆ getName()

std::string getName ( ) const
inherited

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.

◆ getSupportedInterfaces()

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

Returns interfaces supported by the MVA Interface.

Returns
supported interfaces

Definition at line 53 of file Interface.h.

◆ getTeacher()

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

Get Teacher of this MVA library.

Parameters
general_optionsshared options of all libraries
specific_optionsspecific options for this library

Implements AbstractInterface.

Definition at line 117 of file Interface.h.

◆ initSupportedInterfaces()

void initSupportedInterfaces ( )
staticinherited

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.


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