summaryrefslogtreecommitdiff
path: root/pk.h.in
diff options
context:
space:
mode:
authorJonathan Bradley <jcb@pikum.xyz>2025-03-20 13:59:29 -0400
committerJonathan Bradley <jcb@pikum.xyz>2025-03-21 11:03:34 -0400
commit153d9b600a11025fe653a45cb4f845c0dff0b145 (patch)
treedf055c68a0a9e9044c4c9c3364fed7ce2dc419f3 /pk.h.in
parent9cd55867de91013bdbfe0d73112df504eb7963ba (diff)
pkarr: add c++ template + bump version to 0.4.2
Diffstat (limited to 'pk.h.in')
-rw-r--r--pk.h.in11
1 files changed, 11 insertions, 0 deletions
diff --git a/pk.h.in b/pk.h.in
index 94129ab..0fcad06 100644
--- a/pk.h.in
+++ b/pk.h.in
@@ -144,6 +144,7 @@
*
* Initialize `stride`, `alignment`, and `bkt` (optional) members
* *before* calling any `pk_arr_*` methods.
+* Alternatively, if using c++, use the template ctor.
*
* Examples:
* ``` c
@@ -154,6 +155,11 @@
* pk_arr_reserve(&arr, 10); // optional
* pk_arr_append(&arr, &obj);
* ```
+* ``` c++
+* struct pk_arr<some_type> arr(bkt);
+* pk_arr_reserve(&arr, 10); // optional
+* pk_arr_append(&arr, &obj);
+* ```
* ``` c
* struct pk_arr arr = {0};
* arr.stride = sizeof(obj); // required
@@ -163,6 +169,11 @@
* obj* d = (obj*)arr->data;
* d[0] = ...;
* ```
+* ``` c++
+* struct pk_arr_t<some_type> arr();
+* pk_arr_resize(&arr, 10);
+* arr[0] = {};
+* ```
*
********************************************************************************
* pkstn.h: def PK_IMPL_STN before including pk.h to enable ad-hoc.