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
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
|
// Copyright (C) 2012 Davis E. King (davis@dlib.net)
// License: Boost Software License See LICENSE.txt for the full license.
#undef DLIB_CIRCULAR_BuFFER_ABSTRACT_Hh_
#ifdef DLIB_CIRCULAR_BuFFER_ABSTRACT_Hh_
#include "../algs.h"
#include "../serialize.h"
namespace dlib
{
// ----------------------------------------------------------------------------------------
template <
typename T
>
class circular_buffer
{
/*!
REQUIREMENTS ON T
T must have a default constructor and be copyable.
POINTERS AND REFERENCES TO INTERNAL DATA
swap(), size(), front(), back(), and operator[] functions do
not invalidate pointers or references to internal data.
All other functions have no such guarantee.
INITIAL VALUE
- size() == 0
WHAT THIS OBJECT REPRESENTS
This object is a circular buffer of objects of type T. This means
that when objects are pushed onto one of its ends it does not grow
in size. Instead, it shifts all elements over one to make room for
the new element and the element at the opposing end falls off the
buffer and is lost.
!*/
public:
typedef default_memory_manager mem_manager_type;
typedef T value_type;
typedef T type;
circular_buffer(
);
/*!
ensures
- #size() == 0
- this object is properly initialized
!*/
explicit circular_buffer(
unsigned long s
);
/*!
ensures
- #size() == s
- this object is properly initialized
!*/
void clear (
);
/*!
ensures
- this object has its initial value
- #size() == 0
!*/
T& operator[] (
unsigned long i
) const;
/*!
requires
- i < size()
ensures
- returns a non-const reference to the i-th element of this circular buffer
!*/
const T& operator[] (
unsigned long i
) const;
/*!
requires
- i < size()
ensures
- returns a const reference to the i-th element of this circular buffer
!*/
void resize(
unsigned long new_size
);
/*!
ensures
- #size() == new_size
!*/
void assign(
unsigned long new_size,
const T& value
);
/*!
ensures
- #size() == new_size
- for all valid i:
- (*this)[i] == value
!*/
unsigned long size(
) const;
/*!
ensures
- returns the number of elements in this circular buffer
!*/
T& front(
);
/*!
requires
- size() > 0
ensures
- returns a reference to (*this)[0]
!*/
const T& front(
) const;
/*!
requires
- size() > 0
ensures
- returns a const reference to (*this)[0]
!*/
T& back(
);
/*!
requires
- size() > 0
ensures
- returns a reference to (*this)[size()-1]
!*/
const T& back(
) const;
/*!
requires
- size() > 0
ensures
- returns a const reference to (*this)[size()-1]
!*/
void push_front(
const T& value
);
/*!
ensures
- #size() == size()
(i.e. the size of this object does not change)
- if (size() != 0) then
- #front() == value
- all items are shifted over such that,
- #(*this)[1] == (*this)[0]
- #(*this)[2] == (*this)[1]
- #(*this)[3] == (*this)[2]
- etc.
- back() is shifted out of the circular buffer
- else
- This function has no effect on this object
!*/
void push_back(
const T& value
);
/*!
ensures
- #size() == size()
(i.e. the size of this object does not change)
- if (size() != 0) then
- #back() == value
- all items are shifted over such that,
- front() is shifted out of the circular buffer
- #(*this)[0] == (*this)[1]
- #(*this)[1] == (*this)[2]
- #(*this)[2] == (*this)[3]
- etc.
- else
- This function has no effect on this object
!*/
void swap (
circular_buffer& item
);
/*!
ensures
- swaps *this with item
!*/
};
// ----------------------------------------------------------------------------------------
template <
typename T
>
void swap (
circular_buffer<T>& a,
circular_buffer<T>& b
) { a.swap(b); }
/*!
provides a global swap function
!*/
template <
typename T
>
void serialize (
const circular_buffer<T>& item,
std::ostream& out
);
/*!
provides serialization support
!*/
template <
typename T
>
void deserialize (
circular_buffer<T>& item,
std::istream& in
);
/*!
provides deserialization support
!*/
// ----------------------------------------------------------------------------------------
template <
typename T
>
const matrix_exp mat (
const circular_buffer<T>& m
);
/*!
ensures
- returns a matrix R such that:
- is_col_vector(R) == true
- R.size() == m.size()
- for all valid r:
R(r) == m[r]
!*/
// ----------------------------------------------------------------------------------------
}
#endif // DLIB_CIRCULAR_BuFFER_ABSTRACT_Hh_
|
