summaryrefslogtreecommitdiffhomepage
path: root/docs/cpque_api.md
diff options
context:
space:
mode:
authorTyge Løvset <[email protected]>2020-12-18 19:39:18 +0100
committerTyge Løvset <[email protected]>2020-12-18 19:39:18 +0100
commit8aebb68c0cb853c2dc2792dd8ef65bd448c82414 (patch)
tree50c6e4c8f2e58c46a2dc937beb593323e8280293 /docs/cpque_api.md
parent512086cdf69bbfadd794fb5e751fb681222a4adf (diff)
downloadSTC-modified-8aebb68c0cb853c2dc2792dd8ef65bd448c82414.tar.gz
STC-modified-8aebb68c0cb853c2dc2792dd8ef65bd448c82414.zip
Added cdeq.h: Deque: Double Ended Queue. Fixed bug in cvec_X_push_n().
Diffstat (limited to 'docs/cpque_api.md')
-rw-r--r--docs/cpque_api.md16
1 files changed, 8 insertions, 8 deletions
diff --git a/docs/cpque_api.md b/docs/cpque_api.md
index 92b84a27..cd6b8a9e 100644
--- a/docs/cpque_api.md
+++ b/docs/cpque_api.md
@@ -16,12 +16,12 @@ Declaring `using_cpque(my, cvec_my, >);`, `X` should be replaced by `my` in the
## Types
-| Type name | Type definition | Used to represent... |
-|:-----------------------|:----------------------------------------|:--------------------------|
+| Type name | Type definition | Used to represent... |
+|:---------------------|:--------------------------------------|:------------------------|
| `cpque_X` | `struct {cpque_X_value_t* data; ...}` | The cpque type |
-| `cpque_X_value_t` | Depends on underlying container type | The cpque element type |
-| `cpque_X_input_t` | " | cpque input type |
-| `cpque_X_rawvalue_t` | " | cpque raw value type |
+| `cpque_X_value_t` | Depends on underlying container type | The cpque element type |
+| `cpque_X_input_t` | " | cpque input type |
+| `cpque_X_rawvalue_t` | " | cpque raw value type |
## Header file
@@ -34,15 +34,15 @@ All cpque definitions and prototypes may be included in your C source file by in
## Methods
```c
-cpque_X cpque_X_init(void);
-cpque_X cpque_X_clone(cpque_X pq);
+cpque_X cpque_X_init(void);
+cpque_X cpque_X_clone(cpque_X pq);
void cpque_X_make_heap(cpque_X* self);
void cpque_X_del(cpque_X* self);
size_t cpque_X_size(cpque_X pq);
bool cpque_X_empty(cpque_X pq);
const
-cpque_X_value_t* cpque_X_top(const cpque_X* self);
+cpque_X_value_t* cpque_X_top(const cpque_X* self);
void cpque_X_push_n(cpque_X *self, const cpque_X_input_t arr[], size_t size);
void cpque_X_emplace(cpque_X* self, cpque_X_rawvalue_t raw);