Branch data     Line data    Source code

       1                 :            : // *****************************************************************************
       2                 :            : /*!
       3                 :            :   \file      src/Control/Options/MKLGammaMethod.hpp
       4                 :            :   \copyright 2012-2015 J. Bakosi,
       5                 :            :              2016-2018 Los Alamos National Security, LLC.,
       6                 :            :              2019-2021 Triad National Security, LLC.
       7                 :            :              All rights reserved. See the LICENSE file for details.
       8                 :            :   \brief     Intel MKL Gamma RNG method options
       9                 :            :   \details   Intel MKL Gamma RNG method options
      10                 :            : */
      11                 :            : // *****************************************************************************
      12                 :            : #ifndef MKLGammaMethodOptions_h
      13                 :            : #define MKLGammaMethodOptions_h
      14                 :            : 
      15                 :            : #include <map>
      16                 :            : 
      17                 :            : #include <mkl_vsl_defines.h>
      18                 :            : 
      19                 :            : #include <brigand/sequences/list.hpp>
      20                 :            : 
      21                 :            : #include "Toggle.hpp"
      22                 :            : #include "Keywords.hpp"
      23                 :            : #include "PUPUtil.hpp"
      24                 :            : 
      25                 :            : namespace tk {
      26                 :            : namespace ctr {
      27                 :            : 
      28                 :            : //! MKL gamma random number generator method types
      29                 :            : enum class MKLGammaMethodType : uint8_t { GNORM,
      30                 :            :                                           GNORM_ACCURATE };
      31                 :            : 
      32                 :            : //! \brief Pack/Unpack MKLGammaMethodType: forward overload to generic enum
      33                 :            : //!   class packer
      34                 :         80 : inline void operator|( PUP::er& p, MKLGammaMethodType& e ) { PUP::pup( p, e ); }
      35                 :            : 
      36                 :            : //! \brief MKLGammaMethod options: outsource searches to base templated on
      37                 :            : //!   enum type
      38                 :            : class MKLGammaMethod : public tk::Toggle< MKLGammaMethodType > {
      39                 :            : 
      40                 :            :   public:
      41                 :            :     using ParamType = int;
      42                 :            : 
      43                 :            :     //! Valid expected choices to make them also available at compile-time
      44                 :            :     using keywords = brigand::list< kw::gnorm
      45                 :            :                                   , kw::gnorm_accurate
      46                 :            :                                   >;
      47                 :            : 
      48                 :            :     //! \brief Options constructor
      49                 :            :     //! \details Simply initialize in-line and pass associations to base, which
      50                 :            :     //!    will handle client interactions
      51                 :        379 :     explicit MKLGammaMethod() :
      52                 :            :       tk::Toggle< MKLGammaMethodType >(
      53                 :            :         //! Group, i.e., options, name
      54                 :            :         "Gamma method",
      55                 :            :         //! Enums -> names
      56         [ +  - ]:        379 :         { { MKLGammaMethodType::GNORM, kw::gnorm::name() },
      57         [ +  - ]:        758 :           { MKLGammaMethodType::GNORM_ACCURATE, kw::gnorm_accurate::name() } },
      58                 :            :         //! keywords -> Enums
      59                 :          0 :         { { kw::gnorm::string(), MKLGammaMethodType::GNORM },
      60         [ +  - ]:        758 :           { kw::gnorm_accurate::string(),
      61 [ +  - ][ +  - ]:       3790 :             MKLGammaMethodType::GNORM_ACCURATE } } ) {}
         [ +  - ][ +  - ]
         [ +  + ][ +  + ]
         [ +  - ][ -  - ]
                 [ -  - ]
      62                 :            : 
      63                 :            :     //! \brief Return parameter based on Enum
      64                 :            :     //! \details Here 'parameter' is the library-specific identifier of the
      65                 :            :     //!    option, i.e., as the library identifies the given option
      66                 :            :     //! \param[in] m Enum value of the option requested
      67                 :            :     //! \return Library-specific parameter of the option
      68                 :       3273 :     const ParamType& param( MKLGammaMethodType m ) const {
      69                 :            :       using tk::operator<<;
      70         [ +  - ]:       3273 :       auto it = method.find( m );
      71 [ +  + ][ +  - ]:       3273 :       Assert( it != end(method),
         [ +  - ][ +  - ]
         [ +  - ][ +  - ]
      72                 :            :               std::string("Cannot find parameter for MKLGammaMethod \"")
      73                 :            :               << m << "\"" );
      74                 :       3272 :       return it->second;
      75                 :            :     }
      76                 :            : 
      77                 :            :   private:
      78                 :            :     //! Enums -> MKL VSL RNG GAMMA METHOD parameters
      79                 :            :     std::map< MKLGammaMethodType, ParamType > method {
      80                 :            :       { MKLGammaMethodType::GNORM, VSL_RNG_METHOD_GAMMA_GNORM },
      81                 :            :       { MKLGammaMethodType::GNORM_ACCURATE,
      82                 :            :         VSL_RNG_METHOD_GAMMA_GNORM_ACCURATE }
      83                 :        379 :     };
      84                 :            : };
      85                 :            : 
      86                 :            : } // ctr::
      87                 :            : } // tk::
      88                 :            : 
      89                 :            : #endif // MKLGammaMethodOptions_h