src/gromacs/utility/template_mp.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2020,2021, by the GROMACS development team, led by
   5  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   6  * and including many others, as listed in the AUTHORS file in the
   7  * top-level source directory and at http://www.gromacs.org.
   8  *
   9  * GROMACS is free software; you can redistribute it and/or
  10  * modify it under the terms of the GNU Lesser General Public License
  11  * as published by the Free Software Foundation; either version 2.1
  12  * of the License, or (at your option) any later version.
  13  *
  14  * GROMACS is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17  * Lesser General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Lesser General Public
  20  * License along with GROMACS; if not, see
  21  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  22  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  23  *
  24  * If you want to redistribute modifications to GROMACS, please
  25  * consider that scientific software is very special. Version
  26  * control is crucial - bugs must be traceable. We will be happy to
  27  * consider code for inclusion in the official distribution, but
  28  * derived work must not be called official GROMACS. Details are found
  29  * in the README & COPYING files - if they are missing, get the
  30  * official version at http://www.gromacs.org.
  31  *
  32  * To help us fund GROMACS development, we humbly ask that you cite
  33  * the research papers on the package. Check out http://www.gromacs.org.
  34  */
  35 /*! \libinternal \file
  36  * \brief
  37  * Declares utilities for template metaprogramming
  38  *
  39  * \author Roland Schulz <roland.schulz@intel.com>
  40  *
  41  * \inlibraryapi
  42  * \ingroup module_utility
  43  */
  44 #ifndef GMX_UTILITY_TEMPLATE_MP_H
  45 #define GMX_UTILITY_TEMPLATE_MP_H
  46
  47 #include <cassert>
  48 #include <cstddef>
  49
  50 #include <utility>
  51
  52 #include "gromacs/compat/mp11.h"
  53
  54 namespace gmx
  55 {
  56
  57 /*! \internal \brief
  58  * Helper function to select appropriate template based on runtime values.
  59  *
  60  * Can use enums or booleans for template parameters.
  61  * These enums must have a member \c Count indicating the total number of valid values.
  62  *
  63  * Example usage:
  64  * \code
  65     enum class Options {
  66         Op1 = 0,
  67         Op2 = 1,
  68         Count = 2
  69     };
  70
  71     template<bool p0, Options p1, Options p2>
  72     bool foo(int i);
  73
  74     bool bar(bool p0, Options p1, Options p2, int i) {
  75         return dispatchTemplatedFunction(
  76             [=](auto p0, auto p1, auto p2) {
  77                 return foo<p0, p1, p2>(i);
  78             },
  79             p0, p1, p2);
  80     }
  81  * \endcode
  82  *
  83  * \tparam Function Type of \p f.
  84  * \param f Function to call.
  85  * \return The result of calling \c f().
  86 */
  87 template<class Function>
  88 auto dispatchTemplatedFunction(Function&& f)
  89 {
  90     return std::forward<Function>(f)();
  91 }
  92
  93 // Recursive templates confuse Doxygen
  94 //! \cond
  95 template<class Function, class Enum, class... Enums>
  96 auto dispatchTemplatedFunction(Function&& f, Enum e, Enums... es)
  97 {
  98     return dispatchTemplatedFunction(
  99             [&](auto... es_) {
 100                 return compat::mp_with_index<size_t(Enum::Count)>(size_t(e), [&](auto e_) {
 101                     return std::forward<Function>(f)(
 102                             std::integral_constant<Enum, static_cast<Enum>(size_t(e_))>(), es_...);
 103                 });
 104             },
 105             es...);
 106 }
 107
 108 template<class Function, class... Enums>
 109 auto dispatchTemplatedFunction(Function&& f, bool e, Enums... es)
 110 {
 111     return dispatchTemplatedFunction(
 112             [&](auto... es_) {
 113                 return compat::mp_with_index<2>(size_t(e), [&](auto e_) {
 114                     return std::forward<Function>(f)(std::bool_constant<static_cast<bool>(e_)>(), es_...);
 115                 });
 116             },
 117             es...);
 118 }
 119 //! \endcond
 120
 121 } // namespace gmx
 122
 123 #endif // GMX_UTILITY_TEMPLATE_MP_H