1 // <numeric> -*- C++ -*-
3 // Copyright (C) 2001-2019 Free Software Foundation, Inc.
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)
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.
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.
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/>.
28 * Hewlett-Packard Company
30 * Permission to use, copy, modify, distribute and sell this software
31 * and its documentation for any purpose is hereby granted without fee,
32 * provided that the above copyright notice appear in all copies and
33 * that both that copyright notice and this permission notice appear
34 * in supporting documentation. Hewlett-Packard Company makes no
35 * representations about the suitability of this software for any
36 * purpose. It is provided "as is" without express or implied warranty.
39 * Copyright (c) 1996,1997
40 * Silicon Graphics Computer Systems, Inc.
42 * Permission to use, copy, modify, distribute and sell this software
43 * and its documentation for any purpose is hereby granted without fee,
44 * provided that the above copyright notice appear in all copies and
45 * that both that copyright notice and this permission notice appear
46 * in supporting documentation. Silicon Graphics makes no
47 * representations about the suitability of this software for any
48 * purpose. It is provided "as is" without express or implied warranty.
51 /** @file include/numeric
52 * This is a Standard C++ Library header.
55 #ifndef _GLIBCXX_NUMERIC
56 #define _GLIBCXX_NUMERIC 1
58 #pragma GCC system_header
60 #include <bits/c++config.h>
61 #include <bits/stl_iterator_base_types.h>
62 #include <bits/stl_numeric.h>
63 #include <ext/numeric_traits.h>
65 #ifdef _GLIBCXX_PARALLEL
66 # include <parallel/numeric>
70 * @defgroup numerics Numerics
72 * Components for performing numeric operations. Includes support for
73 * complex number types, random number generation, numeric (n-at-a-time)
74 * arrays, generalized numeric algorithms, and mathematical special functions.
77 #if __cplusplus >= 201402L
78 #include <type_traits>
80 namespace std _GLIBCXX_VISIBILITY(default)
82 _GLIBCXX_BEGIN_NAMESPACE_VERSION
86 // std::abs is not constexpr, doesn't support unsigned integers,
87 // and std::abs(std::numeric_limits<T>::min()) is undefined.
88 template<typename _Up, typename _Tp>
92 static_assert(is_unsigned<_Up>::value, "result type must be unsigned");
93 static_assert(sizeof(_Up) >= sizeof(_Tp),
94 "result type must be at least as wide as the input type");
95 return __val < 0 ? -(_Up)__val : (_Up)__val;
98 template<typename _Up> void __absu(bool) = delete;
100 // GCD implementation
101 template<typename _Tp>
103 __gcd(_Tp __m, _Tp __n)
105 static_assert(is_unsigned<_Tp>::value, "type must be unsigned");
106 return __m == 0 ? __n
108 : __detail::__gcd(__n, _Tp(__m % __n));
111 // LCM implementation
112 template<typename _Tp>
114 __lcm(_Tp __m, _Tp __n)
116 return (__m != 0 && __n != 0)
117 ? (__m / __detail::__gcd(__m, __n)) * __n
120 } // namespace __detail
122 #if __cplusplus >= 201703L
124 #define __cpp_lib_gcd_lcm 201606
125 // These were used in drafts of SD-6:
126 #define __cpp_lib_gcd 201606
127 #define __cpp_lib_lcm 201606
129 /// Greatest common divisor
130 template<typename _Mn, typename _Nn>
131 constexpr common_type_t<_Mn, _Nn>
132 gcd(_Mn __m, _Nn __n) noexcept
134 static_assert(is_integral_v<_Mn>, "std::gcd arguments must be integers");
135 static_assert(is_integral_v<_Nn>, "std::gcd arguments must be integers");
136 static_assert(_Mn(2) != _Mn(1), "std::gcd arguments must not be bool");
137 static_assert(_Nn(2) != _Nn(1), "std::gcd arguments must not be bool");
138 using _Up = make_unsigned_t<common_type_t<_Mn, _Nn>>;
139 return __detail::__gcd(__detail::__absu<_Up>(__m),
140 __detail::__absu<_Up>(__n));
143 /// Least common multiple
144 template<typename _Mn, typename _Nn>
145 constexpr common_type_t<_Mn, _Nn>
146 lcm(_Mn __m, _Nn __n) noexcept
148 static_assert(is_integral_v<_Mn>, "std::lcm arguments must be integers");
149 static_assert(is_integral_v<_Nn>, "std::lcm arguments must be integers");
150 static_assert(_Mn(2) == 2, "std::lcm arguments must not be bool");
151 static_assert(_Nn(2) == 2, "std::lcm arguments must not be bool");
152 using _Up = make_unsigned_t<common_type_t<_Mn, _Nn>>;
153 return __detail::__lcm(__detail::__absu<_Up>(__m),
154 __detail::__absu<_Up>(__n));
159 _GLIBCXX_END_NAMESPACE_VERSION
164 #if __cplusplus > 201703L
167 namespace std _GLIBCXX_VISIBILITY(default)
169 _GLIBCXX_BEGIN_NAMESPACE_VERSION
171 # define __cpp_lib_interpolate 201902L
173 template<typename _Tp>
175 enable_if_t<__and_v<is_arithmetic<_Tp>, is_same<remove_cv_t<_Tp>, _Tp>,
176 __not_<is_same<_Tp, bool>>>,
178 midpoint(_Tp __a, _Tp __b) noexcept
180 if constexpr (is_integral_v<_Tp>)
182 using _Up = make_unsigned_t<_Tp>;
193 return __a + __k * _Tp(_Up(__M - __m) / 2);
197 constexpr _Tp __lo = numeric_limits<_Tp>::min() * 2;
198 constexpr _Tp __hi = numeric_limits<_Tp>::max() / 2;
199 const _Tp __abs_a = __a < 0 ? -__a : __a;
200 const _Tp __abs_b = __b < 0 ? -__b : __b;
201 if (__abs_a <= __hi && __abs_b <= __hi) [[likely]]
202 return (__a + __b) / 2; // always correctly rounded
203 if (__abs_a < __lo) // not safe to halve __a
205 if (__abs_b < __lo) // not safe to halve __b
207 return __a/2 + __b/2; // otherwise correctly rounded
211 template<typename _Tp>
213 enable_if_t<__and_v<is_object<_Tp>, bool_constant<sizeof(_Tp) != 0>>, _Tp*>
214 midpoint(_Tp* __a, _Tp* __b) noexcept
216 return __a + (__b - __a) / 2;
218 _GLIBCXX_END_NAMESPACE_VERSION
223 #if __cplusplus > 201402L
224 #include <bits/stl_function.h>
226 namespace std _GLIBCXX_VISIBILITY(default)
228 _GLIBCXX_BEGIN_NAMESPACE_VERSION
230 /// @addtogroup numeric_ops
233 /// @cond undocumented
234 template<typename _It, typename _Traits = iterator_traits<_It>,
235 typename _Cat = typename _Traits::iterator_category>
236 using __is_random_access_iter
237 = is_base_of<random_access_iterator_tag, _Cat>;
241 * @brief Calculate reduction of values in a range.
243 * @param __first Start of range.
244 * @param __last End of range.
245 * @param __init Starting value to add other values to.
246 * @param __binary_op A binary function object.
247 * @return The final sum.
249 * Reduce the values in the range `[first,last)` using a binary operation.
250 * The initial value is `init`. The values are not necessarily processed
253 * This algorithm is similar to `std::accumulate` but is not required to
254 * perform the operations in order from first to last. For operations
255 * that are commutative and associative the result will be the same as
256 * for `std::accumulate`, but for other operations (such as floating point
257 * arithmetic) the result can be different.
259 template<typename _InputIterator, typename _Tp, typename _BinaryOperation>
261 reduce(_InputIterator __first, _InputIterator __last, _Tp __init,
262 _BinaryOperation __binary_op)
264 using value_type = typename iterator_traits<_InputIterator>::value_type;
265 static_assert(is_invocable_r_v<_Tp, _BinaryOperation&, _Tp&, _Tp&>);
266 static_assert(is_convertible_v<value_type, _Tp>);
267 if constexpr (__is_random_access_iter<_InputIterator>::value)
269 while ((__last - __first) >= 4)
271 _Tp __v1 = __binary_op(__first[0], __first[1]);
272 _Tp __v2 = __binary_op(__first[2], __first[3]);
273 _Tp __v3 = __binary_op(__v1, __v2);
274 __init = __binary_op(__init, __v3);
278 for (; __first != __last; ++__first)
279 __init = __binary_op(__init, *__first);
284 * @brief Calculate reduction of values in a range.
286 * @param __first Start of range.
287 * @param __last End of range.
288 * @param __init Starting value to add other values to.
289 * @return The final sum.
291 * Reduce the values in the range `[first,last)` using addition.
292 * Equivalent to calling `std::reduce(first, last, init, std::plus<>())`.
294 template<typename _InputIterator, typename _Tp>
296 reduce(_InputIterator __first, _InputIterator __last, _Tp __init)
297 { return std::reduce(__first, __last, std::move(__init), plus<>()); }
300 * @brief Calculate reduction of values in a range.
302 * @param __first Start of range.
303 * @param __last End of range.
304 * @return The final sum.
306 * Reduce the values in the range `[first,last)` using addition, with
307 * an initial value of `T{}`, where `T` is the iterator's value type.
308 * Equivalent to calling `std::reduce(first, last, T{}, std::plus<>())`.
310 template<typename _InputIterator>
311 inline typename iterator_traits<_InputIterator>::value_type
312 reduce(_InputIterator __first, _InputIterator __last)
314 using value_type = typename iterator_traits<_InputIterator>::value_type;
315 return std::reduce(__first, __last, value_type{}, plus<>());
319 * @brief Combine elements from two ranges and reduce
321 * @param __first1 Start of first range.
322 * @param __last1 End of first range.
323 * @param __first2 Start of second range.
324 * @param __init Starting value to add other values to.
325 * @param __binary_op1 The function used to perform reduction.
326 * @param __binary_op2 The function used to combine values from the ranges.
327 * @return The final sum.
329 * Call `binary_op2(first1[n],first2[n])` for each `n` in `[0,last1-first1)`
330 * and then use `binary_op1` to reduce the values returned by `binary_op2`
331 * to a single value of type `T`.
333 * The range beginning at `first2` must contain at least `last1-first1`
336 template<typename _InputIterator1, typename _InputIterator2, typename _Tp,
337 typename _BinaryOperation1, typename _BinaryOperation2>
339 transform_reduce(_InputIterator1 __first1, _InputIterator1 __last1,
340 _InputIterator2 __first2, _Tp __init,
341 _BinaryOperation1 __binary_op1,
342 _BinaryOperation2 __binary_op2)
344 if constexpr (__and_v<__is_random_access_iter<_InputIterator1>,
345 __is_random_access_iter<_InputIterator2>>)
347 while ((__last1 - __first1) >= 4)
349 _Tp __v1 = __binary_op1(__binary_op2(__first1[0], __first2[0]),
350 __binary_op2(__first1[1], __first2[1]));
351 _Tp __v2 = __binary_op1(__binary_op2(__first1[2], __first2[2]),
352 __binary_op2(__first1[3], __first2[3]));
353 _Tp __v3 = __binary_op1(__v1, __v2);
354 __init = __binary_op1(__init, __v3);
359 for (; __first1 != __last1; ++__first1, (void) ++__first2)
360 __init = __binary_op1(__init, __binary_op2(*__first1, *__first2));
365 * @brief Combine elements from two ranges and reduce
367 * @param __first1 Start of first range.
368 * @param __last1 End of first range.
369 * @param __first2 Start of second range.
370 * @param __init Starting value to add other values to.
371 * @return The final sum.
373 * Call `first1[n]*first2[n]` for each `n` in `[0,last1-first1)` and then
374 * use addition to sum those products to a single value of type `T`.
376 * The range beginning at `first2` must contain at least `last1-first1`
379 template<typename _InputIterator1, typename _InputIterator2, typename _Tp>
381 transform_reduce(_InputIterator1 __first1, _InputIterator1 __last1,
382 _InputIterator2 __first2, _Tp __init)
384 return std::transform_reduce(__first1, __last1, __first2,
386 plus<>(), multiplies<>());
390 * @brief Transform the elements of a range and reduce
392 * @param __first Start of range.
393 * @param __last End of range.
394 * @param __init Starting value to add other values to.
395 * @param __binary_op The function used to perform reduction.
396 * @param __unary_op The function used to transform values from the range.
397 * @return The final sum.
399 * Call `unary_op(first[n])` for each `n` in `[0,last-first)` and then
400 * use `binary_op` to reduce the values returned by `unary_op`
401 * to a single value of type `T`.
403 template<typename _InputIterator, typename _Tp,
404 typename _BinaryOperation, typename _UnaryOperation>
406 transform_reduce(_InputIterator __first, _InputIterator __last, _Tp __init,
407 _BinaryOperation __binary_op, _UnaryOperation __unary_op)
409 if constexpr (__is_random_access_iter<_InputIterator>::value)
411 while ((__last - __first) >= 4)
413 _Tp __v1 = __binary_op(__unary_op(__first[0]),
414 __unary_op(__first[1]));
415 _Tp __v2 = __binary_op(__unary_op(__first[2]),
416 __unary_op(__first[3]));
417 _Tp __v3 = __binary_op(__v1, __v2);
418 __init = __binary_op(__init, __v3);
422 for (; __first != __last; ++__first)
423 __init = __binary_op(__init, __unary_op(*__first));
427 /** @brief Output the cumulative sum of one range to a second range
429 * @param __first Start of input range.
430 * @param __last End of input range.
431 * @param __result Start of output range.
432 * @param __init Initial value.
433 * @param __binary_op Function to perform summation.
434 * @return The end of the output range.
436 * Write the cumulative sum (aka prefix sum, aka scan) of the input range
437 * to the output range. Each element of the output range contains the
438 * running total of all earlier elements (and the initial value),
439 * using `binary_op` for summation.
441 * This function generates an "exclusive" scan, meaning the Nth element
442 * of the output range is the sum of the first N-1 input elements,
443 * so the Nth input element is not included.
445 template<typename _InputIterator, typename _OutputIterator, typename _Tp,
446 typename _BinaryOperation>
448 exclusive_scan(_InputIterator __first, _InputIterator __last,
449 _OutputIterator __result, _Tp __init,
450 _BinaryOperation __binary_op)
452 while (__first != __last)
455 __init = __binary_op(__init, *__first);
457 *__result++ = std::move(__v);
462 /** @brief Output the cumulative sum of one range to a second range
464 * @param __first Start of input range.
465 * @param __last End of input range.
466 * @param __result Start of output range.
467 * @param __init Initial value.
468 * @return The end of the output range.
470 * Write the cumulative sum (aka prefix sum, aka scan) of the input range
471 * to the output range. Each element of the output range contains the
472 * running total of all earlier elements (and the initial value),
473 * using `std::plus<>` for summation.
475 * This function generates an "exclusive" scan, meaning the Nth element
476 * of the output range is the sum of the first N-1 input elements,
477 * so the Nth input element is not included.
479 template<typename _InputIterator, typename _OutputIterator, typename _Tp>
480 inline _OutputIterator
481 exclusive_scan(_InputIterator __first, _InputIterator __last,
482 _OutputIterator __result, _Tp __init)
484 return std::exclusive_scan(__first, __last, __result, std::move(__init),
488 /** @brief Output the cumulative sum of one range to a second range
490 * @param __first Start of input range.
491 * @param __last End of input range.
492 * @param __result Start of output range.
493 * @param __binary_op Function to perform summation.
494 * @param __init Initial value.
495 * @return The end of the output range.
497 * Write the cumulative sum (aka prefix sum, aka scan) of the input range
498 * to the output range. Each element of the output range contains the
499 * running total of all earlier elements (and the initial value),
500 * using `binary_op` for summation.
502 * This function generates an "inclusive" scan, meaning the Nth element
503 * of the output range is the sum of the first N input elements,
504 * so the Nth input element is included.
506 template<typename _InputIterator, typename _OutputIterator,
507 typename _BinaryOperation, typename _Tp>
509 inclusive_scan(_InputIterator __first, _InputIterator __last,
510 _OutputIterator __result, _BinaryOperation __binary_op,
513 for (; __first != __last; ++__first)
514 *__result++ = __init = __binary_op(__init, *__first);
518 /** @brief Output the cumulative sum of one range to a second range
520 * @param __first Start of input range.
521 * @param __last End of input range.
522 * @param __result Start of output range.
523 * @param __binary_op Function to perform summation.
524 * @return The end of the output range.
526 * Write the cumulative sum (aka prefix sum, aka scan) of the input range
527 * to the output range. Each element of the output range contains the
528 * running total of all earlier elements, using `binary_op` for summation.
530 * This function generates an "inclusive" scan, meaning the Nth element
531 * of the output range is the sum of the first N input elements,
532 * so the Nth input element is included.
534 template<typename _InputIterator, typename _OutputIterator,
535 typename _BinaryOperation>
537 inclusive_scan(_InputIterator __first, _InputIterator __last,
538 _OutputIterator __result, _BinaryOperation __binary_op)
540 if (__first != __last)
542 auto __init = *__first;
543 *__result++ = __init;
545 if (__first != __last)
546 __result = std::inclusive_scan(__first, __last, __result,
547 __binary_op, std::move(__init));
552 /** @brief Output the cumulative sum of one range to a second range
554 * @param __first Start of input range.
555 * @param __last End of input range.
556 * @param __result Start of output range.
557 * @return The end of the output range.
559 * Write the cumulative sum (aka prefix sum, aka scan) of the input range
560 * to the output range. Each element of the output range contains the
561 * running total of all earlier elements, using `std::plus<>` for summation.
563 * This function generates an "inclusive" scan, meaning the Nth element
564 * of the output range is the sum of the first N input elements,
565 * so the Nth input element is included.
567 template<typename _InputIterator, typename _OutputIterator>
568 inline _OutputIterator
569 inclusive_scan(_InputIterator __first, _InputIterator __last,
570 _OutputIterator __result)
571 { return std::inclusive_scan(__first, __last, __result, plus<>()); }
573 /** @brief Output the cumulative sum of one range to a second range
575 * @param __first Start of input range.
576 * @param __last End of input range.
577 * @param __result Start of output range.
578 * @param __init Initial value.
579 * @param __binary_op Function to perform summation.
580 * @param __unary_op Function to transform elements of the input range.
581 * @return The end of the output range.
583 * Write the cumulative sum (aka prefix sum, aka scan) of the input range
584 * to the output range. Each element of the output range contains the
585 * running total of all earlier elements (and the initial value),
586 * using `__unary_op` to transform the input elements
587 * and using `__binary_op` for summation.
589 * This function generates an "exclusive" scan, meaning the Nth element
590 * of the output range is the sum of the first N-1 input elements,
591 * so the Nth input element is not included.
593 template<typename _InputIterator, typename _OutputIterator, typename _Tp,
594 typename _BinaryOperation, typename _UnaryOperation>
596 transform_exclusive_scan(_InputIterator __first, _InputIterator __last,
597 _OutputIterator __result, _Tp __init,
598 _BinaryOperation __binary_op,
599 _UnaryOperation __unary_op)
601 while (__first != __last)
604 __init = __binary_op(__init, __unary_op(*__first));
606 *__result++ = std::move(__v);
611 /** @brief Output the cumulative sum of one range to a second range
613 * @param __first Start of input range.
614 * @param __last End of input range.
615 * @param __result Start of output range.
616 * @param __binary_op Function to perform summation.
617 * @param __unary_op Function to transform elements of the input range.
618 * @param __init Initial value.
619 * @return The end of the output range.
621 * Write the cumulative sum (aka prefix sum, aka scan) of the input range
622 * to the output range. Each element of the output range contains the
623 * running total of all earlier elements (and the initial value),
624 * using `__unary_op` to transform the input elements
625 * and using `__binary_op` for summation.
627 * This function generates an "inclusive" scan, meaning the Nth element
628 * of the output range is the sum of the first N input elements,
629 * so the Nth input element is included.
631 template<typename _InputIterator, typename _OutputIterator,
632 typename _BinaryOperation, typename _UnaryOperation, typename _Tp>
634 transform_inclusive_scan(_InputIterator __first, _InputIterator __last,
635 _OutputIterator __result,
636 _BinaryOperation __binary_op,
637 _UnaryOperation __unary_op,
640 for (; __first != __last; ++__first)
641 *__result++ = __init = __binary_op(__init, __unary_op(*__first));
645 /** @brief Output the cumulative sum of one range to a second range
647 * @param __first Start of input range.
648 * @param __last End of input range.
649 * @param __result Start of output range.
650 * @param __binary_op Function to perform summation.
651 * @param __unary_op Function to transform elements of the input range.
652 * @return The end of the output range.
654 * Write the cumulative sum (aka prefix sum, aka scan) of the input range
655 * to the output range. Each element of the output range contains the
656 * running total of all earlier elements,
657 * using `__unary_op` to transform the input elements
658 * and using `__binary_op` for summation.
660 * This function generates an "inclusive" scan, meaning the Nth element
661 * of the output range is the sum of the first N input elements,
662 * so the Nth input element is included.
664 template<typename _InputIterator, typename _OutputIterator,
665 typename _BinaryOperation, typename _UnaryOperation>
667 transform_inclusive_scan(_InputIterator __first, _InputIterator __last,
668 _OutputIterator __result,
669 _BinaryOperation __binary_op,
670 _UnaryOperation __unary_op)
672 if (__first != __last)
674 auto __init = __unary_op(*__first);
675 *__result++ = __init;
677 if (__first != __last)
678 __result = std::transform_inclusive_scan(__first, __last, __result,
679 __binary_op, __unary_op,
685 /// @} group numeric_ops
687 _GLIBCXX_END_NAMESPACE_VERSION
690 // Parallel STL algorithms
691 # if __PSTL_EXECUTION_POLICIES_DEFINED
692 // If <execution> has already been included, pull in implementations
693 # include <pstl/glue_numeric_impl.h>
695 // Otherwise just pull in forward declarations
696 # include <pstl/glue_numeric_defs.h>
697 # define __PSTL_NUMERIC_FORWARD_DECLARED 1
700 // Feature test macro for parallel algorithms
701 # define __cpp_lib_parallel_algorithm 201603L
704 #endif /* _GLIBCXX_NUMERIC */