summaryrefslogtreecommitdiffstats
path: root/src/include/iterator
blob: 4a61f261e984ef111e871557f263dc8df3c8cab5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
/*  IBM_PROLOG_BEGIN_TAG
 *  This is an automatically generated prolog.
 *
 *  $Source: src/include/iterator $
 *
 *  IBM CONFIDENTIAL
 *
 *  COPYRIGHT International Business Machines Corp. 2012
 *
 *  p1
 *
 *  Object Code Only (OCO) source materials
 *  Licensed Internal Code Source Materials
 *  IBM HostBoot Licensed Internal Code
 *
 *  The source code for this program is not published or other-
 *  wise divested of its trade secrets, irrespective of what has
 *  been deposited with the U.S. Copyright Office.
 *
 *  Origin: 30
 *
 *  IBM_PROLOG_END_TAG
 */
#ifndef __STL_ITERATOR
#define __STL_ITERATOR

#include <stdint.h>

#ifdef __cplusplus

#include <util/impl/iterator.h>

namespace std
{

/** @struct iterator_traits
 *  Template class defining a mapping typenames to ones defined in an iterator.
 */
template <typename Iterator>
struct iterator_traits
{
    typedef typename Iterator::value_type value_type;
    typedef typename Iterator::difference_type difference_type;
    typedef typename Iterator::pointer pointer;
    typedef typename Iterator::reference reference;
};

/** @struct iterator_traits
 *  Template specialization of iterator traits for treating pointer types
 *  as an iterator.
 */
template <typename T>
struct iterator_traits<T*>
{
    typedef T value_type;
    typedef ptrdiff_t difference_type;
    typedef T* pointer;
    typedef T& reference;
};

/** Advance an iterator.
 *
 * @param[in] i - The iterator to advance.
 * @param[in] n - The distance to advance the iterator.
 *
 * This function is equivalent to calling (++i) n times.  
 *
 * If the iterator supports random access then this function will be 
 * implemented in linear time with respect to n.
 * 
 */
template <typename InputIterator, typename Distance>
void advance(InputIterator& i, Distance n)
{
    Util::__Util_Iterator_Impl::advance<InputIterator, Distance>(i, n);
}

/** Determine the distance between two iterators.
 *
 *  @param[in] first - The first iterator.
 *  @param[in] last - The last iterator.
 *
 *  @return The distance between the two iterators.
 *
 *  The distance between two iterators is the number of times first would
 *  need to be incremented so that it is equal to last.
 *
 *  If the iterator supports random access then this function will be
 *  implemented in linear time with respect to the distance between the
 *  two iterators.  A negative distance can only be obtained with random
 *  access iterators.
 */
template <typename InputIterator>
typename iterator_traits<InputIterator>::difference_type 
    distance(InputIterator first, InputIterator last)
{
    return Util::__Util_Iterator_Impl::distance<
                InputIterator, 
                typename iterator_traits<InputIterator>::difference_type>
        (first, last);
}

/** A OutputIterator which operates by push_back onto a container.
 *
 *  See public std::back_insert_iterator documentation.
 */
template <typename BackInsertionSequence>
class back_insert_iterator
{
    public:
            // Common iterator typedefs.
        typedef typename BackInsertionSequence::value_type value_type;
        typedef typename BackInsertionSequence::difference_type difference_type;
        typedef typename BackInsertionSequence::pointer pointer;
        typedef typename BackInsertionSequence::reference reference;

            /** Default constructor from a container reference. */
        back_insert_iterator(BackInsertionSequence& s) : sequence(s) {};
            /** Copy constructor.  Reuses container reference. */
        back_insert_iterator(const back_insert_iterator& i)
            : sequence(i.sequence) {};

            /** Assignment (copy) operator. */
        back_insert_iterator& operator=(const back_insert_iterator& i)
        {
            sequence = i.sequence;
            return *this;
        }

        /** Dereference operator.
         *
         *  This is used to make the standard pattern '*i = x' work on
         *  an iterator.  Since we need to 'push_back' into the 
         *  container we don't actually return anything except ourself,
         *  which allows the operator= to be called.
         */
        back_insert_iterator& operator*() { return *this; }

        /** Assignment operator.
         *
         *  This is the second part of the standard pattern '*i = x'.
         *
         *  Adds the value to the container by calling push_back.
         *
         *  @param[in] v - The value to insert to the container.
         */
        back_insert_iterator& operator=(const value_type& v)
        {
            sequence.push_back(v);
            return *this;
        }

            /** Preincrement operator - no-op */
        back_insert_iterator& operator++() { return *this; };
            /** Postincrement operator - no-op */
        back_insert_iterator& operator++(int unused) { return *this; };

    private:
            /** The container to insert into. */
        BackInsertionSequence& sequence;
};

/** Create a back_insert_iterator from a container.
 *
 *  Utility function to allow back_insert_iterators to be created without
 *  needing to specify the underlying container type.
 *
 *  Example:  Reverse copy elements from one vector into a new vector.
 *      copy(v.rbegin(), v.rend(), back_inserter(v2));
 *
 *  @param[in] s - Sequence to create an iterator for.
 *  
 *  @return The back_insert_iterator.
 */
template <typename BackInsertionSequence>
back_insert_iterator<BackInsertionSequence> 
    back_inserter(BackInsertionSequence& s)
{
    return back_insert_iterator<BackInsertionSequence>(s);
}

}; // namespace std.
#endif

#endif
/* vim: set filetype=cpp : */
OpenPOWER on IntegriCloud