summaryrefslogtreecommitdiffstats
path: root/ml/dlib/dlib/test/queue.cpp
blob: efcdf6054fe42176f5a5477371ba291816628b9a (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
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
// Copyright (C) 2003  Davis E. King (davis@dlib.net)
// License: Boost Software License   See LICENSE.txt for the full license.


#include <sstream>
#include <string>
#include <cstdlib>
#include <ctime>
#include <dlib/queue.h>
#include <dlib/memory_manager_global.h>

#include "tester.h"

// This is called an unnamed-namespace and it has the effect of making everything inside this file "private"
// so that everything you declare will have static linkage.  Thus we won't have any multiply
// defined symbol errors coming out of the linker when we try to compile the test suite.
namespace  
{

    using namespace test;
    using namespace dlib;
    using namespace std;

    // Declare the logger we will use in this test.  The name of the tester 
    // should start with "test."
    logger dlog("test.queue");

    template <
        typename queue
        >
    void queue_sort_test (
    )
    /*!
        requires
            - queue is an implementation of queue/queue_sort_abstract.h 
              is instantiated with int
        ensures
            - runs tests on queue for compliance with the specs
    !*/
    {        

        print_spinner();
        srand(static_cast<unsigned int>(time(0)));

        queue q,q2;

        enumerable<int>& e = q;

        // I will use these DLIB_TEST_MSG macros to assert that conditions are true.  If they are
        // false then it means we have detected an error in the queue object.  CASSERT
        // will then throw an exception which we will catch at the end of this function and
        // report as an error/failed test.
        DLIB_TEST(e.at_start() == true);

        int a = 0;

        DLIB_TEST(q.size() == 0);
        DLIB_TEST(q.at_start() == true);
        DLIB_TEST(q.current_element_valid() == false);

        q.sort();

        DLIB_TEST(q.size() == 0);
        DLIB_TEST(q.at_start() == true);
        DLIB_TEST(q.current_element_valid() == false);

        DLIB_TEST (q.move_next() == false);
        DLIB_TEST (q.move_next() == false);
        DLIB_TEST (q.move_next() == false);
        DLIB_TEST (q.move_next() == false);
        DLIB_TEST (q.move_next() == false);
        DLIB_TEST (q.move_next() == false);


        DLIB_TEST(q.size() == 0);
        DLIB_TEST(q.at_start() == false);
        DLIB_TEST(q.current_element_valid() == false);


        q.reset();

        DLIB_TEST(q.size() == 0);
        DLIB_TEST(q.at_start() == true);
        DLIB_TEST(q.current_element_valid() == false);











        q.clear();
        q2.clear();
        DLIB_TEST(q.size() == 0);
        DLIB_TEST(q2.size() == 0);

        for (int i = 0; i < 10000; ++i)
        {
            int a = i;
            q.enqueue(a);
        }

        q2.cat(q);

        DLIB_TEST(q.size() == 0);
        DLIB_TEST(q2.size() == 10000);

        int g = 0;
        while (q2.move_next())
        {
            DLIB_TEST_MSG(q2.element() == g,g);
            ++g;
        }

        for (int i = 0;i < 10000; ++i)
        {
            int a = 0;
            q2.dequeue(a);
            DLIB_TEST(a == i);
        }

        DLIB_TEST(q.size() == 0);
        DLIB_TEST(q2.size() == 0);
        q.clear();
        q2.clear();




        print_spinner();


        dlog << LTRACE << "creating big pre-sorted queue";
        q.clear();
        DLIB_TEST(q.size() == 0);

        for (int i = 0; i < 10000; ++i)
        {
            int a = i;
            q.enqueue(a);
        }

        dlog << LTRACE << "sorting already sorted queue";
        q.sort();


        dlog << LTRACE << "done sorting, checking the results";
        for (int i = 0; i < 10000; ++i)
        {
            q.dequeue(a);
            DLIB_TEST(a == i);
        }


        q.clear();
        dlog << LTRACE << "done with the big pre-sorted queue test";















        q.clear();
        q2.clear();
        DLIB_TEST(q.size() == 0);
        DLIB_TEST(q2.size() == 0);

        for (int i = 0; i < 1; ++i)
        {
            int a = i;
            q.enqueue(a);
        }

        q2.cat(q);

        DLIB_TEST(q.size() == 0);
        DLIB_TEST(q2.size() == 1);



        g = 0;
        while (q2.move_next())
        {
            DLIB_TEST_MSG(q2.element() == g,g);
            ++g;
        }

        for (int i = 0;i < 1; ++i)
        {
            int a = 0;
            q2.dequeue(a);
            DLIB_TEST(a == i);
        }

        DLIB_TEST(q.size() == 0);
        DLIB_TEST(q2.size() == 0);
        q.clear();
        q2.clear();







        print_spinner();











        for (int j = 0; j < 3; ++j)
        {
            for (int i = 0; i < 10000; ++i)
            {
                a = ::rand();
                q.enqueue(a);
            }

            while (q.move_next()) ;

            DLIB_TEST(q.at_start() == false);

            q.sort();

            DLIB_TEST(q.at_start() == true);

            // serialize the state of q, then clear q, then
            // load the state back into q.
            ostringstream sout;
            serialize(q,sout);
            DLIB_TEST(q.at_start() == true);
            istringstream sin(sout.str());
            q.clear();
            deserialize(q,sin);


            DLIB_TEST(q.at_start() == true);

            a = 0;
            int last = 0;
            while (q.move_next())
            {
                ++a;
                DLIB_TEST_MSG(last <= q.element(),"items weren't actually sorted");
                last = q.element();
                DLIB_TEST(q.current_element_valid() == true);
                DLIB_TEST(q.at_start() == false);
                DLIB_TEST(q.current_element_valid() == true);


            }
            DLIB_TEST_MSG(a == 10000,"some items were lost between the sorting and iterating");


            DLIB_TEST(q.size() == 10000);
            swap(q,q2);
            DLIB_TEST(q2.at_start() == false);
            DLIB_TEST(q2.current_element_valid() == false);

            DLIB_TEST (q2.move_next() == false);
            DLIB_TEST (q2.move_next() == false);
            DLIB_TEST (q2.move_next() == false);
            DLIB_TEST (q2.move_next() == false);
            DLIB_TEST (q2.move_next() == false);
            DLIB_TEST (q2.move_next() == false);


            DLIB_TEST(q2.size() == 10000);
            DLIB_TEST(q2.at_start() == false);
            DLIB_TEST(q2.current_element_valid() == false);

            q2.clear();

            q.swap(q2);

            DLIB_TEST(q.size() == 0);
            DLIB_TEST(q.at_start() == true);
            DLIB_TEST(q.current_element_valid() == false);
        }



        print_spinner();



        // try the above code but this time with just one element
        // in the queue
        for (int j = 0; j < 3; ++j)
        {
            for (int i = 0; i < 1; ++i)
            {
                a = ::rand();
                q.enqueue(a);
            }

            q.sort();

            a = 0;
            int last = 0;
            while (q.move_next())
            {
                ++a;
                DLIB_TEST_MSG(last <= q.element(),"items weren't actually sorted");
                DLIB_TEST(q.current_element_valid() == true);

            }
            DLIB_TEST_MSG(a == 1,"some items were lost between the sorting and iterating");


            DLIB_TEST(q.size() == 1);
            DLIB_TEST(q.at_start() == false);
            DLIB_TEST(q.current_element_valid() == false);

            q.clear();

            DLIB_TEST(q.size() == 0);
            DLIB_TEST(q.at_start() == true);
            DLIB_TEST(q.current_element_valid() == false);
        }


        print_spinner();

        {
            q.clear();
            remover<int>& go = q;
            for (int i = 0; i < 100; ++i)
            {
                int a = 3;
                q.enqueue(a);
            }
            DLIB_TEST(go.size() == 100);                
            for (int i = 0; i < 100; ++i)
            {
                int a = 9;
                q.remove_any(a);
                DLIB_TEST(a == 3);
            }
            DLIB_TEST(go.size() == 0);
        }

    }


    struct factory
    {
        template <typename U>
        struct return_type {
            typedef typename memory_manager<U>::kernel_3c type;
        };

        template <typename U>
        static typename return_type<U>::type* get_instance (
        )
        {
            static typename return_type<U>::type a;
            return &a;
        }
    };




    class queue_tester : public tester
    {
        /*!
            WHAT THIS OBJECT REPRESENTS
                This object represents a test for the queue object.  When it is constructed
                it adds itself into the testing framework.  The command line switch is
                specified as test_queue by passing that string to the tester constructor.
        !*/
    public:
        queue_tester (
        ) :
            tester ("test_queue",
                    "Runs tests on the queue component.")
        {}

        void perform_test (
        )
        {
            // There are multiple implementations of the queue object so use
            // the templated function defined above to test them all and report
            // a failed test if any of them don't pass.

            typedef dlib::memory_manager_global<char,factory>::kernel_1a mm;


            dlog << LINFO << "testing sort_1a_c";
            queue_sort_test<queue<int, mm>::sort_1a_c>  ();
            dlog << LINFO << "testing sort_1a";
            queue_sort_test<queue<int, mm>::sort_1a>();
            dlog << LINFO << "testing sort_1b";
            queue_sort_test<queue<int, mm>::sort_1b>  ();
            dlog << LINFO << "testing sort_1b_c";
            queue_sort_test<queue<int, mm>::sort_1b_c>();
            dlog << LINFO << "testing sort_1c";
            queue_sort_test<queue<int, mm>::sort_1c>  ();
            dlog << LINFO << "testing sort_1c_c";
            queue_sort_test<queue<int, mm>::sort_1c_c>();
        }
    } a;

}