From 778deca2627b3ec3226fb1ad4e73079f89d27708 Mon Sep 17 00:00:00 2001 From: Tyge Løvset <60263450+tylov@users.noreply.github.com> Date: Fri, 1 Jan 2021 12:52:23 +0100 Subject: Update cvec_api.md --- docs/cvec_api.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) 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 @@ ![Vector](vector.jpg) # 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 +``` -- cgit v1.2.3 From a41b75f1f9c92a6e3844baa3a4f213fd1da9c60d Mon Sep 17 00:00:00 2001 From: Tyge Løvset <60263450+tylov@users.noreply.github.com> Date: Fri, 1 Jan 2021 12:54:58 +0100 Subject: Update cdeq_api.md --- docs/cdeq_api.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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 @@ ![Deque](deque.jpg) # 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 -- cgit v1.2.3 From 45a3a814308ed963b186073f91a9529303c6bb0d Mon Sep 17 00:00:00 2001 From: Tyge Løvset <60263450+tylov@users.noreply.github.com> Date: Fri, 1 Jan 2021 13:00:30 +0100 Subject: Update cmap_api.md --- docs/cmap_api.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) 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 -- cgit v1.2.3