+// Numeric functions implementation -*- C++ -*-
+
+// Copyright (C) 2001-2020 Free Software Foundation, Inc.
+//
+// This file is part of the GNU ISO C++ Library. This library is free
+// software; you can redistribute it and/or modify it under the
+// terms of the GNU General Public License as published by the
+// Free Software Foundation; either version 3, or (at your option)
+// any later version.
+
+// This library is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+// GNU General Public License for more details.
+
+// Under Section 7 of GPL version 3, you are granted additional
+// permissions described in the GCC Runtime Library Exception, version
+// 3.1, as published by the Free Software Foundation.
+
+// You should have received a copy of the GNU General Public License and
+// a copy of the GCC Runtime Library Exception along with this program;
+// see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
+// <http://www.gnu.org/licenses/>.
+
/*
*
* Copyright (c) 1994
* purpose. It is provided "as is" without express or implied warranty.
*/
-/* NOTE: This is an internal header file, included by other STL headers.
- * You should not attempt to use it directly.
+/** @file bits/stl_numeric.h
+ * This is an internal header file, included by other library headers.
+ * Do not attempt to use it directly. @headername{numeric}
*/
+#ifndef _STL_NUMERIC_H
+#define _STL_NUMERIC_H 1
-#ifndef _CPP_BITS_STL_NUMERIC_H
-#define _CPP_BITS_STL_NUMERIC_H 1
+#include <bits/concept_check.h>
+#include <debug/debug.h>
+#include <bits/move.h> // For _GLIBCXX_MOVE
-namespace std
-{
-template <class _InputIterator, class _Tp>
-_Tp accumulate(_InputIterator __first, _InputIterator __last, _Tp __init)
+namespace std _GLIBCXX_VISIBILITY(default)
{
- // concept requirements
- __glibcpp_function_requires(_InputIteratorConcept<_InputIterator>);
-
- for ( ; __first != __last; ++__first)
- __init = __init + *__first;
- return __init;
-}
-
-template <class _InputIterator, class _Tp, class _BinaryOperation>
-_Tp accumulate(_InputIterator __first, _InputIterator __last, _Tp __init,
- _BinaryOperation __binary_op)
-{
- // concept requirements
- __glibcpp_function_requires(_InputIteratorConcept<_InputIterator>);
-
- for ( ; __first != __last; ++__first)
- __init = __binary_op(__init, *__first);
- return __init;
-}
+_GLIBCXX_BEGIN_NAMESPACE_VERSION
+
+ /** @defgroup numeric_ops Generalized Numeric operations
+ * @ingroup algorithms
+ */
+
+#if __cplusplus >= 201103L
+ /**
+ * @brief Create a range of sequentially increasing values.
+ *
+ * For each element in the range @p [first,last) assigns @p value and
+ * increments @p value as if by @p ++value.
+ *
+ * @param __first Start of range.
+ * @param __last End of range.
+ * @param __value Starting value.
+ * @return Nothing.
+ * @ingroup numeric_ops
+ */
+ template<typename _ForwardIterator, typename _Tp>
+ void
+ iota(_ForwardIterator __first, _ForwardIterator __last, _Tp __value)
+ {
+ // concept requirements
+ __glibcxx_function_requires(_Mutable_ForwardIteratorConcept<
+ _ForwardIterator>)
+ __glibcxx_function_requires(_ConvertibleConcept<_Tp,
+ typename iterator_traits<_ForwardIterator>::value_type>)
+ __glibcxx_requires_valid_range(__first, __last);
+
+ for (; __first != __last; ++__first)
+ {
+ *__first = __value;
+ ++__value;
+ }
+ }
+#endif
+
+_GLIBCXX_END_NAMESPACE_VERSION
+
+_GLIBCXX_BEGIN_NAMESPACE_ALGO
+
+#if __cplusplus > 201703L
+// _GLIBCXX_RESOLVE_LIB_DEFECTS
+// DR 2055. std::move in std::accumulate and other algorithms
+# define _GLIBCXX_MOVE_IF_20(_E) std::move(_E)
+#else
+# define _GLIBCXX_MOVE_IF_20(_E) _E
+#endif
+
+ /// @addtogroup numeric_ops
+ /// @{
+
+ /**
+ * @brief Accumulate values in a range.
+ *
+ * Accumulates the values in the range [first,last) using operator+(). The
+ * initial value is @a init. The values are processed in order.
+ *
+ * @param __first Start of range.
+ * @param __last End of range.
+ * @param __init Starting value to add other values to.
+ * @return The final sum.
+ */
+ template<typename _InputIterator, typename _Tp>
+ inline _Tp
+ accumulate(_InputIterator __first, _InputIterator __last, _Tp __init)
+ {
+ // concept requirements
+ __glibcxx_function_requires(_InputIteratorConcept<_InputIterator>)
+ __glibcxx_requires_valid_range(__first, __last);
+
+ for (; __first != __last; ++__first)
+ __init = _GLIBCXX_MOVE_IF_20(__init) + *__first;
+ return __init;
+ }
-template <class _InputIterator1, class _InputIterator2, class _Tp>
-_Tp inner_product(_InputIterator1 __first1, _InputIterator1 __last1,
- _InputIterator2 __first2, _Tp __init)
-{
- // concept requirements
- __glibcpp_function_requires(_InputIteratorConcept<_InputIterator1>);
- __glibcpp_function_requires(_InputIteratorConcept<_InputIterator2>);
-
- for ( ; __first1 != __last1; ++__first1, ++__first2)
- __init = __init + (*__first1 * *__first2);
- return __init;
-}
-
-template <class _InputIterator1, class _InputIterator2, class _Tp,
- class _BinaryOperation1, class _BinaryOperation2>
-_Tp inner_product(_InputIterator1 __first1, _InputIterator1 __last1,
- _InputIterator2 __first2, _Tp __init,
- _BinaryOperation1 __binary_op1,
- _BinaryOperation2 __binary_op2)
-{
- // concept requirements
- __glibcpp_function_requires(_InputIteratorConcept<_InputIterator1>);
- __glibcpp_function_requires(_InputIteratorConcept<_InputIterator2>);
-
- for ( ; __first1 != __last1; ++__first1, ++__first2)
- __init = __binary_op1(__init, __binary_op2(*__first1, *__first2));
- return __init;
-}
-
-template <class _InputIterator, class _OutputIterator, class _Tp>
-_OutputIterator
-__partial_sum(_InputIterator __first, _InputIterator __last,
- _OutputIterator __result, _Tp*)
-{
- _Tp __value = *__first;
- while (++__first != __last) {
- __value = __value + *__first;
- *++__result = __value;
- }
- return ++__result;
-}
-
-template <class _InputIterator, class _OutputIterator>
-_OutputIterator
-partial_sum(_InputIterator __first, _InputIterator __last,
- _OutputIterator __result)
-{
- // concept requirements
- __glibcpp_function_requires(_InputIteratorConcept<_InputIterator>);
- __glibcpp_function_requires(_OutputIteratorConcept<_OutputIterator,
- typename iterator_traits<_InputIterator>::value_type>);
-
- if (__first == __last) return __result;
- *__result = *__first;
- return __partial_sum(__first, __last, __result, __value_type(__first));
-}
-
-template <class _InputIterator, class _OutputIterator, class _Tp,
- class _BinaryOperation>
-_OutputIterator
-__partial_sum(_InputIterator __first, _InputIterator __last,
- _OutputIterator __result, _Tp*, _BinaryOperation __binary_op)
-{
- _Tp __value = *__first;
- while (++__first != __last) {
- __value = __binary_op(__value, *__first);
- *++__result = __value;
- }
- return ++__result;
-}
-
-template <class _InputIterator, class _OutputIterator, class _BinaryOperation>
-_OutputIterator
-partial_sum(_InputIterator __first, _InputIterator __last,
- _OutputIterator __result, _BinaryOperation __binary_op)
-{
- // concept requirements
- __glibcpp_function_requires(_InputIteratorConcept<_InputIterator>);
- __glibcpp_function_requires(_OutputIteratorConcept<_OutputIterator,
- typename iterator_traits<_InputIterator>::value_type>);
-
- if (__first == __last) return __result;
- *__result = *__first;
- return __partial_sum(__first, __last, __result, __value_type(__first),
- __binary_op);
-}
-
-template <class _InputIterator, class _OutputIterator, class _Tp>
-_OutputIterator
-__adjacent_difference(_InputIterator __first, _InputIterator __last,
- _OutputIterator __result, _Tp*)
-{
- _Tp __value = *__first;
- while (++__first != __last) {
- _Tp __tmp = *__first;
- *++__result = __tmp - __value;
- __value = __tmp;
- }
- return ++__result;
-}
-
-template <class _InputIterator, class _OutputIterator>
-_OutputIterator
-adjacent_difference(_InputIterator __first,
- _InputIterator __last, _OutputIterator __result)
-{
- // concept requirements
- __glibcpp_function_requires(_InputIteratorConcept<_InputIterator>);
- __glibcpp_function_requires(_OutputIteratorConcept<_OutputIterator,
- typename iterator_traits<_InputIterator>::value_type>);
-
- if (__first == __last) return __result;
- *__result = *__first;
- return __adjacent_difference(__first, __last, __result,
- __value_type(__first));
-}
-
-template <class _InputIterator, class _OutputIterator, class _Tp,
- class _BinaryOperation>
-_OutputIterator
-__adjacent_difference(_InputIterator __first, _InputIterator __last,
- _OutputIterator __result, _Tp*,
- _BinaryOperation __binary_op) {
- _Tp __value = *__first;
- while (++__first != __last) {
- _Tp __tmp = *__first;
- *++__result = __binary_op(__tmp, __value);
- __value = __tmp;
- }
- return ++__result;
-}
-
-template <class _InputIterator, class _OutputIterator, class _BinaryOperation>
-_OutputIterator
-adjacent_difference(_InputIterator __first, _InputIterator __last,
- _OutputIterator __result, _BinaryOperation __binary_op)
-{
- // concept requirements
- __glibcpp_function_requires(_InputIteratorConcept<_InputIterator>);
- __glibcpp_function_requires(_OutputIteratorConcept<_OutputIterator,
- typename iterator_traits<_InputIterator>::value_type>);
-
- if (__first == __last) return __result;
- *__result = *__first;
- return __adjacent_difference(__first, __last, __result,
- __value_type(__first),
- __binary_op);
-}
-
-// Returns __x ** __n, where __n >= 0. _Note that "multiplication"
-// is required to be associative, but not necessarily commutative.
-
-
-template <class _Tp, class _Integer, class _MonoidOperation>
-_Tp __power(_Tp __x, _Integer __n, _MonoidOperation __monoid_op)
-{
- if (__n == 0)
- return identity_element(__monoid_op);
- else {
- while ((__n & 1) == 0) {
- __n >>= 1;
- __x = __monoid_op(__x, __x);
+ /**
+ * @brief Accumulate values in a range with operation.
+ *
+ * Accumulates the values in the range `[first,last)` using the function
+ * object `__binary_op`. The initial value is `__init`. The values are
+ * processed in order.
+ *
+ * @param __first Start of range.
+ * @param __last End of range.
+ * @param __init Starting value to add other values to.
+ * @param __binary_op Function object to accumulate with.
+ * @return The final sum.
+ */
+ template<typename _InputIterator, typename _Tp, typename _BinaryOperation>
+ inline _Tp
+ accumulate(_InputIterator __first, _InputIterator __last, _Tp __init,
+ _BinaryOperation __binary_op)
+ {
+ // concept requirements
+ __glibcxx_function_requires(_InputIteratorConcept<_InputIterator>)
+ __glibcxx_requires_valid_range(__first, __last);
+
+ for (; __first != __last; ++__first)
+ __init = __binary_op(_GLIBCXX_MOVE_IF_20(__init), *__first);
+ return __init;
}
- _Tp __result = __x;
- __n >>= 1;
- while (__n != 0) {
- __x = __monoid_op(__x, __x);
- if ((__n & 1) != 0)
- __result = __monoid_op(__result, __x);
- __n >>= 1;
+ /**
+ * @brief Compute inner product of two ranges.
+ *
+ * Starting with an initial value of @p __init, multiplies successive
+ * elements from the two ranges and adds each product into the accumulated
+ * value using operator+(). The values in the ranges are processed in
+ * order.
+ *
+ * @param __first1 Start of range 1.
+ * @param __last1 End of range 1.
+ * @param __first2 Start of range 2.
+ * @param __init Starting value to add other values to.
+ * @return The final inner product.
+ */
+ template<typename _InputIterator1, typename _InputIterator2, typename _Tp>
+ inline _Tp
+ inner_product(_InputIterator1 __first1, _InputIterator1 __last1,
+ _InputIterator2 __first2, _Tp __init)
+ {
+ // concept requirements
+ __glibcxx_function_requires(_InputIteratorConcept<_InputIterator1>)
+ __glibcxx_function_requires(_InputIteratorConcept<_InputIterator2>)
+ __glibcxx_requires_valid_range(__first1, __last1);
+
+ for (; __first1 != __last1; ++__first1, (void)++__first2)
+ __init = _GLIBCXX_MOVE_IF_20(__init) + (*__first1 * *__first2);
+ return __init;
}
- return __result;
- }
-}
-template <class _Tp, class _Integer>
-inline _Tp __power(_Tp __x, _Integer __n)
-{
- return __power(__x, __n, multiplies<_Tp>());
-}
+ /**
+ * @brief Compute inner product of two ranges.
+ *
+ * Starting with an initial value of @p __init, applies @p __binary_op2 to
+ * successive elements from the two ranges and accumulates each result into
+ * the accumulated value using @p __binary_op1. The values in the ranges are
+ * processed in order.
+ *
+ * @param __first1 Start of range 1.
+ * @param __last1 End of range 1.
+ * @param __first2 Start of range 2.
+ * @param __init Starting value to add other values to.
+ * @param __binary_op1 Function object to accumulate with.
+ * @param __binary_op2 Function object to apply to pairs of input values.
+ * @return The final inner product.
+ */
+ template<typename _InputIterator1, typename _InputIterator2, typename _Tp,
+ typename _BinaryOperation1, typename _BinaryOperation2>
+ inline _Tp
+ inner_product(_InputIterator1 __first1, _InputIterator1 __last1,
+ _InputIterator2 __first2, _Tp __init,
+ _BinaryOperation1 __binary_op1,
+ _BinaryOperation2 __binary_op2)
+ {
+ // concept requirements
+ __glibcxx_function_requires(_InputIteratorConcept<_InputIterator1>)
+ __glibcxx_function_requires(_InputIteratorConcept<_InputIterator2>)
+ __glibcxx_requires_valid_range(__first1, __last1);
+
+ for (; __first1 != __last1; ++__first1, (void)++__first2)
+ __init = __binary_op1(_GLIBCXX_MOVE_IF_20(__init),
+ __binary_op2(*__first1, *__first2));
+ return __init;
+ }
-// Alias for the internal name __power. Note that power is an extension,
-// not part of the C++ standard.
+ /**
+ * @brief Return list of partial sums
+ *
+ * Accumulates the values in the range [first,last) using the @c + operator.
+ * As each successive input value is added into the total, that partial sum
+ * is written to @p __result. Therefore, the first value in @p __result is
+ * the first value of the input, the second value in @p __result is the sum
+ * of the first and second input values, and so on.
+ *
+ * @param __first Start of input range.
+ * @param __last End of input range.
+ * @param __result Output sum.
+ * @return Iterator pointing just beyond the values written to __result.
+ */
+ template<typename _InputIterator, typename _OutputIterator>
+ _OutputIterator
+ partial_sum(_InputIterator __first, _InputIterator __last,
+ _OutputIterator __result)
+ {
+ typedef typename iterator_traits<_InputIterator>::value_type _ValueType;
+
+ // concept requirements
+ __glibcxx_function_requires(_InputIteratorConcept<_InputIterator>)
+ __glibcxx_function_requires(_OutputIteratorConcept<_OutputIterator,
+ _ValueType>)
+ __glibcxx_requires_valid_range(__first, __last);
+
+ if (__first == __last)
+ return __result;
+ _ValueType __value = *__first;
+ *__result = __value;
+ while (++__first != __last)
+ {
+ __value = _GLIBCXX_MOVE_IF_20(__value) + *__first;
+ *++__result = __value;
+ }
+ return ++__result;
+ }
-template <class _Tp, class _Integer, class _MonoidOperation>
-inline _Tp power(_Tp __x, _Integer __n, _MonoidOperation __monoid_op)
-{
- return __power(__x, __n, __monoid_op);
-}
+ /**
+ * @brief Return list of partial sums
+ *
+ * Accumulates the values in the range [first,last) using @p __binary_op.
+ * As each successive input value is added into the total, that partial sum
+ * is written to @p __result. Therefore, the first value in @p __result is
+ * the first value of the input, the second value in @p __result is the sum
+ * of the first and second input values, and so on.
+ *
+ * @param __first Start of input range.
+ * @param __last End of input range.
+ * @param __result Output sum.
+ * @param __binary_op Function object.
+ * @return Iterator pointing just beyond the values written to __result.
+ */
+ template<typename _InputIterator, typename _OutputIterator,
+ typename _BinaryOperation>
+ _OutputIterator
+ partial_sum(_InputIterator __first, _InputIterator __last,
+ _OutputIterator __result, _BinaryOperation __binary_op)
+ {
+ typedef typename iterator_traits<_InputIterator>::value_type _ValueType;
+
+ // concept requirements
+ __glibcxx_function_requires(_InputIteratorConcept<_InputIterator>)
+ __glibcxx_function_requires(_OutputIteratorConcept<_OutputIterator,
+ _ValueType>)
+ __glibcxx_requires_valid_range(__first, __last);
+
+ if (__first == __last)
+ return __result;
+ _ValueType __value = *__first;
+ *__result = __value;
+ while (++__first != __last)
+ {
+ __value = __binary_op(_GLIBCXX_MOVE_IF_20(__value), *__first);
+ *++__result = __value;
+ }
+ return ++__result;
+ }
-template <class _Tp, class _Integer>
-inline _Tp power(_Tp __x, _Integer __n)
-{
- return __power(__x, __n);
-}
+ /**
+ * @brief Return differences between adjacent values.
+ *
+ * Computes the difference between adjacent values in the range
+ * [first,last) using operator-() and writes the result to @p __result.
+ *
+ * @param __first Start of input range.
+ * @param __last End of input range.
+ * @param __result Output sums.
+ * @return Iterator pointing just beyond the values written to result.
+ *
+ * _GLIBCXX_RESOLVE_LIB_DEFECTS
+ * DR 539. partial_sum and adjacent_difference should mention requirements
+ */
+ template<typename _InputIterator, typename _OutputIterator>
+ _OutputIterator
+ adjacent_difference(_InputIterator __first,
+ _InputIterator __last, _OutputIterator __result)
+ {
+ typedef typename iterator_traits<_InputIterator>::value_type _ValueType;
+
+ // concept requirements
+ __glibcxx_function_requires(_InputIteratorConcept<_InputIterator>)
+ __glibcxx_function_requires(_OutputIteratorConcept<_OutputIterator,
+ _ValueType>)
+ __glibcxx_requires_valid_range(__first, __last);
+
+ if (__first == __last)
+ return __result;
+ _ValueType __value = *__first;
+ *__result = __value;
+ while (++__first != __last)
+ {
+ _ValueType __tmp = *__first;
+ *++__result = __tmp - _GLIBCXX_MOVE_IF_20(__value);
+ __value = _GLIBCXX_MOVE(__tmp);
+ }
+ return ++__result;
+ }
-// iota is not part of the C++ standard. It is an extension.
+ /**
+ * @brief Return differences between adjacent values.
+ *
+ * Computes the difference between adjacent values in the range
+ * [__first,__last) using the function object @p __binary_op and writes the
+ * result to @p __result.
+ *
+ * @param __first Start of input range.
+ * @param __last End of input range.
+ * @param __result Output sum.
+ * @param __binary_op Function object.
+ * @return Iterator pointing just beyond the values written to result.
+ *
+ * _GLIBCXX_RESOLVE_LIB_DEFECTS
+ * DR 539. partial_sum and adjacent_difference should mention requirements
+ */
+ template<typename _InputIterator, typename _OutputIterator,
+ typename _BinaryOperation>
+ _OutputIterator
+ adjacent_difference(_InputIterator __first, _InputIterator __last,
+ _OutputIterator __result, _BinaryOperation __binary_op)
+ {
+ typedef typename iterator_traits<_InputIterator>::value_type _ValueType;
+
+ // concept requirements
+ __glibcxx_function_requires(_InputIteratorConcept<_InputIterator>)
+ __glibcxx_function_requires(_OutputIteratorConcept<_OutputIterator,
+ _ValueType>)
+ __glibcxx_requires_valid_range(__first, __last);
+
+ if (__first == __last)
+ return __result;
+ _ValueType __value = *__first;
+ *__result = __value;
+ while (++__first != __last)
+ {
+ _ValueType __tmp = *__first;
+ *++__result = __binary_op(__tmp, _GLIBCXX_MOVE_IF_20(__value));
+ __value = _GLIBCXX_MOVE(__tmp);
+ }
+ return ++__result;
+ }
-template <class _ForwardIter, class _Tp>
-void
-iota(_ForwardIter __first, _ForwardIter __last, _Tp __value)
-{
- // concept requirements
- __glibcpp_function_requires(_Mutable_ForwardIteratorConcept<_ForwardIter>);
- __glibcpp_function_requires(_ConvertibleConcept<_Tp,
- typename iterator_traits<_ForwardIter>::value_type>);
+ // @} group numeric_ops
- while (__first != __last)
- *__first++ = __value++;
-}
+#undef _GLIBCXX_MOVE_IF_20
+_GLIBCXX_END_NAMESPACE_ALGO
} // namespace std
-#endif /* _CPP_BITS_STL_NUMERIC_H */
-
-// Local Variables:
-// mode:C++
-// End:
+#endif /* _STL_NUMERIC_H */
projects / thirdparty / gcc.git / blobdiff