C Standard Library Extensions  1.2.3
cxdeque.h
1 /*
2  * This file is part of the ESO C Extension Library
3  * Copyright (C) 2001-2017 European Southern Observatory
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License as published by
7  * the Free Software Foundation; either version 2 of the License, or
8  * (at your option) any later version.
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with this program; if not, write to the Free Software
17  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
18  */
19 
20 #ifndef CX_DEQUE_H
21 #define CX_DEQUE_H
22 
23 #include <cxtypes.h>
24 #include <cxmemory.h>
25 
26 CX_BEGIN_DECLS
27 
28 typedef struct _cx_deque_ cx_deque;
29 
30 typedef cxsize cx_deque_const_iterator;
31 typedef cxsize cx_deque_iterator;
32 
33 
34 /*
35  * Create, copy and destroy operations
36  */
37 
38 cx_deque *cx_deque_new(void);
39 void cx_deque_delete(cx_deque* deque);
40 void cx_deque_destroy(cx_deque *deque, cx_free_func deallocate);
41 
42 /*
43  * Non-modifying operations
44  */
45 
46 cxsize cx_deque_size(const cx_deque *deque);
47 cxbool cx_deque_empty(const cx_deque *deque);
48 cxsize cx_deque_max_size(const cx_deque *deque);
49 
50 /*
51  * Assignment operations
52  */
53 
54 void cx_deque_swap(cx_deque *deque, cx_deque *other);
55 cxptr cx_deque_assign(cx_deque *deque, cx_deque_iterator position, cxptr data);
56 
57 /*
58  * Element access
59  */
60 
61 cxptr cx_deque_front(const cx_deque *deque);
62 cxptr cx_deque_back(const cx_deque *deque);
63 cxptr cx_deque_get(const cx_deque *deque, cx_deque_const_iterator position);
64 
65 /*
66  * Iterator functions
67  */
68 
69 cx_deque_iterator cx_deque_begin(const cx_deque *deque);
70 cx_deque_iterator cx_deque_end(const cx_deque *deque);
71 cx_deque_iterator cx_deque_next(const cx_deque *deque,
72  cx_deque_const_iterator position);
73 cx_deque_iterator cx_deque_previous(const cx_deque *deque,
74  cx_deque_const_iterator position);
75 
76 /*
77  * Inserting and removing elements
78  */
79 
80 void cx_deque_push_front(cx_deque *deque, cxcptr data);
81 cxptr cx_deque_pop_front(cx_deque *deque);
82 void cx_deque_push_back(cx_deque *deque, cxcptr data);
83 cxptr cx_deque_pop_back(cx_deque *deque);
84 
85 cx_deque_iterator cx_deque_insert(cx_deque *deque, cx_deque_iterator position,
86  cxcptr data);
87 cx_deque_iterator cx_deque_erase(cx_deque *deque, cx_deque_iterator position,
88  cx_free_func deallocate);
89 void cx_deque_clear(cx_deque *deque);
90 
91 
92 /*
93  * Extra deque interfaces
94  */
95 
96 /*
97  * Removing elements
98  */
99 
100 cxptr cx_deque_extract(cx_deque *deque, cx_deque_iterator position);
101 void cx_deque_remove(cx_deque *deque, cxcptr data);
102 
103 /*
104  * Splice functions
105  */
106 
107 void cx_deque_unique(cx_deque *deque, cx_compare_func compare);
108 void cx_deque_splice(cx_deque *deque, cx_deque_iterator position,
109  cx_deque *other, cx_deque_iterator start,
110  cx_deque_iterator end);
111 void cx_deque_merge(cx_deque *deque, cx_deque *other, cx_compare_func compare);
112 void cx_deque_sort(cx_deque *deque, cx_compare_func compare);
113 void cx_deque_reverse(cx_deque *deque);
114 
115 CX_END_DECLS
116 
117 #endif /* CX_DEQUE_H */
cx_deque * cx_deque_new(void)
Create a new deque without any elements.
Definition: cxdeque.c:795
void cx_deque_remove(cx_deque *deque, cxcptr data)
Remove all elements with a given value from a deque.
Definition: cxdeque.c:1474
void cx_deque_swap(cx_deque *deque, cx_deque *other)
Swap the data of two deques.
Definition: cxdeque.c:953
cx_deque_iterator cx_deque_erase(cx_deque *deque, cx_deque_iterator position, cx_free_func deallocate)
Erase a deque element.
Definition: cxdeque.c:1383
cx_deque_iterator cx_deque_end(const cx_deque *deque)
Get an iterator for the position after the last deque element.
Definition: cxdeque.c:1125
cxptr cx_deque_pop_front(cx_deque *deque)
Remove the first deque element.
Definition: cxdeque.c:1238
void cx_deque_unique(cx_deque *deque, cx_compare_func compare)
Remove duplicates of consecutive elements.
Definition: cxdeque.c:1519
cx_deque_iterator cx_deque_insert(cx_deque *deque, cx_deque_iterator position, cxcptr data)
Insert data into a deque at a given iterator position.
Definition: cxdeque.c:1339
cxptr cx_deque_get(const cx_deque *deque, cx_deque_const_iterator position)
Retrieve an element from a deque.
Definition: cxdeque.c:1075
cxptr cx_deque_back(const cx_deque *deque)
Get the last element of a deque.
Definition: cxdeque.c:1050
void cx_deque_splice(cx_deque *deque, cx_deque_iterator position, cx_deque *other, cx_deque_iterator start, cx_deque_iterator end)
Move a range of elements in front of a given position.
Definition: cxdeque.c:1572
cxptr cx_deque_pop_back(cx_deque *deque)
Remove the last deque element.
Definition: cxdeque.c:1309
cxsize cx_deque_size(const cx_deque *deque)
Get the actual number of deque elements.
Definition: cxdeque.c:885
void cx_deque_clear(cx_deque *deque)
Remove all elements from a deque.
Definition: cxdeque.c:1422
void cx_deque_push_back(cx_deque *deque, cxcptr data)
Append data at the end of a deque.
Definition: cxdeque.c:1268
void cx_deque_merge(cx_deque *deque, cx_deque *other, cx_compare_func compare)
Merge two sorted deques.
Definition: cxdeque.c:1625
cx_deque_iterator cx_deque_previous(const cx_deque *deque, cx_deque_const_iterator position)
Get an iterator for the previous deque element.
Definition: cxdeque.c:1175
void cx_deque_reverse(cx_deque *deque)
Reverse the order of all deque elements.
Definition: cxdeque.c:1681
cxsize cx_deque_max_size(const cx_deque *deque)
Get the maximum number of deque elements possible.
Definition: cxdeque.c:929
cxptr cx_deque_assign(cx_deque *deque, cx_deque_iterator position, cxptr data)
Assign data to a deque element.
Definition: cxdeque.c:996
void cx_deque_destroy(cx_deque *deque, cx_free_func deallocate)
Destroy a deque and all its elements.
Definition: cxdeque.c:847
cxptr cx_deque_extract(cx_deque *deque, cx_deque_iterator position)
Extract a deque element.
Definition: cxdeque.c:1447
void cx_deque_sort(cx_deque *deque, cx_compare_func compare)
Sort all elements of a deque using the given comparison function.
Definition: cxdeque.c:1657
cx_deque_iterator cx_deque_next(const cx_deque *deque, cx_deque_const_iterator position)
Get an iterator for the next deque element.
Definition: cxdeque.c:1150
cxbool cx_deque_empty(const cx_deque *deque)
Check whether a deque is empty.
Definition: cxdeque.c:907
void cx_deque_delete(cx_deque *deque)
Destroy a deque.
Definition: cxdeque.c:819
cx_deque_iterator cx_deque_begin(const cx_deque *deque)
Get an iterator for the first deque element.
Definition: cxdeque.c:1102
cxptr cx_deque_front(const cx_deque *deque)
Get the first element of a deque.
Definition: cxdeque.c:1026
void cx_deque_push_front(cx_deque *deque, cxcptr data)
Insert data at the beginning of a deque.
Definition: cxdeque.c:1203