Use proper doxygen tags in modular simulator
[gromacs.git] / src / gromacs / utility / typetraits.h
blob90c820002e004a0bec99b9fb11f132879547f2b7
1 /*
2 * This file is part of the GROMACS molecular simulation package.
4 * Copyright (c) 2017,2019, 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.
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.
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.
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.
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.
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.
35 /*! \libinternal \file
36 * \brief
37 * Declares type traits
39 * \inlibraryapi
40 * \ingroup module_utility
43 #ifndef GMX_UTILITY_TYPETRAITS_H
44 #define GMX_UTILITY_TYPETRAITS_H
46 #include <type_traits>
48 namespace gmx
51 /*! \libinternal \brief
52 * Is true if type is a std::integral_constant
54 * If the optional integral type is given, than it is only true for a
55 * std::integral_constant of that integral type.
57 * \tparam T type to check
58 * \tparam Int optional integral type
60 template<typename T, typename Int = void>
61 struct isIntegralConstant : public std::false_type
65 template<typename Int, Int N>
66 struct isIntegralConstant<std::integral_constant<Int, N>, void> : public std::true_type
70 template<typename Int, Int N>
71 struct isIntegralConstant<std::integral_constant<Int, N>, Int> : public std::true_type
75 } // namespace gmx
77 #endif