src/gromacs/compat/mp11.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2018,2019,2020, 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
  36 /*! \libinternal \file
  37  * \brief Provides ported functions/classes from boost::mp11
  38  *
  39  * Adapted from the Boost Library 1.67
  40  *
  41  * \author Roland Schulz <roland.schulz@intel.com>
  42  * \ingroup module_compat
  43  * \inlibraryapi
  44  */
  45 #ifndef GMX_COMPAT_MP11_H
  46 #define GMX_COMPAT_MP11_H
  47
  48 #include <utility>
  49
  50 #include "gromacs/utility/exceptions.h"
  51
  52 namespace gmx
  53 {
  54 namespace compat
  55 {
  56
  57 /** \internal \brief Simplified analogue of boost::mp11::mp_with_index, compatible only with C++17 and up.
  58  *
  59  * \c mp_with_index<N>(i, f) calls \p f with \c mp_size_t<i>() and returns the result.
  60  * \p i must be less than \p N.
  61  *
  62  * Example usage:
  63  * \code
  64     constexpr int foo_max = 3;
  65     template<int i, typename = std::enable_if_t<(i < foo_max)>>
  66     bool constexpr foo();
  67
  68     bool bar(int i)
  69     {
  70         return mp_with_index<foo_max>(i, [](auto i) {
  71             return foo<i>();
  72         });
  73     }
  74  * \endcode
  75  */
  76 template<std::size_t N, class F, typename std::enable_if<(N <= 1)>::type* = nullptr>
  77 static auto mp_with_index(std::size_t i, F&& f)
  78 {
  79     // Last step of recursion. Must have one active "return" for proper type deduction.
  80     if (i == N - 1)
  81     {
  82         return std::forward<F>(f)(std::integral_constant<std::size_t, N - 1>());
  83     }
  84     else
  85     {
  86         const std::string errorMessage =
  87                 "Invalid arguments of mp_with_index (i=" + std::to_string(i) + ")";
  88         GMX_THROW(InternalError(errorMessage));
  89     }
  90 }
  91
  92 template<std::size_t N, class F, typename std::enable_if<(N > 1)>::type* = nullptr>
  93 static auto mp_with_index(std::size_t i, F&& f)
  94 {
  95     if (i == N - 1)
  96     {
  97         return std::forward<F>(f)(std::integral_constant<std::size_t, N - 1>());
  98     }
  99     else
 100     {
 101         return mp_with_index<N - 1>(i, std::forward<F>(f));
 102     }
 103 }
 104
 105
 106 } // namespace compat
 107 } // namespace gmx
 108
 109 #endif