changeset
adjusts the UcxArray documentation to the recent changes
Sat, 05 Oct 2019 16:57:06 +0200
- author
- Mike Becker <universe@uap-core.de>
- date
- Sat, 05 Oct 2019 16:57:06 +0200
- branch
- feature/array
- changeset 359
- 9f86bc73f96b
- parent 358
- 885f31c6098b
- child 360
- fed2ead878ea
- child 387
- 7e0f19fe23ff
adjusts the UcxArray documentation to the recent changes
| docs/src/modules.md | file | annotate | diff | comparison | revisions |
--- a/docs/src/modules.md Thu Oct 03 11:16:12 2019 +0200 +++ b/docs/src/modules.md Sat Oct 05 16:57:06 2019 +0200 @@ -50,9 +50,10 @@ The UCX Array is an implementation of a dynamic array with automatic reallocation. The array structure contains a capacity, the current size, the size of each element, the raw pointer to the memory area and an allocator. -Unlike an [UcxList](#list), the array structure is typically passed by value, -unless it is subjected to change. Arrays are in most cases much faster than -linked list. +Arrays are in most cases much faster than linked list. +One can decide, whether to create a new array on the heap with `ucx_array_new()` +or to save one indirection by initializing a `UcxArray` structure on the stack +with `ucx_array_init()`. ### Remove duplicates from an array of strings
