summaryrefslogtreecommitdiffhomepage
path: root/docs/cvec_api.md
diff options
context:
space:
mode:
authorTyge Løvset <[email protected]>2020-12-17 07:55:59 +0100
committerTyge Løvset <[email protected]>2020-12-17 07:55:59 +0100
commitbc2981ee8fa3cba0be0d0efb1e2a2072c98ca5a0 (patch)
tree2e848e43a77cf4507645d7b89231c9a726b3ec05 /docs/cvec_api.md
parent214a2aa75d164d285661719131f54c71fa2f8e37 (diff)
downloadSTC-modified-bc2981ee8fa3cba0be0d0efb1e2a2072c98ca5a0.tar.gz
STC-modified-bc2981ee8fa3cba0be0d0efb1e2a2072c98ca5a0.zip
API change: Reverted back to original name used for .val in iterators to .ref
Diffstat (limited to 'docs/cvec_api.md')
-rw-r--r--docs/cvec_api.md20
1 files changed, 10 insertions, 10 deletions
diff --git a/docs/cvec_api.md b/docs/cvec_api.md
index d33a4d42..628d5acd 100644
--- a/docs/cvec_api.md
+++ b/docs/cvec_api.md
@@ -30,7 +30,7 @@ using_cvec(str, cstr_t, cstr_del, cstr_compare_raw, const char*, cstr_to_raw, cs
| `cvec_X_value_t` | `Value` | The cvec value type |
| `cvec_X_input_t` | `cvec_X_value_t` | The input type |
| `cvec_X_rawvalue_t` | `RawValue` | The raw value type |
-| `cvec_X_iter_t` | `struct { cvec_X_value_t* val; }` | The iterator type |
+| `cvec_X_iter_t` | `struct { cvec_X_value_t* ref; }` | The iterator type |
## Constants and macros
@@ -73,12 +73,12 @@ cvec_X_value_t* cvec_X_front(cvec_X* self);
cvec_X_value_t* cvec_X_back(cvec_X* self);
void cvec_X_push_n(cvec_X *self, const cvec_X_input_t arr[], size_t size);
-void cvec_X_emplace_back(cvec_X* self, RawValue val);
+void cvec_X_emplace_back(cvec_X* self, RawValue ref);
void cvec_X_push_back(cvec_X* self, Value value);
void cvec_X_pop_back(cvec_X* self);
-cvec_X_iter_t cvec_X_emplace(cvec_X* self, cvec_X_iter_t pos, RawValue val);
-cvec_X_iter_t cvec_X_emplace_at(cvec_X* self, size_t idx, RawValue val);
+cvec_X_iter_t cvec_X_emplace(cvec_X* self, cvec_X_iter_t pos, RawValue ref);
+cvec_X_iter_t cvec_X_emplace_at(cvec_X* self, size_t idx, RawValue ref);
cvec_X_iter_t cvec_X_insert(cvec_X* self, cvec_X_iter_t pos, Value value);
cvec_X_iter_t cvec_X_insert_at(cvec_X* self, size_t idx, Value value);
cvec_X_iter_t cvec_X_insert_range(cvec_X* self, cvec_X_iter_t pos,
@@ -91,9 +91,9 @@ cvec_X_iter_t cvec_X_erase_n(cvec_X* self, size_t idx, size_t n);
cvec_X_iter_t cvec_X_erase_range(cvec_X* self, cvec_X_iter_t first, cvec_X_iter_t finish);
cvec_X_iter_t cvec_X_erase_range_p(cvec_X* self, cvec_X_value_t* pfirst, cvec_X_value_t* pfinish);
-cvec_X_iter_t cvec_X_find(const cvec_X* self, RawValue val);
+cvec_X_iter_t cvec_X_find(const cvec_X* self, RawValue ref);
cvec_X_iter_t cvec_X_find_in_range(const cvec_X* self,
- cvec_X_iter_t first, cvec_X_iter_t finish, RawValue val);
+ cvec_X_iter_t first, cvec_X_iter_t finish, RawValue ref);
void cvec_X_sort(cvec_X* self);
void cvec_X_sort_with(cvec_X* self, size_t ifirst, size_t ifinish,
@@ -105,7 +105,7 @@ void cvec_X_next(cvec_X_iter_t* it);
cvec_X_value_t* cvec_X_itval(cvec_X_iter_t it);
size_t cvec_X_index(const cvec_X vec, cvec_X_iter_t it);
-Value cvec_X_value_from_raw(RawValue val);
+Value cvec_X_value_from_raw(RawValue ref);
```
## Examples
@@ -126,7 +126,7 @@ int main()
printf("initial: ");
c_foreach (n, cvec_i, vec) {
- printf(" %d", *n.val);
+ printf(" %d", *n.ref);
}
// Sort the vector
@@ -134,7 +134,7 @@ int main()
printf("\nsorted: ");
c_foreach (n, cvec_i, vec) {
- printf(" %d", *n.val);
+ printf(" %d", *n.ref);
}
cvec_i_del(&vec);
@@ -166,7 +166,7 @@ int main() {
printf("%s\n", names.data[1].str); // Access the second element
c_foreach (i, cvec_str, names)
- printf("item: %s\n", i.val->str);
+ printf("item: %s\n", i.ref->str);
cvec_str_del(&names);
}
```