Thu, 13 Feb 2025 10:37:05 +0100
add intro text for collections API
relates to #451
docs/Writerside/topics/collections.md | file | annotate | diff | comparison | revisions |
--- a/docs/Writerside/topics/collections.md Wed Feb 12 19:40:59 2025 +0100 +++ b/docs/Writerside/topics/collections.md Thu Feb 13 10:37:05 2025 +0100 @@ -1,1 +1,12 @@ # Data Structures + +UCX provides a [](linked_list.h.md) and [](array_list.h.md) implementation over a common [](list.h.md) interface, +as well as an [](hash_map.h.md) implementation over a [](map.h.md) interface, and a basic [](tree.h.md) implementation. + +Additionally, UCX provides an abstraction for [iterators](iterator.h.md) that work with all collection types, and +plain C arrays. + +The design goal of this API was to provide high level abstractions (functions in lowerCamelCase) and low level +implementations (functions in snake_case). +This way you can freely choose whether to use the predefined implementations for the various collection types, +or to implement your own collections using the low level API.