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
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
|
// Copyright (C) 2003 Davis E. King (davis@dlib.net)
// License: Boost Software License See LICENSE.txt for the full license.
#ifndef DLIB_QUEUE_KERNEl_1_
#define DLIB_QUEUE_KERNEl_1_
#include "queue_kernel_abstract.h"
#include "../algs.h"
#include "../interfaces/enumerable.h"
#include "../interfaces/remover.h"
#include "../serialize.h"
namespace dlib
{
template <
typename T,
typename mem_manager = default_memory_manager
>
class queue_kernel_1 : public enumerable<T>,
public remover<T>
{
/*!
INITIAL VALUE
queue_size == 0
current_element == 0
at_start_ == true
CONVENTION
queue_size == the number of elements in the queue
at_start() == at_start_
current_element_valid() == (current_element != 0)
element() == current_element->item
if (queue_size > 0)
{
in points to the last element to be inserted into the queue
out points to the next element to be dequeued
each node points to the node inserted after it except for the most
recently inserted node
current_element == 0
}
!*/
struct node
{
node* last;
T item;
};
public:
typedef T type;
typedef mem_manager mem_manager_type;
queue_kernel_1 (
) :
in(0),
out(0),
queue_size(0),
current_element(0),
at_start_(true)
{
}
virtual ~queue_kernel_1 (
);
inline void clear(
);
void enqueue (
T& item
);
void dequeue (
T& item
);
void cat (
queue_kernel_1& item
);
T& current (
);
const T& current (
) const;
void swap (
queue_kernel_1& item
);
// functions from the remover interface
inline void remove_any (
T& item
);
// functions from the enumerable interface
inline size_t size (
) const;
inline bool at_start (
) const;
inline void reset (
) const;
bool current_element_valid (
) const;
inline const T& element (
) const;
inline T& element (
);
bool move_next (
) const;
private:
void delete_nodes (
node* start,
unsigned long length
);
/*!
requires
- start points to a node in a singly linked list
- start->last points to the next node in the list
- there are at least length nodes in the list beginning with start
ensures
- length nodes have been deleted starting with the node pointed
to by start
!*/
// data members
node* in;
node* out;
unsigned long queue_size;
mutable node* current_element;
mutable bool at_start_;
// restricted functions
queue_kernel_1(queue_kernel_1&); // copy constructor
queue_kernel_1& operator=(queue_kernel_1&); // assignment operator
};
template <
typename T,
typename mem_manager
>
inline void swap (
queue_kernel_1<T,mem_manager>& a,
queue_kernel_1<T,mem_manager>& b
) { a.swap(b); }
template <
typename T,
typename mem_manager
>
void deserialize (
queue_kernel_1<T,mem_manager>& item,
std::istream& in
)
{
try
{
item.clear();
unsigned long size;
deserialize(size,in);
T temp;
for (unsigned long i = 0; i < size; ++i)
{
deserialize(temp,in);
item.enqueue(temp);
}
}
catch (serialization_error& e)
{
item.clear();
throw serialization_error(e.info + "\n while deserializing object of type queue_kernel_1");
}
}
// ----------------------------------------------------------------------------------------
// ----------------------------------------------------------------------------------------
// member function definitions
// ----------------------------------------------------------------------------------------
// ----------------------------------------------------------------------------------------
template <
typename T,
typename mem_manager
>
queue_kernel_1<T,mem_manager>::
~queue_kernel_1 (
)
{
delete_nodes(out,queue_size);
}
// ----------------------------------------------------------------------------------------
template <
typename T,
typename mem_manager
>
void queue_kernel_1<T,mem_manager>::
clear (
)
{
delete_nodes(out,queue_size);
queue_size = 0;
// put the enumerator at the start
reset();
}
// ----------------------------------------------------------------------------------------
template <
typename T,
typename mem_manager
>
void queue_kernel_1<T,mem_manager>::
enqueue (
T& item
)
{
// make new node
node* temp = new node;
// swap item into new node
exchange(item,temp->item);
if (queue_size == 0)
out = temp;
else
in->last = temp;
// make in point to the new node
in = temp;
++queue_size;
// put the enumerator at the start
reset();
}
// ----------------------------------------------------------------------------------------
template <
typename T,
typename mem_manager
>
void queue_kernel_1<T,mem_manager>::
dequeue (
T& item
)
{
// swap out into item
exchange(item,out->item);
--queue_size;
if (queue_size == 0)
{
delete out;
}
else
{
node* temp = out;
// move out pointer to the next element in the queue
out = out->last;
// delete old node
delete temp;
}
// put the enumerator at the start
reset();
}
// ----------------------------------------------------------------------------------------
template <
typename T,
typename mem_manager
>
void queue_kernel_1<T,mem_manager>::
cat (
queue_kernel_1<T,mem_manager>& item
)
{
if (item.queue_size > 0)
{
if (queue_size > 0)
{
in->last = item.out;
}
else
{
out = item.out;
}
in = item.in;
queue_size += item.queue_size;
item.queue_size = 0;
}
// put the enumerator at the start
reset();
}
// ----------------------------------------------------------------------------------------
template <
typename T,
typename mem_manager
>
T& queue_kernel_1<T,mem_manager>::
current (
)
{
return out->item;
}
// ----------------------------------------------------------------------------------------
template <
typename T,
typename mem_manager
>
const T& queue_kernel_1<T,mem_manager>::
current (
) const
{
return out->item;
}
// ----------------------------------------------------------------------------------------
template <
typename T,
typename mem_manager
>
void queue_kernel_1<T,mem_manager>::
swap (
queue_kernel_1<T,mem_manager>& item
)
{
node* in_temp = in;
node* out_temp = out;
unsigned long queue_size_temp = queue_size;
node* current_element_temp = current_element;
bool at_start_temp = at_start_;
in = item.in;
out = item.out;
queue_size = item.queue_size;
current_element = item.current_element;
at_start_ = item.at_start_;
item.in = in_temp;
item.out = out_temp;
item.queue_size = queue_size_temp;
item.current_element = current_element_temp;
item.at_start_ = at_start_temp;
}
// ----------------------------------------------------------------------------------------
// ----------------------------------------------------------------------------------------
// enumerable function definitions
// ----------------------------------------------------------------------------------------
// ----------------------------------------------------------------------------------------
template <
typename T,
typename mem_manager
>
bool queue_kernel_1<T,mem_manager>::
at_start (
) const
{
return at_start_;
}
// ----------------------------------------------------------------------------------------
template <
typename T,
typename mem_manager
>
size_t queue_kernel_1<T,mem_manager>::
size (
) const
{
return queue_size;
}
// ----------------------------------------------------------------------------------------
template <
typename T,
typename mem_manager
>
void queue_kernel_1<T,mem_manager>::
reset (
) const
{
at_start_ = true;
current_element = 0;
}
// ----------------------------------------------------------------------------------------
template <
typename T,
typename mem_manager
>
bool queue_kernel_1<T,mem_manager>::
current_element_valid (
) const
{
return (current_element != 0);
}
// ----------------------------------------------------------------------------------------
template <
typename T,
typename mem_manager
>
const T& queue_kernel_1<T,mem_manager>::
element (
) const
{
return current_element->item;
}
// ----------------------------------------------------------------------------------------
template <
typename T,
typename mem_manager
>
T& queue_kernel_1<T,mem_manager>::
element (
)
{
return current_element->item;
}
// ----------------------------------------------------------------------------------------
template <
typename T,
typename mem_manager
>
bool queue_kernel_1<T,mem_manager>::
move_next (
) const
{
if (at_start_)
{
at_start_ = false;
// if the queue is empty then there is nothing to do
if (queue_size == 0)
{
return false;
}
else
{
current_element = out;
return true;
}
}
else
{
// if we are at the last element then the enumeration has finished
if (current_element == in || current_element == 0)
{
current_element = 0;
return false;
}
else
{
current_element = current_element->last;
return true;
}
}
}
// ----------------------------------------------------------------------------------------
// ----------------------------------------------------------------------------------------
// remover function definitions
// ----------------------------------------------------------------------------------------
// ----------------------------------------------------------------------------------------
template <
typename T,
typename mem_manager
>
void queue_kernel_1<T,mem_manager>::
remove_any (
T& item
)
{
dequeue(item);
}
// ----------------------------------------------------------------------------------------
// ----------------------------------------------------------------------------------------
// private member function definitions
// ----------------------------------------------------------------------------------------
// ----------------------------------------------------------------------------------------
template <
typename T,
typename mem_manager
>
void queue_kernel_1<T,mem_manager>::
delete_nodes (
node* start,
unsigned long length
)
{
node* temp;
while (length)
{
temp = start->last;
delete start;
start = temp;
--length;
}
}
// ----------------------------------------------------------------------------------------
}
#endif // DLIB_QUEUE_KERNEl_1_
|
