summaryrefslogtreecommitdiffhomepage
path: root/docs
diff options
context:
space:
mode:
authorTyge Løvset <[email protected]>2023-01-06 11:40:41 +0100
committerTyge Løvset <[email protected]>2023-01-06 11:40:41 +0100
commit7abea5ab04bffebbedfad7bd8d9c5c26170d19af (patch)
tree25f1aa511aa27198c31b7bad13ae137dd52828ad /docs
parentdd1ac09cd54e2632ec9d272ec578cde67a5edd01 (diff)
downloadSTC-modified-7abea5ab04bffebbedfad7bd8d9c5c26170d19af.tar.gz
STC-modified-7abea5ab04bffebbedfad7bd8d9c5c26170d19af.zip
Removed swap() function from all containers. Use safe c_SWAP() macro instead.
Diffstat (limited to 'docs')
-rw-r--r--docs/ccommon_api.md14
-rw-r--r--docs/cdeq_api.md1
-rw-r--r--docs/cmap_api.md1
-rw-r--r--docs/cset_api.md1
-rw-r--r--docs/csmap_api.md1
-rw-r--r--docs/csset_api.md1
-rw-r--r--docs/cvec_api.md1
7 files changed, 11 insertions, 9 deletions
diff --git a/docs/ccommon_api.md b/docs/ccommon_api.md
index bb9efac4..8c194a97 100644
--- a/docs/ccommon_api.md
+++ b/docs/ccommon_api.md
@@ -347,8 +347,16 @@ uint64_t crawstr_hash(const crawstr* x);
```
### c_MALLOC, c_CALLOC, c_REALLOC, c_FREE
-Memory allocator for the entire library. Macros can be overloaded by the user.
+Memory allocator for the entire library. Macros can be overridden by the user.
### c_SWAP, c_ARRAYLEN
-- **c_SWAP(type, x, y)**: Simple macro for swapping internals of two objects.
-- **c_ARRAYLEN(array)**: Return number of elements in an array, e.g. `int array[] = {1, 2, 3, 4};`
+- **c_SWAP(T, xp, yp)**: Safe macro for swapping internals of two objects of same type.
+- **c_ARRAYLEN(array)**: Return number of elements in an array.
+```c
+cmap_int map1 = {0}, map2 = {0};
+...
+c_SWAP(cmap_int, &map1, &map2);
+
+int array[] = {1, 2, 3, 4};
+size_t n = c_ARRAYLEN(array);
+```
diff --git a/docs/cdeq_api.md b/docs/cdeq_api.md
index e39a9d5d..584d382f 100644
--- a/docs/cdeq_api.md
+++ b/docs/cdeq_api.md
@@ -35,7 +35,6 @@ void cdeq_X_copy(cdeq_X* self, const cdeq_X* other);
cdeq_X_iter cdeq_X_copy_range(cdeq_X* self, i_val* pos, const i_val* p1, const i_val* p2);
bool cdeq_X_reserve(cdeq_X* self, size_t cap);
void cdeq_X_shrink_to_fit(cdeq_X* self);
-void cdeq_X_swap(cdeq_X* a, cdeq_X* b);
void cdeq_X_drop(cdeq_X* self); // destructor
bool cdeq_X_empty(const cdeq_X* self);
diff --git a/docs/cmap_api.md b/docs/cmap_api.md
index 10bfb040..2c690d13 100644
--- a/docs/cmap_api.md
+++ b/docs/cmap_api.md
@@ -56,7 +56,6 @@ void cmap_X_copy(cmap_X* self, const cmap_X* other);
float cmap_X_max_load_factor(const cmap_X* self); // default: 0.85f
bool cmap_X_reserve(cmap_X* self, size_t size);
void cmap_X_shrink_to_fit(cmap_X* self);
-void cmap_X_swap(cmap_X* a, cmap_X* b);
void cmap_X_drop(cmap_X* self); // destructor
size_t cmap_X_size(const cmap_X* self);
diff --git a/docs/cset_api.md b/docs/cset_api.md
index aff8506a..e1d08a87 100644
--- a/docs/cset_api.md
+++ b/docs/cset_api.md
@@ -38,7 +38,6 @@ void cset_X_copy(cset_X* self, const cset_X* other);
float cset_X_max_load_factor(const cset_X* self); // default: 0.85
bool cset_X_reserve(cset_X* self, size_t size);
void cset_X_shrink_to_fit(cset_X* self);
-void cset_X_swap(cset_X* a, cset_X* b);
void cset_X_drop(cset_X* self); // destructor
size_t cset_X_size(const cset_X* self); // num. of allocated buckets
diff --git a/docs/csmap_api.md b/docs/csmap_api.md
index 20346735..687a6cab 100644
--- a/docs/csmap_api.md
+++ b/docs/csmap_api.md
@@ -49,7 +49,6 @@ csmap_X csmap_X_clone(csmap_x map);
void csmap_X_clear(csmap_X* self);
void csmap_X_copy(csmap_X* self, const csmap_X* other);
-void csmap_X_swap(csmap_X* a, csmap_X* b);
void csmap_X_drop(csmap_X* self); // destructor
size_t csmap_X_size(const csmap_X* self);
diff --git a/docs/csset_api.md b/docs/csset_api.md
index e242b8e4..6276f486 100644
--- a/docs/csset_api.md
+++ b/docs/csset_api.md
@@ -35,7 +35,6 @@ csset_X csset_X_clone(csset_x set);
void csset_X_clear(csset_X* self);
void csset_X_copy(csset_X* self, const csset_X* other);
-void csset_X_swap(csset_X* a, csset_X* b);
void csset_X_drop(csset_X* self); // destructor
size_t csset_X_size(const csset_X* self);
diff --git a/docs/cvec_api.md b/docs/cvec_api.md
index 23722275..92629c8b 100644
--- a/docs/cvec_api.md
+++ b/docs/cvec_api.md
@@ -42,7 +42,6 @@ bool cvec_X_reserve(cvec_X* self, size_t cap);
bool cvec_X_resize(cvec_X* self, size_t size, i_val null);
cvec_X_iter cvec_X_insert_uninit(cvec_X* self, i_val* pos, size_t n); // return pos iter
void cvec_X_shrink_to_fit(cvec_X* self);
-void cvec_X_swap(cvec_X* a, cvec_X* b);
void cvec_X_drop(cvec_X* self); // destructor
bool cvec_X_empty(const cvec_X* self);