diff options
| author | Tyge Løvset <[email protected]> | 2020-12-03 11:49:40 +0100 |
|---|---|---|
| committer | Tyge Løvset <[email protected]> | 2020-12-03 11:49:40 +0100 |
| commit | 1523925450d7385e19144be2ed616ee8dc7d1c27 (patch) | |
| tree | 8801321b552dea396a4dbbdc4c59fff16cb55af1 /docs/cpqueue_api.md | |
| parent | 0583a9cf43ed7f771e6ade5cadb9743b0b4b6c11 (diff) | |
| download | STC-modified-1523925450d7385e19144be2ed616ee8dc7d1c27.tar.gz STC-modified-1523925450d7385e19144be2ed616ee8dc7d1c27.zip | |
Even more docs fixes.
Diffstat (limited to 'docs/cpqueue_api.md')
| -rw-r--r-- | docs/cpqueue_api.md | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/docs/cpqueue_api.md b/docs/cpqueue_api.md index 1927b513..2cdd7eca 100644 --- a/docs/cpqueue_api.md +++ b/docs/cpqueue_api.md @@ -1,4 +1,4 @@ -# Container type cpqueue: Priority Queue +# Container cpqueue: Priority Queue This describes the API of the queue type **cpqueue**. Implemented as a heap. @@ -7,7 +7,7 @@ This describes the API of the queue type **cpqueue**. Implemented as a heap. ```c #define using_cpqueue(X, CType, MaxOrMinHeap) ``` -The macro `using_cpqueue()` shall be instantiated in the global scope. +The macro `using_cpqueue()` must be instantiated in the global scope. **cpqueue** uses normally a **cvec** type as undelying implementation, specified as CType. The MaxOrMinHeap argument should be specified as a < or >, representing a max-heap or a min-heap. `X` is a type tag name and will affect the names of all cpqueue types and methods. |