Branch data     Line data    Source code

       1                 :            : // *****************************************************************************
       2                 :            : /*!
       3                 :            :   \file      src/Control/Options/MKLGaussianMVMethod.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 multi-variate Gaussian RNG method options
       9                 :            :   \details   Intel MKL multi-variate Gaussian RNG method options
      10                 :            : */
      11                 :            : // *****************************************************************************
      12                 :            : #ifndef MKLGaussianMVMethodOptions_h
      13                 :            : #define MKLGaussianMVMethodOptions_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 Gaussian random number generator method types
      29                 :            : enum class MKLGaussianMVMethodType : uint8_t { BOXMULLER,
      30                 :            :                                                BOXMULLER2,
      31                 :            :                                                ICDF };
      32                 :            : 
      33                 :            : //! \brief Pack/Unpack MKLGaussianMVMethodType: forward overload to generic enum
      34                 :            : //!   class packer
      35                 :            : inline void operator|( PUP::er& p, MKLGaussianMVMethodType& e )
      36                 :            : { PUP::pup( p, e ); }
      37                 :            : 
      38                 :            : //! \brief MKLGaussianMVMethod options: outsource searches to base templated on
      39                 :            : //!   enum type
      40                 :        301 : class MKLGaussianMVMethod : public tk::Toggle< MKLGaussianMVMethodType > {
      41                 :            : 
      42                 :            :   public:
      43                 :            :     using ParamType = int;
      44                 :            : 
      45                 :            :     //! Valid expected choices to make them also available at compile-time
      46                 :            :     using keywords = brigand::list< kw::boxmuller
      47                 :            :                                   , kw::boxmuller2
      48                 :            :                                   , kw::icdf
      49                 :            :                                   >;
      50                 :            : 
      51                 :            :     //! \brief Options constructor
      52                 :            :     //! \details Simply initialize in-line and pass associations to base, which
      53                 :            :     //!    will handle client interactions
      54                 :        301 :     explicit MKLGaussianMVMethod() :
      55                 :            :       tk::Toggle< MKLGaussianMVMethodType >(
      56                 :            :         //! Group, i.e., options, name
      57                 :            :         "Gaussian method",
      58                 :            :         //! Enums -> names
      59                 :        301 :         { { MKLGaussianMVMethodType::BOXMULLER, kw::boxmuller::name() },
      60 [ -  + ][ -  - ]:        301 :           { MKLGaussianMVMethodType::BOXMULLER2, kw::boxmuller2::name() },
      61 [ -  + ][ -  - ]:        301 :           { MKLGaussianMVMethodType::ICDF, kw::icdf::name() } },
      62                 :            :         //! keywords -> Enums
      63                 :        301 :         { { kw::boxmuller::string(), MKLGaussianMVMethodType::BOXMULLER },
      64 [ -  + ][ -  - ]:        301 :           { kw::boxmuller2::string(), MKLGaussianMVMethodType::BOXMULLER2 },
      65 [ +  - ][ +  - ]:       3612 :           { kw::icdf::string(), MKLGaussianMVMethodType::ICDF } } ) {}
         [ +  - ][ +  + ]
         [ -  + ][ -  + ]
         [ +  + ][ -  + ]
         [ -  + ][ -  + ]
         [ +  - ][ -  - ]
         [ -  - ][ -  - ]
         [ -  - ][ -  - ]
         [ -  - ][ -  - ]
      66                 :            : 
      67                 :            :     //! \brief Return parameter based on Enum
      68                 :            :     //! \details Here 'parameter' is the library-specific identifier of the
      69                 :            :     //!    option, i.e., as the library identifies the given option
      70                 :            :     //! \param[in] m Enum value of the option requested
      71                 :            :     //! \return Library-specific parameter of the option
      72                 :            :     const ParamType& param( MKLGaussianMVMethodType m ) const {
      73                 :            :       using tk::operator<<;
      74                 :            :       auto it = method.find( m );
      75                 :            :       Assert( it != end(method),
      76                 :            :               std::string("Cannot find parameter for MKLGaussianMVMethod \"")
      77                 :            :               << m << "\"" );
      78                 :       3267 :       return it->second;
      79                 :            :     }
      80                 :            : 
      81                 :            :   private:
      82                 :            :     //! Enums -> MKL VSL RNG GAUSSIAN METHOD parameters
      83                 :            :     std::map< MKLGaussianMVMethodType, ParamType > method {
      84                 :            :       { MKLGaussianMVMethodType::BOXMULLER,
      85                 :            :         VSL_RNG_METHOD_GAUSSIANMV_BOXMULLER },
      86                 :            :       { MKLGaussianMVMethodType::BOXMULLER2,
      87                 :            :         VSL_RNG_METHOD_GAUSSIANMV_BOXMULLER2 },
      88                 :            :       { MKLGaussianMVMethodType::ICDF, VSL_RNG_METHOD_GAUSSIANMV_ICDF }
      89                 :        301 :     };
      90                 :            : };
      91                 :            : 
      92                 :            : } // ctr::
      93                 :            : } // tk::
      94                 :            : 
      95                 :            : #endif // MKLGaussianMVMethodOptions_h