libstdc++-v3/include/experimental/numeric

   1 // <experimental/numeric> -*- C++ -*-
   2
   3 // Copyright (C) 2015-2019 Free Software Foundation, Inc.
   4 //
   5 // This file is part of the GNU ISO C++ Library.  This library is free
   6 // software; you can redistribute it and/or modify it under the
   7 // terms of the GNU General Public License as published by the
   8 // Free Software Foundation; either version 3, or (at your option)
   9 // any later version.
  10
  11 // This library is distributed in the hope that it will be useful,
  12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 // GNU General Public License for more details.
  15
  16 // Under Section 7 of GPL version 3, you are granted additional
  17 // permissions described in the GCC Runtime Library Exception, version
  18 // 3.1, as published by the Free Software Foundation.
  19
  20 // You should have received a copy of the GNU General Public License and
  21 // a copy of the GCC Runtime Library Exception along with this program;
  22 // see the files COPYING3 and COPYING.RUNTIME respectively.  If not, see
  23 // <http://www.gnu.org/licenses/>.
  24
  25 /** @file experimental/numeric
  26  *  This is a TS C++ Library header.
  27  *  @ingroup libfund-ts
  28  */
  29
  30 //
  31 // N4336 Working Draft, C++ Extensions for Library Fundamentals, Version 2
  32 //
  33
  34 #ifndef _GLIBCXX_EXPERIMENTAL_NUMERIC
  35 #define _GLIBCXX_EXPERIMENTAL_NUMERIC 1
  36
  37 #pragma GCC system_header
  38
  39 #if __cplusplus >= 201402L
  40
  41 #include <numeric>
  42 #include <experimental/type_traits>
  43
  44 namespace std _GLIBCXX_VISIBILITY(default)
  45 {
  46 _GLIBCXX_BEGIN_NAMESPACE_VERSION
  47
  48 namespace experimental
  49 {
  50 inline namespace fundamentals_v2
  51 {
  52 #define __cpp_lib_experimental_gcd_lcm 201411
  53
  54   /// Greatest common divisor
  55   template<typename _Mn, typename _Nn>
  56     constexpr common_type_t<_Mn, _Nn>
  57     gcd(_Mn __m, _Nn __n)
  58     {
  59       static_assert(is_integral_v<_Mn>, "gcd arguments are integers");
  60       static_assert(is_integral_v<_Nn>, "gcd arguments are integers");
  61       static_assert(!is_same_v<remove_cv_t<_Mn>, bool>,
  62                     "gcd arguments are not bools");
  63       static_assert(!is_same_v<remove_cv_t<_Nn>, bool>,
  64                     "gcd arguments are not bools");
  65       return std::__detail::__gcd(__m, __n);
  66     }
  67
  68   /// Least common multiple
  69   template<typename _Mn, typename _Nn>
  70     constexpr common_type_t<_Mn, _Nn>
  71     lcm(_Mn __m, _Nn __n)
  72     {
  73       static_assert(is_integral_v<_Mn>, "lcm arguments are integers");
  74       static_assert(is_integral_v<_Nn>, "lcm arguments are integers");
  75       static_assert(!is_same_v<remove_cv_t<_Mn>, bool>,
  76                     "lcm arguments are not bools");
  77       static_assert(!is_same_v<remove_cv_t<_Nn>, bool>,
  78                     "lcm arguments are not bools");
  79       return std::__detail::__lcm(__m, __n);
  80     }
  81 } // namespace fundamentals_v2
  82 } // namespace experimental
  83
  84 _GLIBCXX_END_NAMESPACE_VERSION
  85 } // namespace std
  86
  87 #endif // __cplusplus <= 201103L
  88
  89 #endif // _GLIBCXX_EXPERIMENTAL_NUMERIC