summaryrefslogtreecommitdiffhomepage
path: root/docs/cpque_api.md
diff options
context:
space:
mode:
authorTyge Løvset <[email protected]>2021-09-19 14:54:15 +0200
committerTyge Løvset <[email protected]>2021-09-19 14:54:15 +0200
commit0a3fe6211933a8be6ec71ff82a3077da7012e667 (patch)
tree16794698ffac9c3e746b0a02078a4ed7afdf580c /docs/cpque_api.md
parent677e3d855e1d35ae5bf12609e86785a01ce2f4cc (diff)
downloadSTC-modified-0a3fe6211933a8be6ec71ff82a3077da7012e667.tar.gz
STC-modified-0a3fe6211933a8be6ec71ff82a3077da7012e667.zip
Replaced the two csptr doc examples with a better one. Same as sharedptr.c in examples.
Diffstat (limited to 'docs/cpque_api.md')
-rw-r--r--docs/cpque_api.md4
1 files changed, 2 insertions, 2 deletions
diff --git a/docs/cpque_api.md b/docs/cpque_api.md
index 343215bf..3b3338e8 100644
--- a/docs/cpque_api.md
+++ b/docs/cpque_api.md
@@ -1,7 +1,7 @@
# STC [cpque](../include/stc/cpque.h): Priority Queue
A priority queue is a container adaptor that provides constant time lookup of the largest (by default) element, at the expense of logarithmic insertion and extraction.
-A user-provided argument `<`or `>` must be supplied to set the ordering, e.g. using `>` would cause the smallest element to appear as the top().
+A user-provided ***i_cmp*** may be defined to set the ordering, e.g. using ***-c_default_cmp*** would cause the smallest element to appear as the top() value.
See the c++ class [std::priority_queue](https://en.cppreference.com/w/cpp/container/priority_queue) for a functional reference.
@@ -17,7 +17,7 @@ See the c++ class [std::priority_queue](https://en.cppreference.com/w/cpp/contai
#define i_valdel // destroy value func - defaults to empty destruct
#include <stc/cpque.h>
```
-`X` should be replaced by the value of i_tag in all of the following documentation.
+`X` should be replaced by the value of ***i_tag*** in all of the following documentation.
## Methods