docs/Writerside/topics/collections.md

Thu, 13 Feb 2025 10:37:05 +0100

author
Mike Becker <universe@uap-core.de>
date
Thu, 13 Feb 2025 10:37:05 +0100
changeset 1206
6ff6dffcbb08
parent 1141
a06a2d27c043
permissions
-rw-r--r--

add intro text for collections API

relates to #451

1141
a06a2d27c043 create new page structure
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1 # Data Structures
1206
6ff6dffcbb08 add intro text for collections API
Mike Becker <universe@uap-core.de>
parents: 1141
diff changeset
2
6ff6dffcbb08 add intro text for collections API
Mike Becker <universe@uap-core.de>
parents: 1141
diff changeset
3 UCX provides a [](linked_list.h.md) and [](array_list.h.md) implementation over a common [](list.h.md) interface,
6ff6dffcbb08 add intro text for collections API
Mike Becker <universe@uap-core.de>
parents: 1141
diff changeset
4 as well as an [](hash_map.h.md) implementation over a [](map.h.md) interface, and a basic [](tree.h.md) implementation.
6ff6dffcbb08 add intro text for collections API
Mike Becker <universe@uap-core.de>
parents: 1141
diff changeset
5
6ff6dffcbb08 add intro text for collections API
Mike Becker <universe@uap-core.de>
parents: 1141
diff changeset
6 Additionally, UCX provides an abstraction for [iterators](iterator.h.md) that work with all collection types, and
6ff6dffcbb08 add intro text for collections API
Mike Becker <universe@uap-core.de>
parents: 1141
diff changeset
7 plain C arrays.
6ff6dffcbb08 add intro text for collections API
Mike Becker <universe@uap-core.de>
parents: 1141
diff changeset
8
6ff6dffcbb08 add intro text for collections API
Mike Becker <universe@uap-core.de>
parents: 1141
diff changeset
9 The design goal of this API was to provide high level abstractions (functions in lowerCamelCase) and low level
6ff6dffcbb08 add intro text for collections API
Mike Becker <universe@uap-core.de>
parents: 1141
diff changeset
10 implementations (functions in snake_case).
6ff6dffcbb08 add intro text for collections API
Mike Becker <universe@uap-core.de>
parents: 1141
diff changeset
11 This way you can freely choose whether to use the predefined implementations for the various collection types,
6ff6dffcbb08 add intro text for collections API
Mike Becker <universe@uap-core.de>
parents: 1141
diff changeset
12 or to implement your own collections using the low level API.

mercurial