summaryrefslogtreecommitdiffhomepage
path: root/docs
diff options
context:
space:
mode:
authorTyge Løvset <[email protected]>2020-12-03 11:49:40 +0100
committerTyge Løvset <[email protected]>2020-12-03 11:49:40 +0100
commit1523925450d7385e19144be2ed616ee8dc7d1c27 (patch)
tree8801321b552dea396a4dbbdc4c59fff16cb55af1 /docs
parent0583a9cf43ed7f771e6ade5cadb9743b0b4b6c11 (diff)
downloadSTC-modified-1523925450d7385e19144be2ed616ee8dc7d1c27.tar.gz
STC-modified-1523925450d7385e19144be2ed616ee8dc7d1c27.zip
Even more docs fixes.
Diffstat (limited to 'docs')
-rw-r--r--docs/carray_api.md4
-rw-r--r--docs/cbitset_api.md2
-rw-r--r--docs/clist_api.md4
-rw-r--r--docs/cmap_api.md2
-rw-r--r--docs/cpqueue_api.md4
-rw-r--r--docs/cqueue_api.md4
-rw-r--r--docs/cset_api.md2
-rw-r--r--docs/cstack_api.md4
-rw-r--r--docs/cstr_api.md4
-rw-r--r--docs/cvec_api.md2
10 files changed, 15 insertions, 17 deletions
diff --git a/docs/carray_api.md b/docs/carray_api.md
index f70f49b7..809bb2c9 100644
--- a/docs/carray_api.md
+++ b/docs/carray_api.md
@@ -1,4 +1,4 @@
-# Container type carray: Dynamic 1/2/3 Dimensional Array
+# Container carray: 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.
@@ -27,11 +27,9 @@ be replaced by `my` in all of the following documentation. The `#` character sho
|:---------------------|:-------------------------|
| `carray1_size(arr)` | carray1 size and dim |
| `carray1_xdim(arr)` | |
-| | |
| `carray2_size(arr)` | carray2 size and dims |
| `carray2_xdim(arr)` | |
| `carray2_ydim(arr)` | |
-| | |
| `carray3_size(arr)` | carray3 size and dims |
| `carray3_xdim(arr)` | |
| `carray3_ydim(arr)` | |
diff --git a/docs/cbitset_api.md b/docs/cbitset_api.md
index 9d12abc9..f6878bea 100644
--- a/docs/cbitset_api.md
+++ b/docs/cbitset_api.md
@@ -1,4 +1,4 @@
-# Container type cbitset_t: Indexed Set of Boolean Values (Bits)
+# Container cbitset_t: Indexed Bitset
This describes the API of type **cbitset**.
diff --git a/docs/clist_api.md b/docs/clist_api.md
index 9d2453d7..7073e459 100644
--- a/docs/clist_api.md
+++ b/docs/clist_api.md
@@ -1,7 +1,7 @@
-# Container type clist: Circular Singly Linked List
+# Container clist: Singly Linked List
This is similar to c++ *std::forward_list*, but can do both *push_front()* and *push_back()* as well as *pop_front()*.
-Also supports various *splice* functions and *merge sort*.
+Implemented as a circular singly linked list. Also supports various *splice* functions and *merge sort*.
## Declaration
diff --git a/docs/cmap_api.md b/docs/cmap_api.md
index 585f1e35..71e93514 100644
--- a/docs/cmap_api.md
+++ b/docs/cmap_api.md
@@ -1,4 +1,4 @@
-# Container type cmap: Unordered Map
+# Container cmap: Unordered Map
Elements are pairs of keys and mapped values. Implemented as open hashing without tombstones. Highly customizable and fast.
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.
diff --git a/docs/cqueue_api.md b/docs/cqueue_api.md
index db8bd901..deab08f6 100644
--- a/docs/cqueue_api.md
+++ b/docs/cqueue_api.md
@@ -1,4 +1,4 @@
-# Container type cqueue: Queue
+# Container cqueue: Queue
This describes the API of the queue type **cqueue**.
@@ -7,7 +7,7 @@ This describes the API of the queue type **cqueue**.
```c
#define using_cqueue(X, CType)
```
-The macro `using_cqueue()` shall be instantiated in the global scope.
+The macro `using_cqueue()` must be instantiated in the global scope.
**cqueue** uses normally a **clist** type as underlying implementation, given as CType.
Default values are given above for args not specified. `X` is a type tag name and
will affect the names of all cqueue types and methods. E.g. declaring `using_cqueue(my, clist_my);`,
diff --git a/docs/cset_api.md b/docs/cset_api.md
index 6a4cb581..94dff33a 100644
--- a/docs/cset_api.md
+++ b/docs/cset_api.md
@@ -1,4 +1,4 @@
-# Container type cset: Unordered Set
+# Container cset: Unordered Set
This describes the API of the unordered set type **cset**.
Same base implementation as cmap, but contains and uses keys only.
diff --git a/docs/cstack_api.md b/docs/cstack_api.md
index d6a0ae35..a442b30d 100644
--- a/docs/cstack_api.md
+++ b/docs/cstack_api.md
@@ -1,4 +1,4 @@
-# Container type cstack: Stack
+# Container cstack: Stack
This describes the API of the queue type **cstack**.
@@ -7,7 +7,7 @@ This describes the API of the queue type **cstack**.
```c
#define using_cstack(X, CType)
```
-The macro `using_cstack()` shall be instantiated in the global scope.
+The macro `using_cstack()` must be instantiated in the global scope.
**cstack** uses normally a **cvec** type as underlying implementation, given as CType.
Default values are given above for args not specified. `X` is a type tag name and
will affect the names of all cstack types and methods. E.g. declaring `using_cstack(my, cvec_my);`,
diff --git a/docs/cstr_api.md b/docs/cstr_api.md
index 20c0d0fc..3860ced2 100644
--- a/docs/cstr_api.md
+++ b/docs/cstr_api.md
@@ -1,4 +1,4 @@
-# Container type cstr_t: String
+# Container cstr_t: String
This describes the API of string type **cstr_t**.
@@ -13,7 +13,7 @@ This describes the API of string type **cstr_t**.
## Constants and macros
| Name | Value |
-|:---------------- -|:-----------------|
+|:------------------|:-----------------|
| `cstr_inits` | `{...}` |
| `cstr_npos` | `-1ull` |
diff --git a/docs/cvec_api.md b/docs/cvec_api.md
index 0ba81fcd..7b542cb3 100644
--- a/docs/cvec_api.md
+++ b/docs/cvec_api.md
@@ -1,4 +1,4 @@
-# Container type cvec: Vector
+# Container cvec: Vector
This describes the API of vector type **cvec**.