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
187
188
189
190
191
192
193
194
195
196
197
198
199
|
// Copyright (C) 2003 Davis E. King (davis@dlib.net)
// License: Boost Software License See LICENSE.txt for the full license.
#undef DLIB_SEQUENCE_KERNEl_ABSTRACT_
#ifdef DLIB_SEQUENCE_KERNEl_ABSTRACT_
#include "../interfaces/enumerable.h"
#include "../interfaces/remover.h"
#include "../serialize.h"
#include "../algs.h"
namespace dlib
{
template <
typename T,
typename mem_manager = default_memory_manager
>
class sequence : public enumerable<T>,
public remover<T>
{
/*!
REQUIREMENTS ON T
T must be swappable by a global swap() and
T must have a default constructor
REQUIREMENTS ON mem_manager
must be an implementation of memory_manager/memory_manager_kernel_abstract.h or
must be an implementation of memory_manager_global/memory_manager_global_kernel_abstract.h or
must be an implementation of memory_manager_stateless/memory_manager_stateless_kernel_abstract.h
mem_manager::type can be set to anything.
POINTERS AND REFERENCES TO INTERNAL DATA
swap() and operator[] functions do not invalidate pointers or
references to internal data.
All other functions have no such guarantees.
ENUMERATION ORDER
The enumerator will iterate over the elements in the sequence from
the 0th element to the (size()-1)th element.
INITIAL VALUE
size() == 0
WHAT THIS OBJECT REPRESENTS
sequence contains items of type T
This object represents an ordered sequence of items, each item is
associated with an integer value.
The items are numbered from 0 to size()-1
Also note that unless specified otherwise, no member functions
of this object throw exceptions.
!*/
public:
typedef T type;
typedef mem_manager mem_manager_type;
sequence (
);
/*!
ensures
- #*this is properly initialized
throws
- std::bad_alloc or any exception thrown by T's constructor
!*/
virtual ~sequence (
);
/*!
ensures
- all memory associated with *this has been released
!*/
void clear (
);
/*!
ensures
- #*this has its initial value
throws
- std::bad_alloc or any exception thrown by T's constructor
if this exception is thrown then *this is unusable
until clear() is called and succeeds
!*/
void add (
unsigned long pos,
T& item
);
/*!
requires
- pos <= size()
ensures
- #size() == size() + 1
- #item has an initial value for its type
- #operator[](pos) == item
i.e. item has been inserted into *this between the elements which
were previously at position pos-1 and pos
- #at_start() == true
throws
- std::bad_alloc or any exception thrown by T's constructor
if add() throws then it has no effect
!*/
void remove (
unsigned long pos,
T& item
);
/*!
requires
- pos < size()
ensures
- #size() == size() - 1
- the element at the position pos in *this has been removed and
swapped into #item
- #at_start() == true
!*/
void cat (
sequence& item
);
/*!
requires
- &item != this (i.e. you can't concatenate a sequence onto itself)
ensures
- item has been concatenated onto the end of *this
i.e. item[0] becomes (#*this)[size()], item[1]
becomes (#*this)[size()+1], etc.
- #size() == size() + item.size()
- #item has its initial value
- #at_start() == true
!*/
const T& operator[] (
unsigned long pos
) const;
/*!
requires
- pos < size()
ensures
- returns a const reference to the element at position pos
!*/
T& operator[] (
unsigned long pos
);
/*!
requires
- pos < size()
ensures
- returns a non-const reference to the element at position pos
!*/
void swap (
sequence& item
);
/*!
ensures
- swaps *this and item
!*/
private:
// restricted functions
sequence(sequence&); // copy constructor
sequence& operator=(sequence&); // assignment operator
};
template <
typename T,
typename mem_manager
>
inline void swap (
sequence<T,mem_manager>& a,
sequence<T,mem_manager>& b
) { a.swap(b); }
/*!
provides a global swap function
!*/
template <
typename T,
typename mem_manager
>
void deserialize (
sequence<T,mem_manager>& item,
std::istream& in
);
/*!
provides deserialization support
!*/
}
#endif // DLIB_SEQUENCE_KERNEl_ABSTRACT_
|
