libstdc++
experimental/numeric
Go to the documentation of this file.
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 */
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
43namespace std _GLIBCXX_VISIBILITY(default)
44{
45_GLIBCXX_BEGIN_NAMESPACE_VERSION
46
47namespace experimental
48{
49inline 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)
57 {
58 static_assert(is_integral_v<_Mn>, "gcd arguments are integers");
59 static_assert(is_integral_v<_Nn>, "gcd arguments are integers");
60 static_assert(!is_same_v<remove_cv_t<_Mn>, bool>,
61 "gcd arguments are not bools");
62 static_assert(!is_same_v<remove_cv_t<_Nn>, bool>,
63 "gcd arguments are not bools");
64 return std::__detail::__gcd(__m, __n);
65 }
66
67 /// Least common multiple
68 template<typename _Mn, typename _Nn>
69 constexpr common_type_t<_Mn, _Nn>
70 lcm(_Mn __m, _Nn __n)
71 {
72 static_assert(is_integral_v<_Mn>, "lcm arguments are integers");
73 static_assert(is_integral_v<_Nn>, "lcm arguments are integers");
74 static_assert(!is_same_v<remove_cv_t<_Mn>, bool>,
75 "lcm arguments are not bools");
76 static_assert(!is_same_v<remove_cv_t<_Nn>, bool>,
77 "lcm arguments are not bools");
78 return std::__detail::__lcm(__m, __n);
79 }
80} // namespace fundamentals_v2
81} // namespace experimental
82
83_GLIBCXX_END_NAMESPACE_VERSION
84} // namespace std
85
86#endif // __cplusplus <= 201103L
87
88#endif // _GLIBCXX_EXPERIMENTAL_NUMERIC