diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/carray_api.md | 2 | ||||
| -rw-r--r-- | docs/cbitset_api.md | 2 | ||||
| -rw-r--r-- | docs/ccommon_api.md | 2 | ||||
| -rw-r--r-- | docs/cdeq_api.md | 4 | ||||
| -rw-r--r-- | docs/clist_api.md | 2 | ||||
| -rw-r--r-- | docs/cmap_api.md | 2 | ||||
| -rw-r--r-- | docs/copt_api.md | 2 | ||||
| -rw-r--r-- | docs/cpque_api.md | 2 | ||||
| -rw-r--r-- | docs/cptr_api.md | 2 | ||||
| -rw-r--r-- | docs/cqueue_api.md | 2 | ||||
| -rw-r--r-- | docs/crand_api.md | 2 | ||||
| -rw-r--r-- | docs/cset_api.md | 2 | ||||
| -rw-r--r-- | docs/cstack_api.md | 2 | ||||
| -rw-r--r-- | docs/cstr_api.md | 2 | ||||
| -rw-r--r-- | docs/cvec_api.md | 2 |
15 files changed, 16 insertions, 16 deletions
diff --git a/docs/carray_api.md b/docs/carray_api.md index f9389b0e..de679c97 100644 --- a/docs/carray_api.md +++ b/docs/carray_api.md @@ -1,5 +1,5 @@ +# STC Container [carray](../stc/carray.h): Dynamic 1/2/3 Dimensional Array  -# Container [carray](../stc/carray.h): Dynamic 1/2/3 Dimensional Array This is 1D, 2D and 3D arrays, which are allocated from heap in one single contiguous block of memory. *carray3* may have sub-array "views" of *carray2* and *carray1* etc. diff --git a/docs/cbitset_api.md b/docs/cbitset_api.md index 7ea78381..dde8f68e 100644 --- a/docs/cbitset_api.md +++ b/docs/cbitset_api.md @@ -1,4 +1,4 @@ -# Container [cbitset](../stc/cbitset.h): Bitset +# STC Container [cbitset](../stc/cbitset.h): Bitset  This describes the API of type **cbitset**. See [std::bitset](https://en.cppreference.com/w/cpp/utility/bitset) or diff --git a/docs/ccommon_api.md b/docs/ccommon_api.md index 9c301e93..b6f0b83c 100644 --- a/docs/ccommon_api.md +++ b/docs/ccommon_api.md @@ -1,4 +1,4 @@ -# Module [ccommon](../stc/ccommon.h): Common methods and definitions +# STC Module [ccommon](../stc/ccommon.h): Common methods and definitions This describes the features the ccommon.h header file. diff --git a/docs/cdeq_api.md b/docs/cdeq_api.md index 12c2ffaf..506e93bd 100644 --- a/docs/cdeq_api.md +++ b/docs/cdeq_api.md @@ -1,8 +1,8 @@ +# STC Container [cdeq](../stc/cdeq.h): Double Ended Queue (Deque)  -# Container [cdeq](../stc/cdeq.h): Double Ended Queue (Deque) 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. +See [std::deque](https://en.cppreference.com/w/cpp/container/deque) for a similar c++ class. ## Declaration diff --git a/docs/clist_api.md b/docs/clist_api.md index 437b0321..361d82ff 100644 --- a/docs/clist_api.md +++ b/docs/clist_api.md @@ -1,5 +1,5 @@ +# STC Container [clist](../stc/clist.h): Forward List  -# Container [clist](../stc/clist.h): Forward List This is similar to c++ [std::forward_list](https://en.cppreference.com/w/cpp/container/forward_list), but supports both *push_front()* and *push_back()* as well as *pop_front()* in **O**(1) time. Implemented as a circular singly linked list. diff --git a/docs/cmap_api.md b/docs/cmap_api.md index da31237b..f4ef9172 100644 --- a/docs/cmap_api.md +++ b/docs/cmap_api.md @@ -1,5 +1,5 @@ +# STC Container [cmap](../stc/cmap.h): Unordered Map  -# Container [cmap](../stc/cmap.h): Unordered Map 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. diff --git a/docs/copt_api.md b/docs/copt_api.md index 1973cec5..79a35c37 100644 --- a/docs/copt_api.md +++ b/docs/copt_api.md @@ -1,4 +1,4 @@ -# Module [copt](../stc/copt.h): Command line argument parsing +# STC Module [copt](../stc/copt.h): Command line argument parsing This describes the API of string type *copt_get()* function for command line argument parsing. See [getopt_long](https://www.freebsd.org/cgi/man.cgi?getopt_long(3)) for a similar freebsd function. diff --git a/docs/cpque_api.md b/docs/cpque_api.md index 9fc0c7e1..c824e9f1 100644 --- a/docs/cpque_api.md +++ b/docs/cpque_api.md @@ -1,4 +1,4 @@ -# Container [cpque](../stc/cpque.h): Priority Queue +# STC Container [cpque](../stc/cpque.h): Priority Queue This describes the API of the priority queue type **cpque**. Implemented as a heap. See [std::priority_queue](https://en.cppreference.com/w/cpp/container/priority_queue) for a similar c++ class. diff --git a/docs/cptr_api.md b/docs/cptr_api.md index 25ef18db..9f40413c 100644 --- a/docs/cptr_api.md +++ b/docs/cptr_api.md @@ -1,4 +1,4 @@ -# Module [cptr](../stc/cptr.h): Smart Pointers +# STC Module [cptr](../stc/cptr.h): Smart Pointers This module simplifies management of pointers in containers. The **csptr** type is similar to a c++ [std::shared_ptr](https://en.cppreference.com/w/cpp/memory/shared_ptr). diff --git a/docs/cqueue_api.md b/docs/cqueue_api.md index 3a3da26b..721b2069 100644 --- a/docs/cqueue_api.md +++ b/docs/cqueue_api.md @@ -1,5 +1,5 @@ +# STC Container [cqueue](../stc/cqueue.h): Queue  -# Container [cqueue](../stc/cqueue.h): Queue This describes the API of the queue type **cqueue**. See [std::queue](https://en.cppreference.com/w/cpp/container/queue) for a similar c++ class. diff --git a/docs/crand_api.md b/docs/crand_api.md index 4678cbd3..979c263f 100644 --- a/docs/crand_api.md +++ b/docs/crand_api.md @@ -1,4 +1,4 @@ -# Module [crand](../stc/crand.h): Pseudo Random Number Generators +# STC Module [crand](../stc/crand.h): Pseudo Random Number Generators This describes the API of module **crand**. It contains **stc64**, a *64-bit PRNG*, and can generate bounded uniform and normal distributed random numbers. See [random](https://en.cppreference.com/w/cpp/header/random) diff --git a/docs/cset_api.md b/docs/cset_api.md index 995cc95a..f8d33e2b 100644 --- a/docs/cset_api.md +++ b/docs/cset_api.md @@ -1,5 +1,5 @@ +# STC Container [cset](../stc/cmap.h): Unordered Set
-# Container [cset](../stc/cmap.h): Unordered Set
A **cset** is an associative container that contains a set of unique objects of type Key. Search, insertion, and removal have average constant-time complexity. See [std::unordered_set](https://en.cppreference.com/w/cpp/container/unordered_set) for a similar c++ class.
diff --git a/docs/cstack_api.md b/docs/cstack_api.md index 7d75ecdf..6da14d1e 100644 --- a/docs/cstack_api.md +++ b/docs/cstack_api.md @@ -1,5 +1,5 @@ +# STC Container [cstack](../stc/cstack.h): Stack  -# Container [cstack](../stc/cstack.h): Stack This describes the API of the stack type **cstack**. See [std::stack](https://en.cppreference.com/w/cpp/container/stack) for a similar c++ class. diff --git a/docs/cstr_api.md b/docs/cstr_api.md index 4ea5de64..97cc0e4b 100644 --- a/docs/cstr_api.md +++ b/docs/cstr_api.md @@ -1,5 +1,5 @@ +# STC Container [cstr](../stc/cstr.h): String  -# Container [cstr](../stc/cstr.h): String This describes the API of string type **cstr_t**. See [std::basic_string](https://en.cppreference.com/w/cpp/string/basic_string) for a similar c++ class. diff --git a/docs/cvec_api.md b/docs/cvec_api.md index 054aa8b9..6e2ea713 100644 --- a/docs/cvec_api.md +++ b/docs/cvec_api.md @@ -1,5 +1,5 @@ +# STC Container [cvec](../stc/cvec.h): Vector  -# Container [cvec](../stc/cvec.h): Vector 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. |