diff options
| author | Tyge Løvset <[email protected]> | 2021-01-01 13:05:04 +0100 |
|---|---|---|
| committer | Tyge Løvset <[email protected]> | 2021-01-01 13:05:04 +0100 |
| commit | 4813accd04b4b3fd61e80a462d1643f6316a216b (patch) | |
| tree | e1b5d06056581b2b1b74498c14fec51dcbd97733 /docs | |
| parent | d8afec0f4115212e033a0c0a6ef0a822612f10c0 (diff) | |
| parent | 45a3a814308ed963b186073f91a9529303c6bb0d (diff) | |
| download | STC-modified-4813accd04b4b3fd61e80a462d1643f6316a216b.tar.gz STC-modified-4813accd04b4b3fd61e80a462d1643f6316a216b.zip | |
Merge branch 'master' of https://github.com/tylo-work/C99Containers into master
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/cdeq_api.md | 2 | ||||
| -rw-r--r-- | docs/cmap_api.md | 3 | ||||
| -rw-r--r-- | docs/cvec_api.md | 4 |
3 files changed, 5 insertions, 4 deletions
diff --git a/docs/cdeq_api.md b/docs/cdeq_api.md index 55cb0085..eebdd155 100644 --- a/docs/cdeq_api.md +++ b/docs/cdeq_api.md @@ -1,7 +1,7 @@  # Container [cdeq](../stc/cdeq.h): Double Ended Queue (Deque) -This describes the API of deque type **cdeq**. +A **cdeq** is an indexed sequence container that allows fast insertion and deletion at both its beginning and its end. See [std::deque](https://en.cppreference.com/w/cpp/container/deque) for corresponding c++ documentation. ## Declaration diff --git a/docs/cmap_api.md b/docs/cmap_api.md index 85569e63..74ad7e55 100644 --- a/docs/cmap_api.md +++ b/docs/cmap_api.md @@ -1,7 +1,8 @@  # Container [cmap](../stc/cmap.h): Unordered Map -Elements are pairs of keys and mapped values. Implemented as open hashing without tombstones. Highly customizable and fast. +A **cmap** is an associative container that contains key-value pairs with unique keys. Search, insertion, and removal of elements have average constant-time complexity. +Elements are pairs of keys and mapped values. Implemented as open hashing with linear probing and without storing tombstones. Very fast, see performance comparisons. See [std::unordered_map](https://en.cppreference.com/w/cpp/container/unordered_map) for a similar c++ class. ## Declaration diff --git a/docs/cvec_api.md b/docs/cvec_api.md index 4ff841d6..d3b1aff7 100644 --- a/docs/cvec_api.md +++ b/docs/cvec_api.md @@ -1,7 +1,7 @@  # Container [cvec](../stc/cvec.h): Vector -This describes the API of vector type **cvec**. +A **cvec** is a sequence container that encapsulates dynamic size arrays. See [std::vector](https://en.cppreference.com/w/cpp/container/vector) for a similar c++ class. ## Declaration @@ -175,4 +175,4 @@ Jake item: Mary item: Jake item: 2 elements so far -```
\ No newline at end of file +``` |