summaryrefslogtreecommitdiffhomepage
path: root/docs
diff options
context:
space:
mode:
authorTyge Løvset <[email protected]>2021-09-21 09:56:57 +0200
committerTyge Løvset <[email protected]>2021-09-21 09:56:57 +0200
commitb31765540d40675665d8a58f5fa4d1e23dd5ba64 (patch)
treea164d33d40a53a36605362c05ad0f84098a6befb /docs
parented62ea868e505d5773d583f4a09c32b13f00c180 (diff)
downloadSTC-modified-b31765540d40675665d8a58f5fa4d1e23dd5ba64.tar.gz
STC-modified-b31765540d40675665d8a58f5fa4d1e23dd5ba64.zip
Fixed input args documentation. Fixed carr2 and carr3 clone functions.
Diffstat (limited to 'docs')
-rw-r--r--docs/carray_api.md13
-rw-r--r--docs/cdeq_api.md4
-rw-r--r--docs/clist_api.md4
-rw-r--r--docs/cmap_api.md12
-rw-r--r--docs/cpque_api.md4
-rw-r--r--docs/cqueue_api.md2
-rw-r--r--docs/cset_api.md8
-rw-r--r--docs/csmap_api.md12
-rw-r--r--docs/csptr_api.md2
-rw-r--r--docs/csset_api.md8
-rw-r--r--docs/cstack_api.md10
-rw-r--r--docs/cvec_api.md4
12 files changed, 42 insertions, 41 deletions
diff --git a/docs/carray_api.md b/docs/carray_api.md
index 0a26f457..ce3a2ded 100644
--- a/docs/carray_api.md
+++ b/docs/carray_api.md
@@ -58,12 +58,13 @@ void carr3_X_next(carr3_X_iter_t* it);
| Type name | Type definition | Used to represent... |
|:------------------|:-----------------------------------------------------|:---------------------|
-| `carr2_X` | `struct { Value **data; size_t xdim, ydim; }` | The array 2D type |
-| `carr2_X_value_t` | `Value` | The value type |
-| `carr2_X_iter_t` | `struct { Value *ref; }` | Iterator type |
-| `carr3_X` | `struct { Value ***data; size_t xdim, ydim, zdim; }` | The array 3D type |
-| `carr3_X_value_t` | `Value` | The value type |
-| `carr3_X_iter_t` | `struct { Value *ref; }` | Iterator type |
+| `carr2_X` | `struct { i_val **data; size_t xdim, ydim; }` | The array 2D type |
+| `carr2_X_value_t` | `i_val` | The value type |
+| `carr2_X_iter_t` | `struct { i_val *ref; }` | Iterator type |
+| | | |
+| `carr3_X` | `struct { i_val ***data; size_t xdim, ydim, zdim; }` | The array 3D type |
+| `carr3_X_value_t` | `i_val` | The value type |
+| `carr3_X_iter_t` | `struct { i_val *ref; }` | Iterator type |
The **carr3** elements can be accessed like `carr3_i arr = ...; int val = arr.data[x][y][z];`, or with `carr3_i_at(&arr, x, y, z)`.
diff --git a/docs/cdeq_api.md b/docs/cdeq_api.md
index 8832b393..de385d8b 100644
--- a/docs/cdeq_api.md
+++ b/docs/cdeq_api.md
@@ -87,8 +87,8 @@ cdeq_X_value_t cdeq_X_value_clone(cdeq_X_value_t val);
| Type name | Type definition | Used to represent... |
|:---------------------|:------------------------------------|:-----------------------|
| `cdeq_X` | `struct { cdeq_X_value_t* data; }` | The cdeq type |
-| `cdeq_X_value_t` | `Value` | The cdeq value type |
-| `cdeq_X_rawvalue_t` | `RawValue` | The raw value type |
+| `cdeq_X_value_t` | `i_val` | The cdeq value type |
+| `cdeq_X_rawvalue_t` | `i_valraw` | The raw value type |
| `cdeq_X_iter_t` | `struct { cdeq_X_value_t* ref; }` | The iterator type |
## Examples
diff --git a/docs/clist_api.md b/docs/clist_api.md
index b4cbced7..343deb48 100644
--- a/docs/clist_api.md
+++ b/docs/clist_api.md
@@ -88,8 +88,8 @@ clist_X_value_t clist_X_value_clone(clist_X_value_t val);
| Type name | Type definition | Used to represent... |
|:----------------------|:------------------------------------|:--------------------------|
| `clist_X` | `struct { clist_X_node_t* last; }` | The clist type |
-| `clist_X_value_t` | `Value` | The clist element type |
-| `clist_X_rawvalue_t` | `RawValue` | clist raw value type |
+| `clist_X_value_t` | `i_val` | The clist element type |
+| `clist_X_rawvalue_t` | `i_valraw` | clist raw value type |
| `clist_X_iter_t` | `struct { clist_value_t *ref; ... }`| clist iterator |
## Example
diff --git a/docs/cmap_api.md b/docs/cmap_api.md
index 0dd19d2c..4b73345c 100644
--- a/docs/cmap_api.md
+++ b/docs/cmap_api.md
@@ -99,12 +99,12 @@ void c_default_del(Type* val); // doe
| Type name | Type definition | Used to represent... |
|:---------------------|:------------------------------------------------|:------------------------------|
| `cmap_X` | `struct { ... }` | The cmap type |
-| `cmap_X_rawkey_t` | `RawKey` | The raw key type |
-| `cmap_X_rawmapped_t` | `RawMapped` | The raw mapped type |
-| `cmap_X_rawvalue_t` | `struct { RawKey first; RawMapped second; }` | RawKey + RawMapped type |
-| `cmap_X_key_t` | `Key` | The key type |
-| `cmap_X_mapped_t` | `Mapped` | The mapped type |
-| `cmap_X_value_t` | `struct { const Key first; Mapped second; }` | The value: key is immutable |
+| `cmap_X_rawkey_t` | `i_keyraw` | The raw key type |
+| `cmap_X_rawmapped_t` | `i_valraw` | The raw mapped type |
+| `cmap_X_rawvalue_t` | `struct { i_keyraw first; i_valraw second; }` | RawKey + RawMapped type |
+| `cmap_X_key_t` | `i_key` | The key type |
+| `cmap_X_mapped_t` | `i_valraw` | The mapped type |
+| `cmap_X_value_t` | `struct { const i_key first; i_val second; }` | The value: key is immutable |
| `cmap_X_result_t` | `struct { cmap_X_value_t *ref; bool inserted; }`| Result of insert/put/emplace |
| `cmap_X_iter_t` | `struct { cmap_X_value_t *ref; ... }` | Iterator type |
diff --git a/docs/cpque_api.md b/docs/cpque_api.md
index 990cc4b7..fd2c334e 100644
--- a/docs/cpque_api.md
+++ b/docs/cpque_api.md
@@ -48,8 +48,8 @@ cpque_X_value_t cpque_X_value_clone(cpque_X_value_t val);
| Type name | Type definition | Used to represent... |
|:---------------------|:--------------------------------------|:------------------------|
| `cpque_X` | `struct {cpque_X_value_t* data; ...}` | The cpque type |
-| `cpque_X_value_t` | Depends on underlying container type | The cpque element type |
-| `cpque_X_rawvalue_t` | " | cpque raw value type |
+| `cpque_X_value_t` | `i_val` | The cpque element type |
+| `cpque_X_rawvalue_t` | `i_valraw` | cpque raw value type |
## Example
```c
diff --git a/docs/cqueue_api.md b/docs/cqueue_api.md
index 3484f5cd..ff2052e0 100644
--- a/docs/cqueue_api.md
+++ b/docs/cqueue_api.md
@@ -50,7 +50,7 @@ cqueue_X_value_t cqueue_X_value_clone(cqueue_X_value_t val);
| Type name | Type definition | Used to represent... |
|:----------------------|:---------------------------------------|:-------------------------|
-| `cqueue_X` | Depends on underlying container type | The cqueue type |
+| `cqueue_X` | Same as `cdeq_X` type | The cqueue type |
| `cqueue_X_value_t` | " | The cqueue element type |
| `cqueue_X_rawvalue_t` | " | cqueue raw value type |
| `cqueue_X_iter_t` | " | cqueue iterator |
diff --git a/docs/cset_api.md b/docs/cset_api.md
index f9a5cfb7..99d7187e 100644
--- a/docs/cset_api.md
+++ b/docs/cset_api.md
@@ -63,10 +63,10 @@ cset_X_value_t cset_X_value_clone(cset_X_value_t val);
| Type name | Type definition | Used to represent... |
|:---------------------|:-------------------------------------------------|:----------------------------|
| `cset_X` | `struct { ... }` | The cset type |
-| `cset_X_rawkey_t` | `RawKey` | The raw key type |
-| `cset_X_rawvalue_t` | `RawKey` | The raw value type |
-| `cset_X_key_t` | `Key` | The key type |
-| `cset_X_value_t` | `const Key` | The value: key is immutable |
+| `cset_X_rawkey_t` | `i_keyraw` | The raw key type |
+| `cset_X_rawvalue_t` | `i_keyraw` | The raw value type |
+| `cset_X_key_t` | `i_key` | The key type |
+| `cset_X_value_t` | `i_key` | The value |
| `cset_X_result_t` | `struct { cset_X_value_t* ref; bool inserted; }` | Result of insert/emplace |
| `cset_X_iter_t` | `struct { cset_X_value_t *ref; ... }` | Iterator type |
diff --git a/docs/csmap_api.md b/docs/csmap_api.md
index 1e41593f..704a1685 100644
--- a/docs/csmap_api.md
+++ b/docs/csmap_api.md
@@ -76,12 +76,12 @@ csmap_X_rawvalue_t csmap_X_value_toraw(csmap_X_value_t* pval);
| Type name | Type definition | Used to represent... |
|:----------------------|:--------------------------------------------------|:-----------------------------|
| `csmap_X` | `struct { ... }` | The csmap type |
-| `csmap_X_rawkey_t` | `RawKey` | The raw key type |
-| `csmap_X_rawmapped_t` | `RawMapped` | The raw mapped type |
-| `csmap_X_rawvalue_t` | `struct { RawKey first; RawMapped second; }` | RawKey+RawMapped type |
-| `csmap_X_key_t` | `Key` | The key type |
-| `csmap_X_mapped_t` | `Mapped` | The mapped type |
-| `csmap_X_value_t` | `struct { const Key first; Mapped second; }` | The value: key is immutable |
+| `csmap_X_rawkey_t` | `i_keyraw` | The raw key type |
+| `csmap_X_rawmapped_t` | `i_valraw` | The raw mapped type |
+| `csmap_X_rawvalue_t` | `struct { i_keyraw first; i_valraw second; }` | RawKey+RawMapped type |
+| `csmap_X_key_t` | `i_key` | The key type |
+| `csmap_X_mapped_t` | `i_val` | The mapped type |
+| `csmap_X_value_t` | `struct { const i_key first; i_val second; }` | The value: key is immutable |
| `csmap_X_result_t` | `struct { csmap_X_value_t *ref; bool inserted; }` | Result of insert/put/emplace |
| `csmap_X_iter_t` | `struct { csmap_X_value_t *ref; ... }` | Iterator type |
diff --git a/docs/csptr_api.md b/docs/csptr_api.md
index 67a67d5c..ef908691 100644
--- a/docs/csptr_api.md
+++ b/docs/csptr_api.md
@@ -59,7 +59,7 @@ bool csptr_X_equals(const csptr_X* x, const csptr_X* y);
|:--------------------|:--------------------------------------------------------------|:-------------------------|
| `csptr_null` | `{NULL, NULL}` | Init nullptr const |
| `csptr_X` | `struct { csptr_X_value_t* get; atomic_count_t* use_count; }` | The csptr type |
-| `csptr_X_value_t` | `Value` | The csptr element type |
+| `csptr_X_value_t` | `i_val` | The csptr element type |
| `atomic_count_t` | `long` | The reference counter |
## Example
diff --git a/docs/csset_api.md b/docs/csset_api.md
index 83774b37..f15d3a25 100644
--- a/docs/csset_api.md
+++ b/docs/csset_api.md
@@ -58,10 +58,10 @@ csset_X_value_t csset_X_value_clone(csset_X_value_t val);
| Type name | Type definition | Used to represent... |
|:---------------------|:--------------------------------------------------|:----------------------------|
| `csset_X` | `struct { ... }` | The csset type |
-| `csset_X_rawkey_t` | `RawKey` | The raw key type |
-| `csset_X_rawvalue_t` | `csset_X_rawkey_t` | The raw key type |
-| `csset_X_key_t` | `Key` | The key type |
-| `csset_X_value_t` | `const Key` | The value: key is immutable |
+| `csset_X_rawkey_t` | `i_rawkey` | The raw key type |
+| `csset_X_rawvalue_t` | `i_rawkey` | The raw key type |
+| `csset_X_key_t` | `i_key` | The key type |
+| `csset_X_value_t` | `i_key ` | The value: key is immutable |
| `csset_X_result_t` | `struct { csset_X_value_t* ref; bool inserted; }` | Result of insert/emplace |
| `csset_X_iter_t` | `struct { csset_X_value_t *ref; ... }` | Iterator type |
diff --git a/docs/cstack_api.md b/docs/cstack_api.md
index 8d9abbc5..7cdfe019 100644
--- a/docs/cstack_api.md
+++ b/docs/cstack_api.md
@@ -1,7 +1,7 @@
# STC [cstack](../include/stc/cstack.h): Stack
![Stack](pics/stack.jpg)
-The **cstack** is a container that gives the programmer the functionality of a stack - specifically, a LIFO (last-in, first-out) data structure. The stack pushes and pops the element from the back of the underlying container, known as the top of the stack.
+The **cstack** is a container that gives the programmer the functionality of a stack - specifically, a LIFO (last-in, first-out) data structure. The stack pushes and pops the element from the back of the container, known as the top of the stack.
See the c++ class [std::stack](https://en.cppreference.com/w/cpp/container/stack) for a functional description.
@@ -49,10 +49,10 @@ cstack_X_value_t cstack_X_value_clone(cstack_X_value_t val);
| Type name | Type definition | Used to represent... |
|:----------------------|:---------------------------------------|:----------------------------|
-| `cstack_X` | Depends on underlying container type | The cstack type |
-| `cstack_X_value_t` | " | The cstack element type |
-| `cstack_X_rawvalue_t` | " | cstack raw value type |
-| `cstack_X_iter_t` | " | cstack iterator |
+| `cstack_X` | `struct { cstack_value_t *data; ... }` | The cstack type |
+| `cstack_X_value_t` | `i_val` | The cstack element type |
+| `cstack_X_rawvalue_t` | `i_valraw` | cstack raw value type |
+| `cstack_X_iter_t` | `struct { cstack_value_t *ref; }` | cstack iterator |
## Example
```c
diff --git a/docs/cvec_api.md b/docs/cvec_api.md
index 64a7df2c..3e42b704 100644
--- a/docs/cvec_api.md
+++ b/docs/cvec_api.md
@@ -90,8 +90,8 @@ cvec_X_value_t cvec_X_value_clone(cvec_X_value_t val);
| Type name | Type definition | Used to represent... |
|:---------------------|:------------------------------------|:-----------------------|
| `cvec_X` | `struct { cvec_X_value_t* data; }` | The cvec type |
-| `cvec_X_value_t` | `Value` | The cvec value type |
-| `cvec_X_rawvalue_t` | `RawValue` | The raw value type |
+| `cvec_X_value_t` | `i_val` | The cvec value type |
+| `cvec_X_rawvalue_t` | `i_valraw` | The raw value type |
| `cvec_X_iter_t` | `struct { cvec_X_value_t* ref; }` | The iterator type |
## Examples