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
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.10"/>
<title>C Standard Library Extensions: Double-ended queue.</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">C Standard Library Extensions
 <span id="projectnumber">1.2.1</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.10 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Double-ended queue.</div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga08414696dbbe9888ae5f8d1e346e94c8"><td class="memItemLeft" align="right" valign="top">cx_deque * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cxdeque.html#ga08414696dbbe9888ae5f8d1e346e94c8">cx_deque_new</a> (void)</td></tr>
<tr class="memdesc:ga08414696dbbe9888ae5f8d1e346e94c8"><td class="mdescLeft"> </td><td class="mdescRight">Create a new deque without any elements. <a href="#ga08414696dbbe9888ae5f8d1e346e94c8">More...</a><br /></td></tr>
<tr class="separator:ga08414696dbbe9888ae5f8d1e346e94c8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaccc454dff4ccc6be34f54427f7cbd44a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cxdeque.html#gaccc454dff4ccc6be34f54427f7cbd44a">cx_deque_delete</a> (cx_deque *deque)</td></tr>
<tr class="memdesc:gaccc454dff4ccc6be34f54427f7cbd44a"><td class="mdescLeft"> </td><td class="mdescRight">Destroy a deque. <a href="#gaccc454dff4ccc6be34f54427f7cbd44a">More...</a><br /></td></tr>
<tr class="separator:gaccc454dff4ccc6be34f54427f7cbd44a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaa2fc80632e4d71a70b41ad428b725fd2"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cxdeque.html#gaa2fc80632e4d71a70b41ad428b725fd2">cx_deque_destroy</a> (cx_deque *deque, cx_free_func deallocate)</td></tr>
<tr class="memdesc:gaa2fc80632e4d71a70b41ad428b725fd2"><td class="mdescLeft"> </td><td class="mdescRight">Destroy a deque and all its elements. <a href="#gaa2fc80632e4d71a70b41ad428b725fd2">More...</a><br /></td></tr>
<tr class="separator:gaa2fc80632e4d71a70b41ad428b725fd2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga5a3a8e35681c3553e40b980e30d333f7"><td class="memItemLeft" align="right" valign="top">cxsize </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cxdeque.html#ga5a3a8e35681c3553e40b980e30d333f7">cx_deque_size</a> (const cx_deque *deque)</td></tr>
<tr class="memdesc:ga5a3a8e35681c3553e40b980e30d333f7"><td class="mdescLeft"> </td><td class="mdescRight">Get the actual number of deque elements. <a href="#ga5a3a8e35681c3553e40b980e30d333f7">More...</a><br /></td></tr>
<tr class="separator:ga5a3a8e35681c3553e40b980e30d333f7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gac76b0d1a0364b2fc9ae0eec8bab7e53b"><td class="memItemLeft" align="right" valign="top">cxbool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cxdeque.html#gac76b0d1a0364b2fc9ae0eec8bab7e53b">cx_deque_empty</a> (const cx_deque *deque)</td></tr>
<tr class="memdesc:gac76b0d1a0364b2fc9ae0eec8bab7e53b"><td class="mdescLeft"> </td><td class="mdescRight">Check whether a deque is empty. <a href="#gac76b0d1a0364b2fc9ae0eec8bab7e53b">More...</a><br /></td></tr>
<tr class="separator:gac76b0d1a0364b2fc9ae0eec8bab7e53b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga8fd5474fc6be1684f6b964ae71626b0b"><td class="memItemLeft" align="right" valign="top">cxsize </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cxdeque.html#ga8fd5474fc6be1684f6b964ae71626b0b">cx_deque_max_size</a> (const cx_deque *deque)</td></tr>
<tr class="memdesc:ga8fd5474fc6be1684f6b964ae71626b0b"><td class="mdescLeft"> </td><td class="mdescRight">Get the maximum number of deque elements possible. <a href="#ga8fd5474fc6be1684f6b964ae71626b0b">More...</a><br /></td></tr>
<tr class="separator:ga8fd5474fc6be1684f6b964ae71626b0b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga1468b31126cccf70990247bf1629d7b5"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cxdeque.html#ga1468b31126cccf70990247bf1629d7b5">cx_deque_swap</a> (cx_deque *deque, cx_deque *other)</td></tr>
<tr class="memdesc:ga1468b31126cccf70990247bf1629d7b5"><td class="mdescLeft"> </td><td class="mdescRight">Swap the data of two deques. <a href="#ga1468b31126cccf70990247bf1629d7b5">More...</a><br /></td></tr>
<tr class="separator:ga1468b31126cccf70990247bf1629d7b5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga9c9278302d630b0cd955f71553f02a92"><td class="memItemLeft" align="right" valign="top">cxptr </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cxdeque.html#ga9c9278302d630b0cd955f71553f02a92">cx_deque_assign</a> (cx_deque *deque, cx_deque_iterator position, cxptr data)</td></tr>
<tr class="memdesc:ga9c9278302d630b0cd955f71553f02a92"><td class="mdescLeft"> </td><td class="mdescRight">Assign data to a deque element. <a href="#ga9c9278302d630b0cd955f71553f02a92">More...</a><br /></td></tr>
<tr class="separator:ga9c9278302d630b0cd955f71553f02a92"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gadc972ac99ddbca0a82ca4133fa5ff1ed"><td class="memItemLeft" align="right" valign="top">cxptr </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cxdeque.html#gadc972ac99ddbca0a82ca4133fa5ff1ed">cx_deque_front</a> (const cx_deque *deque)</td></tr>
<tr class="memdesc:gadc972ac99ddbca0a82ca4133fa5ff1ed"><td class="mdescLeft"> </td><td class="mdescRight">Get the first element of a deque. <a href="#gadc972ac99ddbca0a82ca4133fa5ff1ed">More...</a><br /></td></tr>
<tr class="separator:gadc972ac99ddbca0a82ca4133fa5ff1ed"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga45a29a6526f9d754289b3fe2a42d4a8e"><td class="memItemLeft" align="right" valign="top">cxptr </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cxdeque.html#ga45a29a6526f9d754289b3fe2a42d4a8e">cx_deque_back</a> (const cx_deque *deque)</td></tr>
<tr class="memdesc:ga45a29a6526f9d754289b3fe2a42d4a8e"><td class="mdescLeft"> </td><td class="mdescRight">Get the last element of a deque. <a href="#ga45a29a6526f9d754289b3fe2a42d4a8e">More...</a><br /></td></tr>
<tr class="separator:ga45a29a6526f9d754289b3fe2a42d4a8e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga30fd04264fec944999d39d62a48a09fc"><td class="memItemLeft" align="right" valign="top">cxptr </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cxdeque.html#ga30fd04264fec944999d39d62a48a09fc">cx_deque_get</a> (const cx_deque *deque, cx_deque_const_iterator position)</td></tr>
<tr class="memdesc:ga30fd04264fec944999d39d62a48a09fc"><td class="mdescLeft"> </td><td class="mdescRight">Retrieve an element from a deque. <a href="#ga30fd04264fec944999d39d62a48a09fc">More...</a><br /></td></tr>
<tr class="separator:ga30fd04264fec944999d39d62a48a09fc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gad29871e44bf1e90a9ec77a1b8f353182"><td class="memItemLeft" align="right" valign="top">cx_deque_iterator </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cxdeque.html#gad29871e44bf1e90a9ec77a1b8f353182">cx_deque_begin</a> (const cx_deque *deque)</td></tr>
<tr class="memdesc:gad29871e44bf1e90a9ec77a1b8f353182"><td class="mdescLeft"> </td><td class="mdescRight">Get an iterator for the first deque element. <a href="#gad29871e44bf1e90a9ec77a1b8f353182">More...</a><br /></td></tr>
<tr class="separator:gad29871e44bf1e90a9ec77a1b8f353182"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga24ba79d19e01d953a4a249f57836f9c1"><td class="memItemLeft" align="right" valign="top">cx_deque_iterator </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cxdeque.html#ga24ba79d19e01d953a4a249f57836f9c1">cx_deque_end</a> (const cx_deque *deque)</td></tr>
<tr class="memdesc:ga24ba79d19e01d953a4a249f57836f9c1"><td class="mdescLeft"> </td><td class="mdescRight">Get an iterator for the position after the last deque element. <a href="#ga24ba79d19e01d953a4a249f57836f9c1">More...</a><br /></td></tr>
<tr class="separator:ga24ba79d19e01d953a4a249f57836f9c1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gac615671b4a9ba93eafdc37a8641a40d0"><td class="memItemLeft" align="right" valign="top">cx_deque_iterator </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cxdeque.html#gac615671b4a9ba93eafdc37a8641a40d0">cx_deque_next</a> (const cx_deque *deque, cx_deque_const_iterator position)</td></tr>
<tr class="memdesc:gac615671b4a9ba93eafdc37a8641a40d0"><td class="mdescLeft"> </td><td class="mdescRight">Get an iterator for the next deque element. <a href="#gac615671b4a9ba93eafdc37a8641a40d0">More...</a><br /></td></tr>
<tr class="separator:gac615671b4a9ba93eafdc37a8641a40d0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga85b439c6ddfa9f73cb89b968286ff996"><td class="memItemLeft" align="right" valign="top">cx_deque_iterator </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cxdeque.html#ga85b439c6ddfa9f73cb89b968286ff996">cx_deque_previous</a> (const cx_deque *deque, cx_deque_const_iterator position)</td></tr>
<tr class="memdesc:ga85b439c6ddfa9f73cb89b968286ff996"><td class="mdescLeft"> </td><td class="mdescRight">Get an iterator for the previous deque element. <a href="#ga85b439c6ddfa9f73cb89b968286ff996">More...</a><br /></td></tr>
<tr class="separator:ga85b439c6ddfa9f73cb89b968286ff996"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaf93f33c892ead7b2ced1c7417ec3076a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cxdeque.html#gaf93f33c892ead7b2ced1c7417ec3076a">cx_deque_push_front</a> (cx_deque *deque, cxcptr data)</td></tr>
<tr class="memdesc:gaf93f33c892ead7b2ced1c7417ec3076a"><td class="mdescLeft"> </td><td class="mdescRight">Insert data at the beginning of a deque. <a href="#gaf93f33c892ead7b2ced1c7417ec3076a">More...</a><br /></td></tr>
<tr class="separator:gaf93f33c892ead7b2ced1c7417ec3076a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga28ee348bdd3fb6a09488bf1867381d2a"><td class="memItemLeft" align="right" valign="top">cxptr </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cxdeque.html#ga28ee348bdd3fb6a09488bf1867381d2a">cx_deque_pop_front</a> (cx_deque *deque)</td></tr>
<tr class="memdesc:ga28ee348bdd3fb6a09488bf1867381d2a"><td class="mdescLeft"> </td><td class="mdescRight">Remove the first deque element. <a href="#ga28ee348bdd3fb6a09488bf1867381d2a">More...</a><br /></td></tr>
<tr class="separator:ga28ee348bdd3fb6a09488bf1867381d2a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga75310934211aac1916975a5c0a5db654"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cxdeque.html#ga75310934211aac1916975a5c0a5db654">cx_deque_push_back</a> (cx_deque *deque, cxcptr data)</td></tr>
<tr class="memdesc:ga75310934211aac1916975a5c0a5db654"><td class="mdescLeft"> </td><td class="mdescRight">Append data at the end of a deque. <a href="#ga75310934211aac1916975a5c0a5db654">More...</a><br /></td></tr>
<tr class="separator:ga75310934211aac1916975a5c0a5db654"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga4f3183c0256c05f86ac94ece2cfec9bb"><td class="memItemLeft" align="right" valign="top">cxptr </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cxdeque.html#ga4f3183c0256c05f86ac94ece2cfec9bb">cx_deque_pop_back</a> (cx_deque *deque)</td></tr>
<tr class="memdesc:ga4f3183c0256c05f86ac94ece2cfec9bb"><td class="mdescLeft"> </td><td class="mdescRight">Remove the last deque element. <a href="#ga4f3183c0256c05f86ac94ece2cfec9bb">More...</a><br /></td></tr>
<tr class="separator:ga4f3183c0256c05f86ac94ece2cfec9bb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga2ce86c4fc6ecbfd0642cf01ba7417716"><td class="memItemLeft" align="right" valign="top">cx_deque_iterator </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cxdeque.html#ga2ce86c4fc6ecbfd0642cf01ba7417716">cx_deque_insert</a> (cx_deque *deque, cx_deque_iterator position, cxcptr data)</td></tr>
<tr class="memdesc:ga2ce86c4fc6ecbfd0642cf01ba7417716"><td class="mdescLeft"> </td><td class="mdescRight">Insert data into a deque at a given iterator position. <a href="#ga2ce86c4fc6ecbfd0642cf01ba7417716">More...</a><br /></td></tr>
<tr class="separator:ga2ce86c4fc6ecbfd0642cf01ba7417716"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga19f6812a711e91faa4549f815c1c8a17"><td class="memItemLeft" align="right" valign="top">cx_deque_iterator </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cxdeque.html#ga19f6812a711e91faa4549f815c1c8a17">cx_deque_erase</a> (cx_deque *deque, cx_deque_iterator position, cx_free_func deallocate)</td></tr>
<tr class="memdesc:ga19f6812a711e91faa4549f815c1c8a17"><td class="mdescLeft"> </td><td class="mdescRight">Erase a deque element. <a href="#ga19f6812a711e91faa4549f815c1c8a17">More...</a><br /></td></tr>
<tr class="separator:ga19f6812a711e91faa4549f815c1c8a17"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga6f346315cb2fba4efe3e5978f65edf5e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cxdeque.html#ga6f346315cb2fba4efe3e5978f65edf5e">cx_deque_clear</a> (cx_deque *deque)</td></tr>
<tr class="memdesc:ga6f346315cb2fba4efe3e5978f65edf5e"><td class="mdescLeft"> </td><td class="mdescRight">Remove all elements from a deque. <a href="#ga6f346315cb2fba4efe3e5978f65edf5e">More...</a><br /></td></tr>
<tr class="separator:ga6f346315cb2fba4efe3e5978f65edf5e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaa6b6977bbddfd9ce593caadfe6055b55"><td class="memItemLeft" align="right" valign="top">cxptr </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cxdeque.html#gaa6b6977bbddfd9ce593caadfe6055b55">cx_deque_extract</a> (cx_deque *deque, cx_deque_iterator position)</td></tr>
<tr class="memdesc:gaa6b6977bbddfd9ce593caadfe6055b55"><td class="mdescLeft"> </td><td class="mdescRight">Extract a deque element. <a href="#gaa6b6977bbddfd9ce593caadfe6055b55">More...</a><br /></td></tr>
<tr class="separator:gaa6b6977bbddfd9ce593caadfe6055b55"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga0cf7b04e8acb40fbbd1f3727c7ae5981"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cxdeque.html#ga0cf7b04e8acb40fbbd1f3727c7ae5981">cx_deque_remove</a> (cx_deque *deque, cxcptr data)</td></tr>
<tr class="memdesc:ga0cf7b04e8acb40fbbd1f3727c7ae5981"><td class="mdescLeft"> </td><td class="mdescRight">Remove all elements with a given value from a deque. <a href="#ga0cf7b04e8acb40fbbd1f3727c7ae5981">More...</a><br /></td></tr>
<tr class="separator:ga0cf7b04e8acb40fbbd1f3727c7ae5981"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga2ca9af2987ea657a140ad084979abad0"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cxdeque.html#ga2ca9af2987ea657a140ad084979abad0">cx_deque_unique</a> (cx_deque *deque, cx_compare_func compare)</td></tr>
<tr class="memdesc:ga2ca9af2987ea657a140ad084979abad0"><td class="mdescLeft"> </td><td class="mdescRight">Remove duplicates of consecutive elements. <a href="#ga2ca9af2987ea657a140ad084979abad0">More...</a><br /></td></tr>
<tr class="separator:ga2ca9af2987ea657a140ad084979abad0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga462895062b73db7aebb3d1b4e01960f8"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cxdeque.html#ga462895062b73db7aebb3d1b4e01960f8">cx_deque_splice</a> (cx_deque *deque, cx_deque_iterator position, cx_deque *other, cx_deque_iterator first, cx_deque_iterator last)</td></tr>
<tr class="memdesc:ga462895062b73db7aebb3d1b4e01960f8"><td class="mdescLeft"> </td><td class="mdescRight">Move a range of elements in front of a given position. <a href="#ga462895062b73db7aebb3d1b4e01960f8">More...</a><br /></td></tr>
<tr class="separator:ga462895062b73db7aebb3d1b4e01960f8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga7a1a134e57f98d00273d3b7c061c9d47"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cxdeque.html#ga7a1a134e57f98d00273d3b7c061c9d47">cx_deque_merge</a> (cx_deque *deque, cx_deque *other, cx_compare_func compare)</td></tr>
<tr class="memdesc:ga7a1a134e57f98d00273d3b7c061c9d47"><td class="mdescLeft"> </td><td class="mdescRight">Merge two sorted deques. <a href="#ga7a1a134e57f98d00273d3b7c061c9d47">More...</a><br /></td></tr>
<tr class="separator:ga7a1a134e57f98d00273d3b7c061c9d47"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gab0fd66397386847260275b8b43649d55"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cxdeque.html#gab0fd66397386847260275b8b43649d55">cx_deque_sort</a> (cx_deque *deque, cx_compare_func compare)</td></tr>
<tr class="memdesc:gab0fd66397386847260275b8b43649d55"><td class="mdescLeft"> </td><td class="mdescRight">Sort all elements of a deque using the given comparison function. <a href="#gab0fd66397386847260275b8b43649d55">More...</a><br /></td></tr>
<tr class="separator:gab0fd66397386847260275b8b43649d55"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga8f823cbda988974e970cd228bb8dcea2"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cxdeque.html#ga8f823cbda988974e970cd228bb8dcea2">cx_deque_reverse</a> (cx_deque *deque)</td></tr>
<tr class="memdesc:ga8f823cbda988974e970cd228bb8dcea2"><td class="mdescLeft"> </td><td class="mdescRight">Reverse the order of all deque elements. <a href="#ga8f823cbda988974e970cd228bb8dcea2">More...</a><br /></td></tr>
<tr class="separator:ga8f823cbda988974e970cd228bb8dcea2"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>The module implements a double-ended queue. This is a linear list which is optimized for insertions and deletions that are made at the ends of the list.</p>
<dl class="section user"><dt>Synopsis:</dt><dd><div class="fragment"><div class="line"><span class="preprocessor">#include <cxdeque.h></span></div>
</div><!-- fragment --> </dd></dl>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga9c9278302d630b0cd955f71553f02a92"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">cxptr cx_deque_assign </td>
<td>(</td>
<td class="paramtype">cx_deque * </td>
<td class="paramname"><em>deque</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">cx_deque_iterator </td>
<td class="paramname"><em>position</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">cxptr </td>
<td class="paramname"><em>data</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Assign data to a deque element. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">deque</td><td>A deque. </td></tr>
<tr><td class="paramname">position</td><td>Position of the deque element where the data will be stored. </td></tr>
<tr><td class="paramname">data</td><td>Data to store.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Handle to the previously stored data object.</dd></dl>
<p>The function assigns the data object reference <em>data</em> to the iterator position <em>position</em> of the deque <em>deque</em>. </p>
</div>
</div>
<a class="anchor" id="ga45a29a6526f9d754289b3fe2a42d4a8e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">cxptr cx_deque_back </td>
<td>(</td>
<td class="paramtype">const cx_deque * </td>
<td class="paramname"><em>deque</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the last element of a deque. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">deque</td><td>The deque to query.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Handle to the data object stored in the last deque element.</dd></dl>
<p>The function returns a reference to the last data item in the deque <em>deque</em>. </p>
</div>
</div>
<a class="anchor" id="gad29871e44bf1e90a9ec77a1b8f353182"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">cx_deque_iterator cx_deque_begin </td>
<td>(</td>
<td class="paramtype">const cx_deque * </td>
<td class="paramname"><em>deque</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get an iterator for the first deque element. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">deque</td><td>A deque.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Iterator for the first element in the deque or <b><a class="el" href="group__cxdeque.html#ga24ba79d19e01d953a4a249f57836f9c1" title="Get an iterator for the position after the last deque element. ">cx_deque_end()</a></b> if the deque is empty.</dd></dl>
<p>The function returns a handle to the first element of <em>deque</em>. The handle cannot be used directly to access the element data, but only through the appropriate functions. </p>
</div>
</div>
<a class="anchor" id="ga6f346315cb2fba4efe3e5978f65edf5e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void cx_deque_clear </td>
<td>(</td>
<td class="paramtype">cx_deque * </td>
<td class="paramname"><em>deque</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Remove all elements from a deque. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">deque</td><td>Deque to be cleared.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Nothing.</dd></dl>
<p>The deque <em>deque</em> is cleared, i.e. all elements are removed from the deque. The removed data objects are left untouched, in particular they are not deallocated. It is the responsibility of the caller to ensure that there are still other references to the removed data objects. After calling <b><a class="el" href="group__cxdeque.html#ga6f346315cb2fba4efe3e5978f65edf5e" title="Remove all elements from a deque. ">cx_deque_clear()</a></b> the deque <em>deque</em> is empty. </p>
</div>
</div>
<a class="anchor" id="gaccc454dff4ccc6be34f54427f7cbd44a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void cx_deque_delete </td>
<td>(</td>
<td class="paramtype">cx_deque * </td>
<td class="paramname"><em>deque</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Destroy a deque. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">deque</td><td>The deque to delete.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Nothing.</dd></dl>
<p>The function deallocates the deque object, but not the data objects currently stored in the deque. </p>
<p>References <a class="el" href="group__cxdeque.html#gac76b0d1a0364b2fc9ae0eec8bab7e53b">cx_deque_empty()</a>, and <a class="el" href="group__cxmemory.html#ga535a509573c6617da8f0dccdb2710bc9">cx_free()</a>.</p>
</div>
</div>
<a class="anchor" id="gaa2fc80632e4d71a70b41ad428b725fd2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void cx_deque_destroy </td>
<td>(</td>
<td class="paramtype">cx_deque * </td>
<td class="paramname"><em>deque</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">cx_free_func </td>
<td class="paramname"><em>deallocate</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Destroy a deque and all its elements. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">deque</td><td>Deque container to destroy. </td></tr>
<tr><td class="paramname">deallocate</td><td>Data deallocator.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Nothing.</dd></dl>
<p>The function deallocates all data objects referenced by <em>deque</em> using the data deallocation function <em>deallocate</em> and finally deallocates the deque object itself. </p>
<p>References <a class="el" href="group__cxmemory.html#ga535a509573c6617da8f0dccdb2710bc9">cx_free()</a>.</p>
</div>
</div>
<a class="anchor" id="gac76b0d1a0364b2fc9ae0eec8bab7e53b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">cxbool cx_deque_empty </td>
<td>(</td>
<td class="paramtype">const cx_deque * </td>
<td class="paramname"><em>deque</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Check whether a deque is empty. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">deque</td><td>A deque.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The function returns <code>TRUE</code> if the deque is empty, and <code>FALSE</code> otherwise.</dd></dl>
<p>The function tests if the deque <em>deque</em> contains data. </p>
<p>Referenced by <a class="el" href="group__cxdeque.html#gaccc454dff4ccc6be34f54427f7cbd44a">cx_deque_delete()</a>.</p>
</div>
</div>
<a class="anchor" id="ga24ba79d19e01d953a4a249f57836f9c1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">cx_deque_iterator cx_deque_end </td>
<td>(</td>
<td class="paramtype">const cx_deque * </td>
<td class="paramname"><em>deque</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get an iterator for the position after the last deque element. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">deque</td><td>A deque.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Iterator for the end of the deque.</dd></dl>
<p>The function returns an iterator for the position one past the last element of the deque <em>deque</em>. The handle cannot be used to directly access the element data, but only through the appropriate functions. </p>
</div>
</div>
<a class="anchor" id="ga19f6812a711e91faa4549f815c1c8a17"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">cx_deque_iterator cx_deque_erase </td>
<td>(</td>
<td class="paramtype">cx_deque * </td>
<td class="paramname"><em>deque</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">cx_deque_iterator </td>
<td class="paramname"><em>position</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">cx_free_func </td>
<td class="paramname"><em>deallocate</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Erase a deque element. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">deque</td><td>The deque to update. </td></tr>
<tr><td class="paramname">position</td><td>Deque iterator position. </td></tr>
<tr><td class="paramname">deallocate</td><td>Data deallocator.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The iterator for the deque position after <em>position</em>.</dd></dl>
<p>The function removes the data object stored at position <em>position</em> from the deque <em>deque</em>. The data object itself is deallocated by calling the data deallocator <em>deallocate</em>. </p>
</div>
</div>
<a class="anchor" id="gaa6b6977bbddfd9ce593caadfe6055b55"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">cxptr cx_deque_extract </td>
<td>(</td>
<td class="paramtype">cx_deque * </td>
<td class="paramname"><em>deque</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">cx_deque_iterator </td>
<td class="paramname"><em>position</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Extract a deque element. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">deque</td><td>A deque. </td></tr>
<tr><td class="paramname">position</td><td>Deque iterator position.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Handle to the previously stored data object.</dd></dl>
<p>The function removes a data object from the deque <em>deque</em> located at the iterator position <em>position</em> without destroying the data object.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__cxdeque.html#ga19f6812a711e91faa4549f815c1c8a17" title="Erase a deque element. ">cx_deque_erase()</a>, <a class="el" href="group__cxdeque.html#ga0cf7b04e8acb40fbbd1f3727c7ae5981" title="Remove all elements with a given value from a deque. ">cx_deque_remove()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="gadc972ac99ddbca0a82ca4133fa5ff1ed"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">cxptr cx_deque_front </td>
<td>(</td>
<td class="paramtype">const cx_deque * </td>
<td class="paramname"><em>deque</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the first element of a deque. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">deque</td><td>The deque to query.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Handle to the data object stored in the first deque element.</dd></dl>
<p>The function returns a reference to the first data item in the deque <em>deque</em>. </p>
</div>
</div>
<a class="anchor" id="ga30fd04264fec944999d39d62a48a09fc"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">cxptr cx_deque_get </td>
<td>(</td>
<td class="paramtype">const cx_deque * </td>
<td class="paramname"><em>deque</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">cx_deque_const_iterator </td>
<td class="paramname"><em>position</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieve an element from a deque. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">deque</td><td>The deque to query. </td></tr>
<tr><td class="paramname">position</td><td>The position of the element to get.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A handle to the data object.</dd></dl>
<p>The function returns a reference to the data item stored in the deque <em>deque</em> at the iterator position <em>position</em>. </p>
</div>
</div>
<a class="anchor" id="ga2ce86c4fc6ecbfd0642cf01ba7417716"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">cx_deque_iterator cx_deque_insert </td>
<td>(</td>
<td class="paramtype">cx_deque * </td>
<td class="paramname"><em>deque</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">cx_deque_iterator </td>
<td class="paramname"><em>position</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">cxcptr </td>
<td class="paramname"><em>data</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Insert data into a deque at a given iterator position. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">deque</td><td>The deque to update. </td></tr>
<tr><td class="paramname">position</td><td>List iterator position. </td></tr>
<tr><td class="paramname">data</td><td>Data item to insert.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Deque iterator position of the inserted data item.</dd></dl>
<p>The function inserts the data object reference <em>data</em> into the deque <em>deque</em> at the position given by the deque iterator <em>position</em>. </p>
<p>References <a class="el" href="group__cxdeque.html#ga75310934211aac1916975a5c0a5db654">cx_deque_push_back()</a>.</p>
</div>
</div>
<a class="anchor" id="ga8fd5474fc6be1684f6b964ae71626b0b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">cxsize cx_deque_max_size </td>
<td>(</td>
<td class="paramtype">const cx_deque * </td>
<td class="paramname"><em>deque</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the maximum number of deque elements possible. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">deque</td><td>A deque.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The maximum number of elements that can be stored in the deque.</dd></dl>
<p>Retrieves the deques capacity, i.e. the maximum possible number of data items a deque can hold. </p>
</div>
</div>
<a class="anchor" id="ga7a1a134e57f98d00273d3b7c061c9d47"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void cx_deque_merge </td>
<td>(</td>
<td class="paramtype">cx_deque * </td>
<td class="paramname"><em>deque</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">cx_deque * </td>
<td class="paramname"><em>other</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">cx_compare_func </td>
<td class="paramname"><em>compare</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Merge two sorted deques. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">deque</td><td>Target deque of the merge operation. </td></tr>
<tr><td class="paramname">other</td><td>The deque to merge into the target. </td></tr>
<tr><td class="paramname">compare</td><td>Function comparing the deque elements.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Nothing.</dd></dl>
<p>The function combines the two deques <em>deque</em> and <em>other</em> by moving all elements from <em>other</em> into <em>deque</em>, so that all elements are still sorted. The function requires that both input deques are already sorted. The sorting order in which the elements of <em>other</em> are inserted into <em>deque</em> is determined by the comparison function <em>compare</em>. The comparison function <em>compare</em> must return an integer less than, equal or greater than zero if the first argument passed to it is found, respectively, to be less than, match, or be greater than the second argument.</p>
<p>The deque <em>other</em> is consumed by this process, i.e. after the successful merging of the two deques, deque <em>other</em> will be empty. </p>
</div>
</div>
<a class="anchor" id="ga08414696dbbe9888ae5f8d1e346e94c8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">cx_deque* cx_deque_new </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a new deque without any elements. </p>
<dl class="section return"><dt>Returns</dt><dd>Handle to the newly allocated deque.</dd></dl>
<p>The function allocates memory for a deque object and initializes it to an empty deque. </p>
<p>References <a class="el" href="group__cxmemory.html#ga7ae1df2916d7231b1959cebcf4acafab">cx_malloc()</a>.</p>
</div>
</div>
<a class="anchor" id="gac615671b4a9ba93eafdc37a8641a40d0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">cx_deque_iterator cx_deque_next </td>
<td>(</td>
<td class="paramtype">const cx_deque * </td>
<td class="paramname"><em>deque</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">cx_deque_const_iterator </td>
<td class="paramname"><em>position</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get an iterator for the next deque element. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">deque</td><td>A deque. </td></tr>
<tr><td class="paramname">position</td><td>Current iterator position.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Iterator for the next deque element.</dd></dl>
<p>The function returns an iterator for the next element in the deque <em>deque</em> with respect to the current iterator position <em>position</em>. If the deque <em>deque</em> is empty or <em>position</em> points to the deque end the function returns <b><a class="el" href="group__cxdeque.html#ga24ba79d19e01d953a4a249f57836f9c1" title="Get an iterator for the position after the last deque element. ">cx_deque_end()</a></b>. </p>
</div>
</div>
<a class="anchor" id="ga4f3183c0256c05f86ac94ece2cfec9bb"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">cxptr cx_deque_pop_back </td>
<td>(</td>
<td class="paramtype">cx_deque * </td>
<td class="paramname"><em>deque</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Remove the last deque element. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">deque</td><td>The deque to update.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Handle to the data object previously stored as the last deque element.</dd></dl>
<p>The function removes the last element from the deque <em>deque</em> returning a handle to the previously stored data.</p>
<p>It is equivalent to the statement </p><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> cx_deque_extract(deque, cx_deque_previous(deque, cx_deque_end(deque)));</div>
</div><!-- fragment -->
</div>
</div>
<a class="anchor" id="ga28ee348bdd3fb6a09488bf1867381d2a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">cxptr cx_deque_pop_front </td>
<td>(</td>
<td class="paramtype">cx_deque * </td>
<td class="paramname"><em>deque</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Remove the first deque element. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">deque</td><td>The deque to update.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Handle to the data object previously stored as the first deque element.</dd></dl>
<p>The function removes the first element from the deque <em>deque</em> returning a handle to the previously stored data.</p>
<p>It is equivalent to the statement </p><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> cx_deque_extract(deque, cx_deque_begin(deque));</div>
</div><!-- fragment -->
</div>
</div>
<a class="anchor" id="ga85b439c6ddfa9f73cb89b968286ff996"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">cx_deque_iterator cx_deque_previous </td>
<td>(</td>
<td class="paramtype">const cx_deque * </td>
<td class="paramname"><em>deque</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">cx_deque_const_iterator </td>
<td class="paramname"><em>position</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get an iterator for the previous deque element. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">deque</td><td>A deque. </td></tr>
<tr><td class="paramname">position</td><td>Current iterator position.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Iterator for the previous deque element.</dd></dl>
<p>The function returns an iterator for the previous element in the deque <em>deque</em> with respect to the current iterator position <em>position</em>. If the deque <em>deque</em> is empty or <em>position</em> points to the beginning of the deque the function returns <b><a class="el" href="group__cxdeque.html#ga24ba79d19e01d953a4a249f57836f9c1" title="Get an iterator for the position after the last deque element. ">cx_deque_end()</a></b>. </p>
</div>
</div>
<a class="anchor" id="ga75310934211aac1916975a5c0a5db654"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void cx_deque_push_back </td>
<td>(</td>
<td class="paramtype">cx_deque * </td>
<td class="paramname"><em>deque</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">cxcptr </td>
<td class="paramname"><em>data</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Append data at the end of a deque. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">deque</td><td>The deque to update. </td></tr>
<tr><td class="paramname">data</td><td>Data to append.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Nothing.</dd></dl>
<p>The data <em>data</em> is inserted into the deque <em>deque</em> after the last element, so that it becomes the new deque tail.</p>
<p>It is equivalent to the statement </p><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> cx_deque_insert(deque, cx_deque_end(deque), data);</div>
</div><!-- fragment -->
<p>Referenced by <a class="el" href="group__cxdeque.html#ga2ce86c4fc6ecbfd0642cf01ba7417716">cx_deque_insert()</a>.</p>
</div>
</div>
<a class="anchor" id="gaf93f33c892ead7b2ced1c7417ec3076a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void cx_deque_push_front </td>
<td>(</td>
<td class="paramtype">cx_deque * </td>
<td class="paramname"><em>deque</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">cxcptr </td>
<td class="paramname"><em>data</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Insert data at the beginning of a deque. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">deque</td><td>The deque to update. </td></tr>
<tr><td class="paramname">data</td><td>Data to add to the deque.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Nothing.</dd></dl>
<p>The data <em>data</em> is inserted into the deque <em>deque</em> before the first element of the deque, so that it becomes the new deque head.</p>
<p>It is equivalent to the statement </p><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> cx_deque_insert(deque, cx_deque_begin(deque), data);</div>
</div><!-- fragment -->
</div>
</div>
<a class="anchor" id="ga0cf7b04e8acb40fbbd1f3727c7ae5981"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void cx_deque_remove </td>
<td>(</td>
<td class="paramtype">cx_deque * </td>
<td class="paramname"><em>deque</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">cxcptr </td>
<td class="paramname"><em>data</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Remove all elements with a given value from a deque. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">deque</td><td>A deque. </td></tr>
<tr><td class="paramname">data</td><td>Data to remove.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Nothing.</dd></dl>
<p>The value <em>data</em> is searched in the deque <em>deque</em>. If the data is found it is removed from the deque. The data object itself is not deallocated. </p>
</div>
</div>
<a class="anchor" id="ga8f823cbda988974e970cd228bb8dcea2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void cx_deque_reverse </td>
<td>(</td>
<td class="paramtype">cx_deque * </td>
<td class="paramname"><em>deque</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Reverse the order of all deque elements. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">deque</td><td>The deque to reverse.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Nothing.</dd></dl>
<p>The order of the elements of the deque <em>deque</em> is reversed. </p>
</div>
</div>
<a class="anchor" id="ga5a3a8e35681c3553e40b980e30d333f7"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">cxsize cx_deque_size </td>
<td>(</td>
<td class="paramtype">const cx_deque * </td>
<td class="paramname"><em>deque</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the actual number of deque elements. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">deque</td><td>A deque.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The current number of elements the deque contains, or 0 if the deque is empty.</dd></dl>
<p>Retrieves the number of elements currently stored in the deque <em>deque</em>. </p>
</div>
</div>
<a class="anchor" id="gab0fd66397386847260275b8b43649d55"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void cx_deque_sort </td>
<td>(</td>
<td class="paramtype">cx_deque * </td>
<td class="paramname"><em>deque</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">cx_compare_func </td>
<td class="paramname"><em>compare</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sort all elements of a deque using the given comparison function. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">deque</td><td>The deque to sort. </td></tr>
<tr><td class="paramname">compare</td><td>Function comparing the deque elements.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Nothing.</dd></dl>
<p>The input deque <em>deque</em> is sorted using the comparison function <em>compare</em> to determine the order of two deque elements. The comparison function <em>compare</em> must return an integer less than, equal or greater than zero if the first argument passed to it is found, respectively, to be less than, equal, or be greater than the second argument. This function uses the stdlib function qsort(). </p>
</div>
</div>
<a class="anchor" id="ga462895062b73db7aebb3d1b4e01960f8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void cx_deque_splice </td>
<td>(</td>
<td class="paramtype">cx_deque * </td>
<td class="paramname"><em>deque</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">cx_deque_iterator </td>
<td class="paramname"><em>position</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">cx_deque * </td>
<td class="paramname"><em>other</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">cx_deque_iterator </td>
<td class="paramname"><em>first</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">cx_deque_iterator </td>
<td class="paramname"><em>last</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Move a range of elements in front of a given position. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">deque</td><td>Target deque. </td></tr>
<tr><td class="paramname">position</td><td>Target iterator position. </td></tr>
<tr><td class="paramname">other</td><td>Source deque. </td></tr>
<tr><td class="paramname">first</td><td>Position of the first element to move. </td></tr>
<tr><td class="paramname">last</td><td>Position of the last element to move.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Nothing.</dd></dl>
<p>The range of deque elements from the iterator position <em>first</em> to <em>last</em>, but not including <em>last</em>, is moved from the source deque <em>other</em> in front of the position <em>position</em> of the target deque <em>deque</em>. Target and source deque may be identical, provided that the target position <em>position</em> does not fall within the range of deque elements to move. </p>
</div>
</div>
<a class="anchor" id="ga1468b31126cccf70990247bf1629d7b5"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void cx_deque_swap </td>
<td>(</td>
<td class="paramtype">cx_deque * </td>
<td class="paramname"><em>deque</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">cx_deque * </td>
<td class="paramname"><em>other</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Swap the data of two deques. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">deque</td><td>The first deque. </td></tr>
<tr><td class="paramname">other</td><td>The second deque.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Nothing.</dd></dl>
<p>The contents of the deque <em>other</em> will be moved to the deque <em>deque</em>, while the contents of <em>deque</em> is moved to <em>other</em>. </p>
</div>
</div>
<a class="anchor" id="ga2ca9af2987ea657a140ad084979abad0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void cx_deque_unique </td>
<td>(</td>
<td class="paramtype">cx_deque * </td>
<td class="paramname"><em>deque</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">cx_compare_func </td>
<td class="paramname"><em>compare</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Remove duplicates of consecutive elements. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">deque</td><td>A deque. </td></tr>
<tr><td class="paramname">compare</td><td>Function comparing the deque elements.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Nothing.</dd></dl>
<p>The function removes duplicates of consecutive deque elements, i.e. deque elements with the same value, from the deque <em>deque</em>. The equality of the deque elements is checked using the comparison function <em>compare</em>. The comparison function <em>compare</em> must return an integer less than, equal or greater than zero if the first argument passed to it is found, respectively, to be less than, match, or be greater than the second argument. </p>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.10
</small></address>
</body>
</html>
|
