summaryrefslogtreecommitdiffhomepage
path: root/docs/cpqueue_api.md
diff options
context:
space:
mode:
authorTyge Løvset <[email protected]>2020-12-03 20:56:26 +0100
committerTyge Løvset <[email protected]>2020-12-03 20:56:26 +0100
commit3b3f4493618b3aa5edb99c91e0ff0ea95fdb372e (patch)
treefa1584e0023fc553b17511bf4b186ba388939be6 /docs/cpqueue_api.md
parent870a601a62c804f9d15efe5856cc6018b076dfe6 (diff)
downloadSTC-modified-3b3f4493618b3aa5edb99c91e0ff0ea95fdb372e.tar.gz
STC-modified-3b3f4493618b3aa5edb99c91e0ff0ea95fdb372e.zip
More docs descriptions.
Diffstat (limited to 'docs/cpqueue_api.md')
-rw-r--r--docs/cpqueue_api.md6
1 files changed, 3 insertions, 3 deletions
diff --git a/docs/cpqueue_api.md b/docs/cpqueue_api.md
index 24e88fc9..76fba64f 100644
--- a/docs/cpqueue_api.md
+++ b/docs/cpqueue_api.md
@@ -9,7 +9,7 @@ This describes the API of the queue type **cpqueue**. Implemented as a heap.
```
The macro `using_cpqueue()` must be instantiated in the global scope.
**cpqueue** uses normally a **cvec** type as underlying implementation, specified as `ctype`.
-The `heap_variant` argument should be given as `<` or `>`, specifying a *max-heap* or a *min-heap*.
+The `heap_variant` must be given as `<` or `>`, specifying *max-heap* or *min-heap* for the priority queue.
Note that the function `{ctype}_value_compare(x, y)` defined by the underlying vector type is used to
compare values (priorities). `X` is a type tag name and will affect the names of all cpqueue types and methods.
Declaring `using_cpqueue(my, cvec_my, >);`, `X` should be replaced by `my` in the following documentation.
@@ -43,11 +43,11 @@ bool cpqueue_X_empty(cpqueue_X pq);
const
cpqueue_X_value_t* cpqueue_X_top(const cpqueue_X* self);
-void cpqueue_X_push_n(cpqueue_X *self, const cpqueue_X_input_t in[], size_t size);
+void cpqueue_X_push_n(cpqueue_X *self, const cpqueue_X_input_t arr[], size_t size);
void cpqueue_X_emplace(cpqueue_X* self, cpqueue_X_rawvalue_t raw);
void cpqueue_X_push(cpqueue_X* self, cpqueue_X_value_t value);
void cpqueue_X_pop(cpqueue_X* self);
-void cpqueue_X_erase_at(cpqueue_X* self, size_t i);
+void cpqueue_X_erase_at(cpqueue_X* self, size_t idx);
```
## Example