IRingerProcedure.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2022 CERN for the benefit of the ATLAS collaboration
*/
 
#ifndef RINGERSELECTORTOOLS_PROCEDURES_IPROCEDURE_H
#define RINGERSELECTORTOOLS_PROCEDURES_IPROCEDURE_H
 
// STL includes:
#include <vector>
#include <utility>
 
// Root includes:
#include <TDirectory.h>
//#include <TClass.h>
 
// Local includes:
#include "RingerSelectorTools/tools/VariableDependency.h"
#include "RingerSelectorTools/tools/IRedirectMsgStream.h"
#include <type_traits>
 
#ifndef INCLUDE_HEADER_ONLY
#define INCLUDE_HEADER_ONLY
#endif // INCLUDE_HEADER_ONLY
#include "RingerSelectorTools/procedures/Types.h"
#undef INCLUDE_HEADER_ONLY

#define RINGER_PROCEDURE_BASE_METHODS(self)                                          \
                                                                               \
  public:                                                                      \
                                                                               \
    template <typename T = const char*>                                        \
    static T procType();                                                       \
                                                                               \
    virtual std::string name() const = 0;                                      \
                                                                               \
    virtual void print(MSG::Level lvl) const = 0;

#define RINGER_DEFINE_INTERFACE_DEFAULT_METHODS(self)                          \
                                                                               \
  template<>                                                                   \
  inline                                                                       \
  const char* self::procType()                                                 \
  {                                                                            \
    return #self;                                                              \
  }                                                                            \
                                                                               \
  template<>                                                                   \
  inline                                                                       \
  Ringer::RingerProcedureType<self>::procEnum_t self::procType()               \
  {                                                                            \
    return Ringer::getType<                                                    \
        Ringer::RingerProcedureType<self>::procEnum_t>(#self);                 \
  }
 
#define __RINGER_DEFINE_PROCEDURE_STANDARD_METHODS__(self)                     \
                                                                               \
    virtual std::string name() const                                           \
      override;                                                                \
    template <typename T = const char*>                                        \
    static T procType();                                                       \
                                                                               \


#define RINGER_DEFINE_PROCEDURE(self)                                          \
                                                                               \
  public:                                                                      \
    __RINGER_DEFINE_PROCEDURE_STANDARD_METHODS__(self)                         \
                                                                               \
    virtual void print(MSG::Level lvl) const                                   \
      override;

#define RINGER_DEFINE_NOMEMBER_PROCEDURE(self)                                 \
                                                                               \
  public:                                                                      \
    __RINGER_DEFINE_PROCEDURE_STANDARD_METHODS__(self)                         \
                                                                               \
    virtual void print(MSG::Level lvl) const                                   \
      override                                                                 \
    {                                                                          \
      if ( !this->isStreamAvailable() ) {                                      \
        std::cerr << "Cannot print " << this->name() << ", stream unavailable" \
          << std::endl;                                                        \
      }                                                                        \
      if ( this->level() > lvl ) {                                             \
        return;                                                                \
      }                                                                        \
      ATH_MSG_LVL(lvl, "Procedure hasn't any property.");                      \
    }


#define RINGER_DEFINE_PROCEDURE_DEFAULT_METHODS(self)                          \
                                                                               \
  RINGER_DEFINE_INTERFACE_DEFAULT_METHODS(self)                                \
                                                                               \
  inline                                                                       \
  std::string self::name() const                                               \
  {                                                                            \
    return this->procType<const char*>();                                      \
  }
 
 

namespace Ringer {
 
class DepVarStruct;
 
// Declare interface base for all Ringer procedure types:
//
class IRingerProcedure : virtual public IRedirectMsgStream {
  public:
    virtual void write(TDirectory *configDir, const char*idxStr = "")
        const = 0;

    virtual ~IRingerProcedure(){;}
 
  protected:

    //ClassDef(IRingerProcedure,0)
};
 
// Forward declare base procedure types:
namespace PreProcessing {
  class IPreProcessor;
  class IPreProcessorVarDep;
}
 
namespace Discrimination {
  class IDiscriminator;
  class IDiscriminatorVarDep;
  class IThreshold;
  class IThresholdVarDep;
}

template<typename procedure_t >
struct RingerProcedureType {
 
  static_assert( (std::is_base_of<IRingerProcedure,procedure_t>::value),
      "Requested to check Ringer procedure type from class that is not a IRingerProcedure.");
 
  // Determine which procedure type it is:
  static constexpr bool is_pre_processor =
    std::is_base_of<PreProcessing::IPreProcessor,procedure_t>::value;
  static constexpr bool is_discriminator =
    std::is_base_of<Discrimination::IDiscriminator,procedure_t>::value;
  static constexpr bool is_threshold =
    std::is_base_of<Discrimination::IThreshold,procedure_t>::value;
 
  static_assert( ( is_pre_processor || is_discriminator || is_threshold ),
      "Couldn't find a procedure type.");
 
  // Determine which enumType it should have been declared
  typedef typename std::conditional< is_pre_processor,
    preProcEnum_t,  // true, it is_pre_processor
      typename std::conditional< is_discriminator,
    discrEnum_t, // true, it is discriminator
      thresEnum_t >::type >::type procEnum_t;
 
  // Boolean to determine whether this procedure inherits from VariableDependency
  static constexpr bool inherits_from_var_dep = std::is_base_of< VariableDependency,
                                                             procedure_t>::value;
 
  // Determine which interface this Ringer procedure inherits from
  typedef typename std::conditional< is_pre_processor,
    // true, it is_pre_processor
    typename std::conditional< inherits_from_var_dep,
        PreProcessing::IPreProcessorVarDep, PreProcessing::IPreProcessor>::type,
    // not pre_processor, check if is_discriminator
    typename std::conditional< is_discriminator,
      // true, it is_discriminator
      typename std::conditional< inherits_from_var_dep,
          Discrimination::IDiscriminatorVarDep, Discrimination::IDiscriminator>::type,
      // otherwise it has to be threshold
      typename std::conditional< inherits_from_var_dep,
          Discrimination::IThresholdVarDep, Discrimination::IThreshold>::type
    >::type
  >::type baseInterface_t;
};

template<typename procedure_t >
struct RingerProcedureType<procedure_t*> : public RingerProcedureType<procedure_t>{ };

namespace PreProcessing {

class IPreProcessor : virtual public IRingerProcedure
{
 
  RINGER_PROCEDURE_BASE_METHODS( IPreProcessor )
 
  public:
    virtual void execute(std::vector<float> &inputSpace) const = 0;

    //ClassDef(IPreProcessor,0)
};

class IPreProcessorVarDep : public virtual VariableDependency,
                            public virtual IPreProcessor
{
 
  RINGER_PROCEDURE_BASE_METHODS( IPreProcessorVarDep )
 
  public:
    //IPreProcessorVarDep(){;}
 
    // This is needed for parsing wrapper
    static IPreProcessorVarDep* read(TDirectory *){ return nullptr;}

    //ClassDef(IPreProcessorVarDep,0)
};
 
} // namespace PreProcessor

namespace Discrimination {

class IDiscriminator : virtual public IRingerProcedure
{
 
  RINGER_PROCEDURE_BASE_METHODS( IDiscriminator )
 
  public:
    virtual void execute(const std::vector<float> &input,
        std::vector<float> &output) const = 0;

    //ClassDef(IDiscriminator,0)
};

class IDiscriminatorVarDep : public virtual VariableDependency,
                             public virtual IDiscriminator
{
 
  RINGER_PROCEDURE_BASE_METHODS( IDiscriminatorVarDep )
 
  public:
    //IDiscriminatorVarDep(){;}
 
    // This prototype is needed for parsing wrapper
    static IDiscriminatorVarDep* read(TDirectory *){ return nullptr;}

    //ClassDef(IDiscriminatorVarDep,0)
};

class IThreshold : virtual public IRingerProcedure
{
 
  RINGER_PROCEDURE_BASE_METHODS( IThreshold )
 
  public:
    virtual void execute(const std::vector<float> &input,
            std::vector<bool> &output, const DepVarStruct &depVar) const = 0;

    //ClassDef(IThreshold,0)
};

class IThresholdVarDep : public virtual VariableDependency,
                         public virtual IThreshold
{
 
  RINGER_PROCEDURE_BASE_METHODS( IThresholdVarDep )
 
  public:
    //IThresholdVarDep(){;}
 
    // This prototype is needed for parsing wrapper
    static IThresholdVarDep* read(TDirectory *){ return nullptr;}

    //ClassDef(IThresholdVarDep,0)
};
 
} // namespace Discrimination
 
// Declare procedure type member functions
namespace PreProcessing {
RINGER_DEFINE_INTERFACE_DEFAULT_METHODS( IPreProcessor )
RINGER_DEFINE_INTERFACE_DEFAULT_METHODS( IPreProcessorVarDep )
} // namespace PreProcessing
namespace Discrimination {
RINGER_DEFINE_INTERFACE_DEFAULT_METHODS( IThreshold )
RINGER_DEFINE_INTERFACE_DEFAULT_METHODS( IThresholdVarDep )
RINGER_DEFINE_INTERFACE_DEFAULT_METHODS( IDiscriminator )
RINGER_DEFINE_INTERFACE_DEFAULT_METHODS( IDiscriminatorVarDep )
} // namespace Discrimination
 
} // namespace Ringer
 
#endif // RINGERSELECTORTOOLS_PROCEDURES_IPROCEDURE_H