summaryrefslogtreecommitdiffhomepage
path: root/docs/cptr_api.md
diff options
context:
space:
mode:
authorTyge Løvset <[email protected]>2020-12-09 17:03:13 +0100
committerGitHub <[email protected]>2020-12-09 17:03:13 +0100
commit7cc38d5f1b9fbf3a2c6b05ae85291c09df69f5bd (patch)
tree3c1d0ab1b8fd3dc978a335fbff15e17774bc936f /docs/cptr_api.md
parent2927cd9187305960930a9b63a00f7c2cdd6c6d48 (diff)
downloadSTC-modified-7cc38d5f1b9fbf3a2c6b05ae85291c09df69f5bd.tar.gz
STC-modified-7cc38d5f1b9fbf3a2c6b05ae85291c09df69f5bd.zip
Update cptr_api.md
Diffstat (limited to 'docs/cptr_api.md')
-rw-r--r--docs/cptr_api.md28
1 files changed, 9 insertions, 19 deletions
diff --git a/docs/cptr_api.md b/docs/cptr_api.md
index 0e0f3ebe..6e86ce11 100644
--- a/docs/cptr_api.md
+++ b/docs/cptr_api.md
@@ -19,18 +19,17 @@ affect the names of all cuptr types and methods. E.g. declaring `using_cuptr(my,
Types
-| Type name | Type definition | Used to represent... |
-|:--------------------|:---------------------------------------|:-------------------------|
-| `cuptr_X` | Depends on underlying container type | The cuptr type |
-| `cuptr_X_value_t` | " | The cuptr element type |
-| `cuptr_X_iter_t` | " | cuptr iterator |
+| Type name | Type definition | Used to represent... |
+|:--------------------|:-----------------------|:-------------------------|
+| `cuptr_X` | `cuptr_X_value_t *` | The cuptr type |
+| `cuptr_X_value_t` | `Value` | The cuptr element type |
-| Type name | Type definition | Used to represent... |
-|:--------------------|:---------------------------------------|:-------------------------|
-| `csptr_X` | Depends on underlying container type | The csptr type |
-| `csptr_X_value_t` | " | The csptr element type |
-| `csptr_X_iter_t` | " | csptr iterator |
+| Type name | Type definition | Used to represent... |
+|:--------------------|:--------------------------------------------------------------|:-------------------------|
+| `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 |
+| `atomic_count_t` | `long` | The reference counter |
## Header file
@@ -122,10 +121,6 @@ int main() {
```
Output:
```
-cvec of Person:
- Annie Aniston
- Jane Jacobs
- Joe Jordan
cvec of cuptr<Person>:
Annie Aniston
Jane Jacobs
@@ -144,11 +139,6 @@ del: Annie
del: Jane
del: Joe
-Destroy vec:
-del: Annie
-del: Jane
-del: Joe
-
Destroy x:
del: Jane
```