blob: 76c189e5baf3779486db35c2c85ec23a70242d33 (
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
|
# STC [cqueue](../include/stc/cqueue.h): Queue
The **cqueue** is container that gives the programmer the functionality of a queue - specifically, a FIFO (first-in, first-out) data structure. The queue pushes the elements on the back of the underlying container and pops them from the front.
See the c++ class [std::queue](https://en.cppreference.com/w/cpp/container/queue) for a functional reference.
## Header file and declaration
```c
#define i_val // value: REQUIRED
#define i_cmp // three-way compare two i_valraw* : REQUIRED IF i_valraw is a non-integral type
#define i_del // destroy value func - defaults to empty destruct
#define i_valraw // convertion "raw" type - defaults to i_val
#define i_valfrom // convertion func i_valraw => i_val - defaults to plain copy
#define i_valto // convertion func i_val* => i_valraw - defaults to plain copy
#define i_tag // defaults to i_val
#include <stc/cqueue.h>
```
`X` should be replaced by the value of `i_tag` in all of the following documentation.
## Methods
```c
cqueue_X cqueue_X_init(void);
cqueue_X cqueue_X_clone(cqueue_X q);
void cqueue_X_clear(cqueue_X* self);
void cqueue_X_copy(cqueue_X* self, cqueue_X other);
void cqueue_X_del(cqueue_X* self); // destructor
size_t cqueue_X_size(cqueue_X q);
bool cqueue_X_empty(cqueue_X q);
cqueue_X_value_t* cqueue_X_front(const cqueue_X* self);
cqueue_X_value_t* cqueue_X_back(const cqueue_X* self);
void cqueue_X_push(cqueue_X* self, cqueue_X_value_t value);
void cqueue_X_emplace(cqueue_X* self, cqueue_X_rawvalue_t raw);
void cqueue_X_pop(cqueue_X* self);
cqueue_X_iter_t cqueue_X_begin(const cqueue_X* self);
cqueue_X_iter_t cqueue_X_end(const cqueue_X* self);
void cqueue_X_next(cqueue_X_iter_t* it);
cqueue_X_value_t cqueue_X_value_clone(cqueue_X_value_t val);
```
## Types
| Type name | Type definition | Used to represent... |
|:----------------------|:---------------------------------------|:-------------------------|
| `cqueue_X` | Same as `cdeq_X` type | The cqueue type |
| `cqueue_X_value_t` | " | The cqueue element type |
| `cqueue_X_rawvalue_t` | " | cqueue raw value type |
| `cqueue_X_iter_t` | " | cqueue iterator |
## Examples
```c
#define i_val int
#define i_tag i
#include <stc/cqueue.h>
#include <stdio.h>
int main() {
cqueue_i Q = cqueue_i_init();
// push() and pop() a few.
c_forrange (i, 20)
cqueue_i_push(&Q, i);
c_forrange (5)
cqueue_i_pop(&Q);
c_foreach (i, cqueue_i, Q)
printf(" %d", *i.ref);
cqueue_i_del(&Q);
}
```
Output:
```
5 6 7 8 9 10 11 12 13 14 15 16 17 18 19
```
|
