// Functions used by iterators -*- C++ -*-
-// Copyright (C) 2001 Free Software Foundation, Inc.
+// Copyright (C) 2001-2015 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 2, or (at your option)
+// 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,
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
-// You should have received a copy of the GNU General Public License along
-// with this library; see the file COPYING. If not, write to the Free
-// Software Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307,
-// USA.
+// 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.
-// As a special exception, you may use this file as part of a free software
-// library without restriction. Specifically, if other files instantiate
-// templates or use macros or inline functions from this file, or you compile
-// this file and link it with other files to produce an executable, this
-// file does not by itself cause the resulting executable to be covered by
-// the GNU General Public License. This exception does not however
-// invalidate any other reasons why the executable file might be covered by
-// the GNU General Public License.
+// 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/>.
/*
*
* 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_iterator_base_funcs.h
+ * This is an internal header file, included by other library headers.
+ * Do not attempt to use it directly. @headername{iterator}
+ *
+ * This file contains all of the general iterator-related utility
+ * functions, such as distance() and advance().
*/
-#ifndef __SGI_STL_INTERNAL_ITERATOR_BASE_FUNCS_H
-#define __SGI_STL_INTERNAL_ITERATOR_BASE_FUNCS_H
-
-// This file contains all of the general iterator-related utility
-// functions, such as distance() and advance().
-// The internal file stl_iterator.h contains predefined iterators,
-// such as front_insert_iterator and istream_iterator.
+#ifndef _STL_ITERATOR_BASE_FUNCS_H
+#define _STL_ITERATOR_BASE_FUNCS_H 1
#pragma GCC system_header
+
#include <bits/concept_check.h>
+#include <debug/debug.h>
-namespace std
+namespace std _GLIBCXX_VISIBILITY(default)
{
-
- // There are two signatures for distance. In addition to the one taking
- // two iterators and returning a result, there is another taking two
- // iterators and a reference-to-result variable, and returning nothing.
- // The latter seems to be an SGI extension. -- pedwards
- template<typename _InputIterator, typename _Distance>
- inline void
- __distance(_InputIterator __first, _InputIterator __last,
- _Distance& __n, input_iterator_tag)
- {
- // concept requirements
- __glibcpp_function_requires(_InputIteratorConcept<_InputIterator>)
- while (__first != __last) { ++__first; ++__n; }
- }
-
- template<typename _RandomAccessIterator, typename _Distance>
- inline void
- __distance(_RandomAccessIterator __first, _RandomAccessIterator __last,
- _Distance& __n, random_access_iterator_tag)
- {
- // concept requirements
- __glibcpp_function_requires(_RandomAccessIteratorConcept<_RandomAccessIterator>)
- __n += __last - __first;
- }
-
- template<typename _InputIterator, typename _Distance>
- inline void
- distance(_InputIterator __first, _InputIterator __last,
- _Distance& __n)
- {
- // concept requirements -- taken care of in __distance
- __distance(__first, __last, __n, __iterator_category(__first));
- }
+_GLIBCXX_BEGIN_NAMESPACE_VERSION
template<typename _InputIterator>
inline typename iterator_traits<_InputIterator>::difference_type
- __distance(_InputIterator __first, _InputIterator __last, input_iterator_tag)
+ __distance(_InputIterator __first, _InputIterator __last,
+ input_iterator_tag)
{
// concept requirements
- __glibcpp_function_requires(_InputIteratorConcept<_InputIterator>)
+ __glibcxx_function_requires(_InputIteratorConcept<_InputIterator>)
+
typename iterator_traits<_InputIterator>::difference_type __n = 0;
- while (__first != __last) {
- ++__first; ++__n;
- }
+ while (__first != __last)
+ {
+ ++__first;
+ ++__n;
+ }
return __n;
}
template<typename _RandomAccessIterator>
inline typename iterator_traits<_RandomAccessIterator>::difference_type
__distance(_RandomAccessIterator __first, _RandomAccessIterator __last,
- random_access_iterator_tag)
+ random_access_iterator_tag)
{
// concept requirements
- __glibcpp_function_requires(_RandomAccessIteratorConcept<_RandomAccessIterator>)
+ __glibcxx_function_requires(_RandomAccessIteratorConcept<
+ _RandomAccessIterator>)
return __last - __first;
}
+ /**
+ * @brief A generalization of pointer arithmetic.
+ * @param __first An input iterator.
+ * @param __last An input iterator.
+ * @return The distance between them.
+ *
+ * Returns @c n such that __first + n == __last. This requires
+ * that @p __last must be reachable from @p __first. Note that @c
+ * n may be negative.
+ *
+ * For random access iterators, this uses their @c + and @c - operations
+ * and are constant time. For other %iterator classes they are linear time.
+ */
template<typename _InputIterator>
inline typename iterator_traits<_InputIterator>::difference_type
distance(_InputIterator __first, _InputIterator __last)
{
// concept requirements -- taken care of in __distance
- return __distance(__first, __last, __iterator_category(__first));
+ return std::__distance(__first, __last,
+ std::__iterator_category(__first));
}
- template<typename _InputIter, typename _Distance>
+ template<typename _InputIterator, typename _Distance>
inline void
- __advance(_InputIter& __i, _Distance __n, input_iterator_tag)
+ __advance(_InputIterator& __i, _Distance __n, input_iterator_tag)
{
// concept requirements
- __glibcpp_function_requires(_InputIteratorConcept<_InputIter>)
- while (__n--) ++__i;
+ __glibcxx_function_requires(_InputIteratorConcept<_InputIterator>)
+ _GLIBCXX_DEBUG_ASSERT(__n >= 0);
+ while (__n--)
+ ++__i;
}
template<typename _BidirectionalIterator, typename _Distance>
inline void
- __advance(_BidirectionalIterator& __i, _Distance __n, bidirectional_iterator_tag)
+ __advance(_BidirectionalIterator& __i, _Distance __n,
+ bidirectional_iterator_tag)
{
// concept requirements
- __glibcpp_function_requires(_BidirectionalIteratorConcept<_BidirectionalIterator>)
+ __glibcxx_function_requires(_BidirectionalIteratorConcept<
+ _BidirectionalIterator>)
if (__n > 0)
- while (__n--) ++__i;
+ while (__n--)
+ ++__i;
else
- while (__n++) --__i;
+ while (__n++)
+ --__i;
}
template<typename _RandomAccessIterator, typename _Distance>
inline void
- __advance(_RandomAccessIterator& __i, _Distance __n, random_access_iterator_tag)
+ __advance(_RandomAccessIterator& __i, _Distance __n,
+ random_access_iterator_tag)
{
// concept requirements
- __glibcpp_function_requires(_RandomAccessIteratorConcept<_RandomAccessIterator>)
+ __glibcxx_function_requires(_RandomAccessIteratorConcept<
+ _RandomAccessIterator>)
__i += __n;
}
+ /**
+ * @brief A generalization of pointer arithmetic.
+ * @param __i An input iterator.
+ * @param __n The @a delta by which to change @p __i.
+ * @return Nothing.
+ *
+ * This increments @p i by @p n. For bidirectional and random access
+ * iterators, @p __n may be negative, in which case @p __i is decremented.
+ *
+ * For random access iterators, this uses their @c + and @c - operations
+ * and are constant time. For other %iterator classes they are linear time.
+ */
template<typename _InputIterator, typename _Distance>
inline void
advance(_InputIterator& __i, _Distance __n)
{
// concept requirements -- taken care of in __advance
- __advance(__i, __n, __iterator_category(__i));
+ typename iterator_traits<_InputIterator>::difference_type __d = __n;
+ std::__advance(__i, __d, std::__iterator_category(__i));
}
-} // namespace std
+#if __cplusplus >= 201103L
+
+ template<typename _ForwardIterator>
+ inline _ForwardIterator
+ next(_ForwardIterator __x, typename
+ iterator_traits<_ForwardIterator>::difference_type __n = 1)
+ {
+ std::advance(__x, __n);
+ return __x;
+ }
+
+ template<typename _BidirectionalIterator>
+ inline _BidirectionalIterator
+ prev(_BidirectionalIterator __x, typename
+ iterator_traits<_BidirectionalIterator>::difference_type __n = 1)
+ {
+ std::advance(__x, -__n);
+ return __x;
+ }
-#endif /* __SGI_STL_INTERNAL_ITERATOR_BASE_FUNCS_H */
+#endif // C++11
+_GLIBCXX_END_NAMESPACE_VERSION
+} // namespace
-// Local Variables:
-// mode:C++
-// End:
+#endif /* _STL_ITERATOR_BASE_FUNCS_H */