Branch data     Line data    Source code

       1                 :            : // *****************************************************************************
       2                 :            : /*!
       3                 :            :   \file      src/Control/Options/MKLUniformMethod.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 uniform RNG method options
       9                 :            :   \details   Intel MKL uniform RNG method options
      10                 :            : */
      11                 :            : // *****************************************************************************
      12                 :            : #ifndef MKLUniformMethodOptions_h
      13                 :            : #define MKLUniformMethodOptions_h
      14                 :            : 
      15                 :            : #include <map>
      16                 :            : 
      17                 :            : #include <brigand/sequences/list.hpp>
      18                 :            : 
      19                 :            : #include <mkl_vsl_defines.h>
      20                 :            : 
      21                 :            : #include "Toggle.hpp"
      22                 :            : #include "Keywords.hpp"
      23                 :            : #include "PUPUtil.hpp"
      24                 :            : 
      25                 :            : namespace tk {
      26                 :            : namespace ctr {
      27                 :            : 
      28                 :            : //! MKL uniform random number generator method types
      29                 :            : enum class MKLUniformMethodType : uint8_t { STANDARD,
      30                 :            :                                             ACCURATE };
      31                 :            : 
      32                 :            : //! \brief Pack/Unpack MKLGUniformMethodType: forward overload to generic enum
      33                 :            : //!   class packer
      34                 :            : inline void operator|( PUP::er& p, MKLUniformMethodType& e )
      35                 :            : { PUP::pup( p, e ); }
      36                 :            : 
      37                 :            : //! \brief MKLUniformMethod options: outsource searches to base templated on
      38                 :            : //!   enum type
      39 [ +  - ][ +  - ]:        389 : class MKLUniformMethod : public tk::Toggle< MKLUniformMethodType > {
      40                 :            : 
      41                 :            :   public:
      42                 :            :     using ParamType = int;
      43                 :            : 
      44                 :            :     //! Valid expected choices to make them also available at compile-time
      45                 :            :     using keywords = brigand::list< kw::standard
      46                 :            :                                   , kw::accurate
      47                 :            :                                   >;
      48                 :            : 
      49                 :            :     //! \brief Options constructor
      50                 :            :     //! \details Simply initialize in-line and pass associations to base, which
      51                 :            :     //!    will handle client interactions
      52                 :        383 :     explicit MKLUniformMethod() :
      53                 :            :       tk::Toggle< MKLUniformMethodType >(
      54                 :            :         //! Group, i.e., options, name
      55                 :            :         "uniform method",
      56                 :            :         //! Enums -> names
      57                 :        383 :         { { MKLUniformMethodType::STANDARD, kw::standard::name() },
      58 [ -  + ][ -  - ]:        383 :           { MKLUniformMethodType::ACCURATE, kw::accurate::name() }
      59                 :            :         },
      60                 :            :         //! keywords -> Enums
      61                 :        383 :         { { kw::standard::string(), MKLUniformMethodType::STANDARD },
      62 [ +  - ][ +  - ]:       3447 :           { kw::accurate::string(), MKLUniformMethodType::ACCURATE } } ) {}
         [ +  - ][ +  + ]
         [ -  + ][ -  + ]
         [ +  + ][ -  + ]
         [ -  + ][ -  + ]
         [ +  - ][ -  - ]
         [ -  - ][ -  - ]
         [ -  - ][ -  - ]
         [ -  - ][ -  - ]
      63                 :            : 
      64                 :            :     //! \brief Return parameter based on Enum
      65                 :            :     //! \details Here 'parameter' is the library-specific identifier of the
      66                 :            :     //!    option, i.e., as the library identifies the given option
      67                 :            :     //! \param[in] m Enum value of the option requested
      68                 :            :     //! \return Library-specific parameter of the option
      69                 :            :     const ParamType& param( MKLUniformMethodType m ) const {
      70                 :            :       using tk::operator<<;
      71                 :            :       auto it = method.find( m );
      72                 :            :       Assert( it != end(method),
      73                 :            :               std::string("Cannot find parameter for MKLUniformMethod \"")
      74                 :            :               << m << "\"" );
      75                 :       3267 :       return it->second;
      76                 :            :     }
      77                 :            : 
      78                 :            :   private:
      79                 :            :     //! Enums -> MKL VSL RNG UNIFORM METHOD parameters
      80                 :            :     std::map< MKLUniformMethodType, ParamType > method {
      81                 :            :       { MKLUniformMethodType::STANDARD, VSL_RNG_METHOD_UNIFORM_STD },
      82                 :            :       { MKLUniformMethodType::ACCURATE, VSL_RNG_METHOD_UNIFORM_STD_ACCURATE }
      83                 :        383 :     };
      84                 :            : };
      85                 :            : 
      86                 :            : } // ctr::
      87                 :            : } // tk::
      88                 :            : 
      89                 :            : #endif // MKLUniformMethodOptions_h