summaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorTyge Løvset <[email protected]>2021-01-01 13:00:30 +0100
committerGitHub <[email protected]>2021-01-01 13:00:30 +0100
commit45a3a814308ed963b186073f91a9529303c6bb0d (patch)
treed17f8489dcf95da09f036f76540f4b9ac8860b95
parenta41b75f1f9c92a6e3844baa3a4f213fd1da9c60d (diff)
downloadSTC-modified-45a3a814308ed963b186073f91a9529303c6bb0d.tar.gz
STC-modified-45a3a814308ed963b186073f91a9529303c6bb0d.zip
Update cmap_api.md
-rw-r--r--docs/cmap_api.md3
1 files changed, 2 insertions, 1 deletions
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 @@
![Map](map.jpg)
# 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