libstdc++
experimental/numeric
Go to the documentation of this file.
1 // <experimental/numeric> -*- C++ -*-
2 
3 // Copyright (C) 2015-2018 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  */
28 
29 //
30 // N4336 Working Draft, C++ Extensions for Library Fundamentals, Version 2
31 //
32 
33 #ifndef _GLIBCXX_EXPERIMENTAL_NUMERIC
34 #define _GLIBCXX_EXPERIMENTAL_NUMERIC 1
35 
36 #pragma GCC system_header
37 
38 #if __cplusplus >= 201402L
39 
40 #include <numeric>
41 #include <experimental/type_traits>
42 
43 namespace std _GLIBCXX_VISIBILITY(default)
44 {
45 _GLIBCXX_BEGIN_NAMESPACE_VERSION
46 
47 namespace experimental
48 {
49 inline namespace fundamentals_v2
50 {
51 #define __cpp_lib_experimental_gcd_lcm 201411
52 
53  /// Greatest common divisor
54  template<typename _Mn, typename _Nn>
55  constexpr common_type_t<_Mn, _Nn>
56  gcd(_Mn __m, _Nn __n) noexcept
57  {
58  static_assert(is_integral_v<_Mn>,
59  "std::experimental::gcd arguments must be integers");
60  static_assert(is_integral_v<_Nn>,
61  "std::experimental::gcd arguments must be integers");
62  static_assert(_Mn(2) != _Mn(1),
63  "std::experimental::gcd arguments must not be bool");
64  static_assert(_Nn(2) != _Nn(1),
65  "std::experimental::gcd arguments must not be bool");
66  using _Up = make_unsigned_t<common_type_t<_Mn, _Nn>>;
67  return std::__detail::__gcd(std::__detail::__absu<_Up>(__m),
68  std::__detail::__absu<_Up>(__n));
69  }
70 
71  /// Least common multiple
72  template<typename _Mn, typename _Nn>
73  constexpr common_type_t<_Mn, _Nn>
74  lcm(_Mn __m, _Nn __n)
75  {
76  static_assert(is_integral_v<_Mn>,
77  "std::experimental::lcm arguments must be integers");
78  static_assert(is_integral_v<_Nn>,
79  "std::experimental::lcm arguments must be integers");
80  static_assert(_Mn(2) != _Mn(1),
81  "std::experimental::lcm arguments must not be bool");
82  static_assert(_Nn(2) != _Nn(1),
83  "std::experimental::lcm arguments must not be bool");
84  using _Up = make_unsigned_t<common_type_t<_Mn, _Nn>>;
85  return std::__detail::__lcm(std::__detail::__absu<_Up>(__m),
86  std::__detail::__absu<_Up>(__n));
87  }
88 } // namespace fundamentals_v2
89 } // namespace experimental
90 
91 _GLIBCXX_END_NAMESPACE_VERSION
92 } // namespace std
93 
94 #endif // __cplusplus <= 201103L
95 
96 #endif // _GLIBCXX_EXPERIMENTAL_NUMERIC