libstdc++-v3/include/bits/stl_iterator_base_funcs.h

   1 // Functions used by iterators -*- C++ -*-
   2
   3 // Copyright (C) 2001 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 2, 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 // You should have received a copy of the GNU General Public License along
  17 // with this library; see the file COPYING.  If not, write to the Free
  18 // Software Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307,
  19 // USA.
  20
  21 // As a special exception, you may use this file as part of a free software
  22 // library without restriction.  Specifically, if other files instantiate
  23 // templates or use macros or inline functions from this file, or you compile
  24 // this file and link it with other files to produce an executable, this
  25 // file does not by itself cause the resulting executable to be covered by
  26 // the GNU General Public License.  This exception does not however
  27 // invalidate any other reasons why the executable file might be covered by
  28 // the GNU General Public License.
  29
  30 /*
  31  *
  32  * Copyright (c) 1994
  33  * Hewlett-Packard Company
  34  *
  35  * Permission to use, copy, modify, distribute and sell this software
  36  * and its documentation for any purpose is hereby granted without fee,
  37  * provided that the above copyright notice appear in all copies and
  38  * that both that copyright notice and this permission notice appear
  39  * in supporting documentation.  Hewlett-Packard Company makes no
  40  * representations about the suitability of this software for any
  41  * purpose.  It is provided "as is" without express or implied warranty.
  42  *
  43  *
  44  * Copyright (c) 1996-1998
  45  * Silicon Graphics Computer Systems, Inc.
  46  *
  47  * Permission to use, copy, modify, distribute and sell this software
  48  * and its documentation for any purpose is hereby granted without fee,
  49  * provided that the above copyright notice appear in all copies and
  50  * that both that copyright notice and this permission notice appear
  51  * in supporting documentation.  Silicon Graphics makes no
  52  * representations about the suitability of this software for any
  53  * purpose.  It is provided "as is" without express or implied warranty.
  54  */
  55
  56 /* NOTE: This is an internal header file, included by other STL headers.
  57  *   You should not attempt to use it directly.
  58  */
  59
  60 #ifndef __SGI_STL_INTERNAL_ITERATOR_BASE_FUNCS_H
  61 #define __SGI_STL_INTERNAL_ITERATOR_BASE_FUNCS_H
  62
  63 // This file contains all of the general iterator-related utility
  64 // functions, such as distance() and advance().
  65 // The internal file stl_iterator.h contains predefined iterators,
  66 // such as front_insert_iterator and istream_iterator.
  67
  68 #pragma GCC system_header
  69 #include <bits/concept_check.h>
  70
  71 namespace std
  72 {
  73
  74   // There are two signatures for distance.  In addition to the one taking
  75   // two iterators and returning a result, there is another taking two
  76   // iterators and a reference-to-result variable, and returning nothing.
  77   // The latter seems to be an SGI extension.   -- pedwards
  78   template<typename _InputIterator, typename _Distance>
  79     inline void
  80     __distance(_InputIterator __first, _InputIterator __last,
  81                _Distance& __n, input_iterator_tag)
  82     {
  83       // concept requirements
  84       __glibcpp_function_requires(_InputIteratorConcept<_InputIterator>);
  85       while (__first != __last) { ++__first; ++__n; }
  86     }
  87
  88   template<typename _RandomAccessIterator, typename _Distance>
  89     inline void
  90     __distance(_RandomAccessIterator __first, _RandomAccessIterator __last,
  91                _Distance& __n, random_access_iterator_tag)
  92     {
  93       // concept requirements
  94       __glibcpp_function_requires(_RandomAccessIteratorConcept<_RandomAccessIterator>);
  95       __n += __last - __first;
  96     }
  97
  98   template<typename _InputIterator, typename _Distance>
  99     inline void
 100     distance(_InputIterator __first, _InputIterator __last,
 101              _Distance& __n)
 102     {
 103       // concept requirements -- taken care of in __distance
 104       __distance(__first, __last, __n, __iterator_category(__first));
 105     }
 106
 107   template<typename _InputIterator>
 108     inline typename iterator_traits<_InputIterator>::difference_type
 109     __distance(_InputIterator __first, _InputIterator __last, input_iterator_tag)
 110     {
 111       // concept requirements
 112       __glibcpp_function_requires(_InputIteratorConcept<_InputIterator>);
 113       typename iterator_traits<_InputIterator>::difference_type __n = 0;
 114       while (__first != __last) {
 115         ++__first; ++__n;
 116       }
 117       return __n;
 118     }
 119
 120   template<typename _RandomAccessIterator>
 121     inline typename iterator_traits<_RandomAccessIterator>::difference_type
 122     __distance(_RandomAccessIterator __first, _RandomAccessIterator __last,
 123                            random_access_iterator_tag)
 124     {
 125       // concept requirements
 126       __glibcpp_function_requires(_RandomAccessIteratorConcept<_RandomAccessIterator>);
 127       return __last - __first;
 128     }
 129
 130   template<typename _InputIterator>
 131     inline typename iterator_traits<_InputIterator>::difference_type
 132     distance(_InputIterator __first, _InputIterator __last)
 133     {
 134       // concept requirements -- taken care of in __distance
 135       return __distance(__first, __last, __iterator_category(__first));
 136     }
 137
 138   template<typename _InputIter, typename _Distance>
 139     inline void
 140     __advance(_InputIter& __i, _Distance __n, input_iterator_tag)
 141     {
 142       // concept requirements
 143       __glibcpp_function_requires(_InputIteratorConcept<_InputIter>);
 144       while (__n--) ++__i;
 145     }
 146
 147   template<typename _BidirectionalIterator, typename _Distance>
 148     inline void
 149     __advance(_BidirectionalIterator& __i, _Distance __n, bidirectional_iterator_tag)
 150     {
 151       // concept requirements
 152       __glibcpp_function_requires(_BidirectionalIteratorConcept<_BidirectionalIterator>);
 153       if (__n > 0)
 154         while (__n--) ++__i;
 155       else
 156         while (__n++) --__i;
 157     }
 158
 159   template<typename _RandomAccessIterator, typename _Distance>
 160     inline void
 161     __advance(_RandomAccessIterator& __i, _Distance __n, random_access_iterator_tag)
 162     {
 163       // concept requirements
 164       __glibcpp_function_requires(_RandomAccessIteratorConcept<_RandomAccessIterator>);
 165       __i += __n;
 166     }
 167
 168   template<typename _InputIterator, typename _Distance>
 169     inline void
 170     advance(_InputIterator& __i, _Distance __n)
 171     {
 172       // concept requirements -- taken care of in __advance
 173       __advance(__i, __n, __iterator_category(__i));
 174     }
 175
 176 } // namespace std
 177
 178 #endif /* __SGI_STL_INTERNAL_ITERATOR_BASE_FUNCS_H */
 179
 180
 181 // Local Variables:
 182 // mode:C++
 183 // End: