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 template<class Function>
  58 auto dispatchTemplatedFunction(Function&& f)
  59 {
  60     return std::forward<Function>(f)();
  61 }
  62
  63 /** \internal \brief Helper function to select appropriate template based on runtime values.
  64  *
  65  * Can use enums or booleans for template parameters.
  66  * These enums must have a member \c Count indicating the total number of valid values.
  67  *
  68  * Example usage:
  69  * \code
  70     enum class Options {
  71         Op1 = 0,
  72         Op2 = 1,
  73         Count = 2
  74     };
  75
  76     template<bool p0, Options p1, Options p2>
  77     bool foo(int i);
  78
  79     bool bar(bool p0, Options p1, Options p2, int i) {
  80         return dispatchTemplatedFunction(
  81             [=](auto p0, auto p1, auto p2) {
  82                 return foo<p0, p1, p2>(i);
  83             },
  84             p0, p1, p2);
  85     }
  86  * \endcode
  87  */
  88 template<class Function, class Enum, class... Enums>
  89 auto dispatchTemplatedFunction(Function&& f, Enum e, Enums... es)
  90 {
  91     return dispatchTemplatedFunction(
  92             [&](auto... es_) {
  93                 return compat::mp_with_index<size_t(Enum::Count)>(size_t(e), [&](auto e_) {
  94                     return std::forward<Function>(f)(
  95                             std::integral_constant<Enum, static_cast<Enum>(size_t(e_))>(), es_...);
  96                 });
  97             },
  98             es...);
  99 }
 100
 101 template<class Function, class... Enums>
 102 auto dispatchTemplatedFunction(Function&& f, bool e, Enums... es)
 103 {
 104     return dispatchTemplatedFunction(
 105             [&](auto... es_) {
 106                 return compat::mp_with_index<2>(size_t(e), [&](auto e_) {
 107                     return std::forward<Function>(f)(std::bool_constant<static_cast<bool>(e_)>(), es_...);
 108                 });
 109             },
 110             es...);
 111 }
 112
 113 } // namespace gmx
 114
 115 #endif // GMX_UTILITY_TEMPLATE_MP_H