C Standard Library Extensions  1.2.0
cxdeque.h
1 /* $Id: cxdeque.h,v 1.3 2011-02-21 14:15:31 rpalsa Exp $
2  *
3  * This file is part of the ESO C Extension Library
4  * Copyright (C) 2001-2011 European Southern Observatory
5  *
6  * This program is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
19  */
20 
21 /*
22  * $Author: rpalsa $
23  * $Date: 2011-02-21 14:15:31 $
24  * $Revision: 1.3 $
25  * $Name: not supported by cvs2svn $
26  */
27 
28 #ifndef CX_DEQUE_H
29 #define CX_DEQUE_H
30 
31 #include <cxtypes.h>
32 #include <cxmemory.h>
33 
34 CX_BEGIN_DECLS
35 
36 typedef struct _cx_deque_ cx_deque;
37 
38 typedef cxsize cx_deque_const_iterator;
39 typedef cxsize cx_deque_iterator;
40 
41 
42 /*
43  * Create, copy and destroy operations
44  */
45 
46 cx_deque *cx_deque_new(void);
47 void cx_deque_delete(cx_deque* deque);
48 void cx_deque_destroy(cx_deque *deque, cx_free_func deallocate);
49 
50 /*
51  * Non-modifying operations
52  */
53 
54 cxsize cx_deque_size(const cx_deque *deque);
55 cxbool cx_deque_empty(const cx_deque *deque);
56 cxsize cx_deque_max_size(const cx_deque *deque);
57 
58 /*
59  * Assignment operations
60  */
61 
62 void cx_deque_swap(cx_deque *deque, cx_deque *other);
63 cxptr cx_deque_assign(cx_deque *deque, cx_deque_iterator position, cxptr data);
64 
65 /*
66  * Element access
67  */
68 
69 cxptr cx_deque_front(const cx_deque *deque);
70 cxptr cx_deque_back(const cx_deque *deque);
71 cxptr cx_deque_get(const cx_deque *deque, cx_deque_const_iterator position);
72 
73 /*
74  * Iterator functions
75  */
76 
77 cx_deque_iterator cx_deque_begin(const cx_deque *deque);
78 cx_deque_iterator cx_deque_end(const cx_deque *deque);
79 cx_deque_iterator cx_deque_next(const cx_deque *deque,
80  cx_deque_const_iterator position);
81 cx_deque_iterator cx_deque_previous(const cx_deque *deque,
82  cx_deque_const_iterator position);
83 
84 /*
85  * Inserting and removing elements
86  */
87 
88 void cx_deque_push_front(cx_deque *deque, cxcptr data);
89 cxptr cx_deque_pop_front(cx_deque *deque);
90 void cx_deque_push_back(cx_deque *deque, cxcptr data);
91 cxptr cx_deque_pop_back(cx_deque *deque);
92 
93 cx_deque_iterator cx_deque_insert(cx_deque *deque, cx_deque_iterator position,
94  cxcptr data);
95 cx_deque_iterator cx_deque_erase(cx_deque *deque, cx_deque_iterator position,
96  cx_free_func deallocate);
97 void cx_deque_clear(cx_deque *deque);
98 
99 
100 /*
101  * Extra deque interfaces
102  */
103 
104 /*
105  * Removing elements
106  */
107 
108 cxptr cx_deque_extract(cx_deque *deque, cx_deque_iterator position);
109 void cx_deque_remove(cx_deque *deque, cxcptr data);
110 
111 /*
112  * Splice functions
113  */
114 
115 void cx_deque_unique(cx_deque *deque, cx_compare_func compare);
116 void cx_deque_splice(cx_deque *deque, cx_deque_iterator position,
117  cx_deque *other, cx_deque_iterator start,
118  cx_deque_iterator end);
119 void cx_deque_merge(cx_deque *deque, cx_deque *other, cx_compare_func compare);
120 void cx_deque_sort(cx_deque *deque, cx_compare_func compare);
121 void cx_deque_reverse(cx_deque *deque);
122 
123 CX_END_DECLS
124 
125 #endif /* CX_DEQUE_H */
void cx_deque_remove(cx_deque *deque, cxcptr data)
Remove all elements with a given value from a deque.
Definition: cxdeque.c:1470
cxsize cx_deque_max_size(const cx_deque *deque)
Get the maximum number of deque elements possible.
Definition: cxdeque.c:925
void cx_deque_unique(cx_deque *deque, cx_compare_func compare)
Remove duplicates of consecutive elements.
Definition: cxdeque.c:1515
cx_deque_iterator cx_deque_erase(cx_deque *deque, cx_deque_iterator position, cx_free_func deallocate)
Erase a deque element.
Definition: cxdeque.c:1379
cxptr cx_deque_extract(cx_deque *deque, cx_deque_iterator position)
Extract a deque element.
Definition: cxdeque.c:1443
cxsize cx_deque_size(const cx_deque *deque)
Get the actual number of deque elements.
Definition: cxdeque.c:881
cxptr cx_deque_pop_back(cx_deque *deque)
Remove the last deque element.
Definition: cxdeque.c:1305
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:1653
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:1146
cx_deque * cx_deque_new(void)
Create a new deque without any elements.
Definition: cxdeque.c:791
void cx_deque_merge(cx_deque *deque, cx_deque *other, cx_compare_func compare)
Merge two sorted deques.
Definition: cxdeque.c:1621
void cx_deque_push_front(cx_deque *deque, cxcptr data)
Insert data at the beginning of a deque.
Definition: cxdeque.c:1199
cxptr cx_deque_get(const cx_deque *deque, cx_deque_const_iterator position)
Retrieve an element from a deque.
Definition: cxdeque.c:1071
cxptr cx_deque_assign(cx_deque *deque, cx_deque_iterator position, cxptr data)
Assign data to a deque element.
Definition: cxdeque.c:992
void cx_deque_destroy(cx_deque *deque, cx_free_func deallocate)
Destroy a deque and all its elements.
Definition: cxdeque.c:843
void cx_deque_push_back(cx_deque *deque, cxcptr data)
Append data at the end of a deque.
Definition: cxdeque.c:1264
void cx_deque_delete(cx_deque *deque)
Destroy a deque.
Definition: cxdeque.c:815
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:1335
cx_deque_iterator cx_deque_end(const cx_deque *deque)
Get an iterator for the position after the last deque element.
Definition: cxdeque.c:1121
cxptr cx_deque_front(const cx_deque *deque)
Get the first element of a deque.
Definition: cxdeque.c:1022
cxptr cx_deque_pop_front(cx_deque *deque)
Remove the first deque element.
Definition: cxdeque.c:1234
cxbool cx_deque_empty(const cx_deque *deque)
Check whether a deque is empty.
Definition: cxdeque.c:903
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:1568
cx_deque_iterator cx_deque_begin(const cx_deque *deque)
Get an iterator for the first deque element.
Definition: cxdeque.c:1098
cxptr cx_deque_back(const cx_deque *deque)
Get the last element of a deque.
Definition: cxdeque.c:1046
void cx_deque_clear(cx_deque *deque)
Remove all elements from a deque.
Definition: cxdeque.c:1418
void cx_deque_reverse(cx_deque *deque)
Reverse the order of all deque elements.
Definition: cxdeque.c:1677
void cx_deque_swap(cx_deque *deque, cx_deque *other)
Swap the data of two deques.
Definition: cxdeque.c:949
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:1171