src/cx/array_list.h

Wed, 20 Dec 2023 17:57:18 +0100

author
Mike Becker <universe@uap-core.de>
date
Wed, 20 Dec 2023 17:57:18 +0100
changeset 767
d31f4d4075dc
parent 763
741a2040fa33
child 795
00ba1bfa4ab4
permissions
-rw-r--r--

migrate utils tests - relates to #342

606
314e9288af2f add array list tests
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1 /*
314e9288af2f add array list tests
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
314e9288af2f add array list tests
Mike Becker <universe@uap-core.de>
parents:
diff changeset
3 *
314e9288af2f add array list tests
Mike Becker <universe@uap-core.de>
parents:
diff changeset
4 * Copyright 2021 Mike Becker, Olaf Wintermann All rights reserved.
314e9288af2f add array list tests
Mike Becker <universe@uap-core.de>
parents:
diff changeset
5 *
314e9288af2f add array list tests
Mike Becker <universe@uap-core.de>
parents:
diff changeset
6 * Redistribution and use in source and binary forms, with or without
314e9288af2f add array list tests
Mike Becker <universe@uap-core.de>
parents:
diff changeset
7 * modification, are permitted provided that the following conditions are met:
314e9288af2f add array list tests
Mike Becker <universe@uap-core.de>
parents:
diff changeset
8 *
314e9288af2f add array list tests
Mike Becker <universe@uap-core.de>
parents:
diff changeset
9 * 1. Redistributions of source code must retain the above copyright
314e9288af2f add array list tests
Mike Becker <universe@uap-core.de>
parents:
diff changeset
10 * notice, this list of conditions and the following disclaimer.
314e9288af2f add array list tests
Mike Becker <universe@uap-core.de>
parents:
diff changeset
11 *
314e9288af2f add array list tests
Mike Becker <universe@uap-core.de>
parents:
diff changeset
12 * 2. Redistributions in binary form must reproduce the above copyright
314e9288af2f add array list tests
Mike Becker <universe@uap-core.de>
parents:
diff changeset
13 * notice, this list of conditions and the following disclaimer in the
314e9288af2f add array list tests
Mike Becker <universe@uap-core.de>
parents:
diff changeset
14 * documentation and/or other materials provided with the distribution.
314e9288af2f add array list tests
Mike Becker <universe@uap-core.de>
parents:
diff changeset
15 *
314e9288af2f add array list tests
Mike Becker <universe@uap-core.de>
parents:
diff changeset
16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
314e9288af2f add array list tests
Mike Becker <universe@uap-core.de>
parents:
diff changeset
17 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
314e9288af2f add array list tests
Mike Becker <universe@uap-core.de>
parents:
diff changeset
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
314e9288af2f add array list tests
Mike Becker <universe@uap-core.de>
parents:
diff changeset
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
314e9288af2f add array list tests
Mike Becker <universe@uap-core.de>
parents:
diff changeset
20 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
314e9288af2f add array list tests
Mike Becker <universe@uap-core.de>
parents:
diff changeset
21 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
314e9288af2f add array list tests
Mike Becker <universe@uap-core.de>
parents:
diff changeset
22 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
314e9288af2f add array list tests
Mike Becker <universe@uap-core.de>
parents:
diff changeset
23 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
314e9288af2f add array list tests
Mike Becker <universe@uap-core.de>
parents:
diff changeset
24 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
314e9288af2f add array list tests
Mike Becker <universe@uap-core.de>
parents:
diff changeset
25 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
314e9288af2f add array list tests
Mike Becker <universe@uap-core.de>
parents:
diff changeset
26 * POSSIBILITY OF SUCH DAMAGE.
314e9288af2f add array list tests
Mike Becker <universe@uap-core.de>
parents:
diff changeset
27 */
314e9288af2f add array list tests
Mike Becker <universe@uap-core.de>
parents:
diff changeset
28 /**
314e9288af2f add array list tests
Mike Becker <universe@uap-core.de>
parents:
diff changeset
29 * \file array_list.h
314e9288af2f add array list tests
Mike Becker <universe@uap-core.de>
parents:
diff changeset
30 * \brief Array list implementation.
314e9288af2f add array list tests
Mike Becker <universe@uap-core.de>
parents:
diff changeset
31 * \details Also provides several low-level functions for custom array list implementations.
314e9288af2f add array list tests
Mike Becker <universe@uap-core.de>
parents:
diff changeset
32 * \author Mike Becker
314e9288af2f add array list tests
Mike Becker <universe@uap-core.de>
parents:
diff changeset
33 * \author Olaf Wintermann
314e9288af2f add array list tests
Mike Becker <universe@uap-core.de>
parents:
diff changeset
34 * \copyright 2-Clause BSD License
314e9288af2f add array list tests
Mike Becker <universe@uap-core.de>
parents:
diff changeset
35 */
314e9288af2f add array list tests
Mike Becker <universe@uap-core.de>
parents:
diff changeset
36
314e9288af2f add array list tests
Mike Becker <universe@uap-core.de>
parents:
diff changeset
37
314e9288af2f add array list tests
Mike Becker <universe@uap-core.de>
parents:
diff changeset
38 #ifndef UCX_ARRAY_LIST_H
314e9288af2f add array list tests
Mike Becker <universe@uap-core.de>
parents:
diff changeset
39 #define UCX_ARRAY_LIST_H
314e9288af2f add array list tests
Mike Becker <universe@uap-core.de>
parents:
diff changeset
40
617
cec11387c1be fix include in array_list.h
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 612
diff changeset
41 #include "list.h"
606
314e9288af2f add array list tests
Mike Becker <universe@uap-core.de>
parents:
diff changeset
42
314e9288af2f add array list tests
Mike Becker <universe@uap-core.de>
parents:
diff changeset
43 #ifdef __cplusplus
314e9288af2f add array list tests
Mike Becker <universe@uap-core.de>
parents:
diff changeset
44 extern "C" {
314e9288af2f add array list tests
Mike Becker <universe@uap-core.de>
parents:
diff changeset
45 #endif
314e9288af2f add array list tests
Mike Becker <universe@uap-core.de>
parents:
diff changeset
46
314e9288af2f add array list tests
Mike Becker <universe@uap-core.de>
parents:
diff changeset
47 /**
608
2e93521145ac proposal for a low level array copy
Mike Becker <universe@uap-core.de>
parents: 606
diff changeset
48 * Defines a reallocation mechanism for arrays.
2e93521145ac proposal for a low level array copy
Mike Becker <universe@uap-core.de>
parents: 606
diff changeset
49 */
2e93521145ac proposal for a low level array copy
Mike Becker <universe@uap-core.de>
parents: 606
diff changeset
50 struct cx_array_reallocator_s {
2e93521145ac proposal for a low level array copy
Mike Becker <universe@uap-core.de>
parents: 606
diff changeset
51 /**
2e93521145ac proposal for a low level array copy
Mike Becker <universe@uap-core.de>
parents: 606
diff changeset
52 * Re-allocates space for the given array.
2e93521145ac proposal for a low level array copy
Mike Becker <universe@uap-core.de>
parents: 606
diff changeset
53 *
2e93521145ac proposal for a low level array copy
Mike Becker <universe@uap-core.de>
parents: 606
diff changeset
54 * Implementations are not required to free the original array.
2e93521145ac proposal for a low level array copy
Mike Becker <universe@uap-core.de>
parents: 606
diff changeset
55 * This allows re-allocation of static memory by allocating heap memory
2e93521145ac proposal for a low level array copy
Mike Becker <universe@uap-core.de>
parents: 606
diff changeset
56 * and copying the array contents. The information in \p data can keep
2e93521145ac proposal for a low level array copy
Mike Becker <universe@uap-core.de>
parents: 606
diff changeset
57 * track of the state of the memory or other additional allocator info.
2e93521145ac proposal for a low level array copy
Mike Becker <universe@uap-core.de>
parents: 606
diff changeset
58 *
2e93521145ac proposal for a low level array copy
Mike Becker <universe@uap-core.de>
parents: 606
diff changeset
59 * @param array the array to reallocate
2e93521145ac proposal for a low level array copy
Mike Becker <universe@uap-core.de>
parents: 606
diff changeset
60 * @param capacity the new capacity (number of elements)
2e93521145ac proposal for a low level array copy
Mike Becker <universe@uap-core.de>
parents: 606
diff changeset
61 * @param elem_size the size of each element
609
6ae8146d9f62 more custom data for array re-allocator
Mike Becker <universe@uap-core.de>
parents: 608
diff changeset
62 * @param alloc a reference to this allocator
608
2e93521145ac proposal for a low level array copy
Mike Becker <universe@uap-core.de>
parents: 606
diff changeset
63 * @return a pointer to the reallocated memory or \c NULL on failure
2e93521145ac proposal for a low level array copy
Mike Becker <universe@uap-core.de>
parents: 606
diff changeset
64 */
2e93521145ac proposal for a low level array copy
Mike Becker <universe@uap-core.de>
parents: 606
diff changeset
65 void *(*realloc)(
2e93521145ac proposal for a low level array copy
Mike Becker <universe@uap-core.de>
parents: 606
diff changeset
66 void *array,
2e93521145ac proposal for a low level array copy
Mike Becker <universe@uap-core.de>
parents: 606
diff changeset
67 size_t capacity,
2e93521145ac proposal for a low level array copy
Mike Becker <universe@uap-core.de>
parents: 606
diff changeset
68 size_t elem_size,
609
6ae8146d9f62 more custom data for array re-allocator
Mike Becker <universe@uap-core.de>
parents: 608
diff changeset
69 struct cx_array_reallocator_s *alloc
608
2e93521145ac proposal for a low level array copy
Mike Becker <universe@uap-core.de>
parents: 606
diff changeset
70 );
2e93521145ac proposal for a low level array copy
Mike Becker <universe@uap-core.de>
parents: 606
diff changeset
71
2e93521145ac proposal for a low level array copy
Mike Becker <universe@uap-core.de>
parents: 606
diff changeset
72 /**
609
6ae8146d9f62 more custom data for array re-allocator
Mike Becker <universe@uap-core.de>
parents: 608
diff changeset
73 * Custom data pointer.
6ae8146d9f62 more custom data for array re-allocator
Mike Becker <universe@uap-core.de>
parents: 608
diff changeset
74 */
6ae8146d9f62 more custom data for array re-allocator
Mike Becker <universe@uap-core.de>
parents: 608
diff changeset
75 void *ptr1;
6ae8146d9f62 more custom data for array re-allocator
Mike Becker <universe@uap-core.de>
parents: 608
diff changeset
76 /**
6ae8146d9f62 more custom data for array re-allocator
Mike Becker <universe@uap-core.de>
parents: 608
diff changeset
77 * Custom data pointer.
608
2e93521145ac proposal for a low level array copy
Mike Becker <universe@uap-core.de>
parents: 606
diff changeset
78 */
609
6ae8146d9f62 more custom data for array re-allocator
Mike Becker <universe@uap-core.de>
parents: 608
diff changeset
79 void *ptr2;
6ae8146d9f62 more custom data for array re-allocator
Mike Becker <universe@uap-core.de>
parents: 608
diff changeset
80 /**
6ae8146d9f62 more custom data for array re-allocator
Mike Becker <universe@uap-core.de>
parents: 608
diff changeset
81 * Custom data integer.
6ae8146d9f62 more custom data for array re-allocator
Mike Becker <universe@uap-core.de>
parents: 608
diff changeset
82 */
6ae8146d9f62 more custom data for array re-allocator
Mike Becker <universe@uap-core.de>
parents: 608
diff changeset
83 size_t int1;
6ae8146d9f62 more custom data for array re-allocator
Mike Becker <universe@uap-core.de>
parents: 608
diff changeset
84 /**
6ae8146d9f62 more custom data for array re-allocator
Mike Becker <universe@uap-core.de>
parents: 608
diff changeset
85 * Custom data integer.
6ae8146d9f62 more custom data for array re-allocator
Mike Becker <universe@uap-core.de>
parents: 608
diff changeset
86 */
6ae8146d9f62 more custom data for array re-allocator
Mike Becker <universe@uap-core.de>
parents: 608
diff changeset
87 size_t int2;
608
2e93521145ac proposal for a low level array copy
Mike Becker <universe@uap-core.de>
parents: 606
diff changeset
88 };
2e93521145ac proposal for a low level array copy
Mike Becker <universe@uap-core.de>
parents: 606
diff changeset
89
2e93521145ac proposal for a low level array copy
Mike Becker <universe@uap-core.de>
parents: 606
diff changeset
90 /**
610
de5d3ee6435f #219 array list: implement add and at
Mike Becker <universe@uap-core.de>
parents: 609
diff changeset
91 * Return codes for cx_array_copy().
de5d3ee6435f #219 array list: implement add and at
Mike Becker <universe@uap-core.de>
parents: 609
diff changeset
92 */
612
820ee59121b4 fix typo in enum cx_array_copy_result
Mike Becker <universe@uap-core.de>
parents: 610
diff changeset
93 enum cx_array_copy_result {
610
de5d3ee6435f #219 array list: implement add and at
Mike Becker <universe@uap-core.de>
parents: 609
diff changeset
94 CX_ARRAY_COPY_SUCCESS,
de5d3ee6435f #219 array list: implement add and at
Mike Becker <universe@uap-core.de>
parents: 609
diff changeset
95 CX_ARRAY_COPY_REALLOC_NOT_SUPPORTED,
de5d3ee6435f #219 array list: implement add and at
Mike Becker <universe@uap-core.de>
parents: 609
diff changeset
96 CX_ARRAY_COPY_REALLOC_FAILED,
de5d3ee6435f #219 array list: implement add and at
Mike Becker <universe@uap-core.de>
parents: 609
diff changeset
97 };
de5d3ee6435f #219 array list: implement add and at
Mike Becker <universe@uap-core.de>
parents: 609
diff changeset
98
de5d3ee6435f #219 array list: implement add and at
Mike Becker <universe@uap-core.de>
parents: 609
diff changeset
99 /**
608
2e93521145ac proposal for a low level array copy
Mike Becker <universe@uap-core.de>
parents: 606
diff changeset
100 * Copies elements from one array to another.
2e93521145ac proposal for a low level array copy
Mike Becker <universe@uap-core.de>
parents: 606
diff changeset
101 *
2e93521145ac proposal for a low level array copy
Mike Becker <universe@uap-core.de>
parents: 606
diff changeset
102 * The elements are copied to the \p target array at the specified \p index,
637
ceadf0792ded remove the untrue restriction for the index parameter of cx_array_copy() from the documentation
Mike Becker <universe@uap-core.de>
parents: 628
diff changeset
103 * overwriting possible elements. The \p index does not need to be in range of
ceadf0792ded remove the untrue restriction for the index parameter of cx_array_copy() from the documentation
Mike Becker <universe@uap-core.de>
parents: 628
diff changeset
104 * the current array \p size. If the new index plus the number of elements added
ceadf0792ded remove the untrue restriction for the index parameter of cx_array_copy() from the documentation
Mike Becker <universe@uap-core.de>
parents: 628
diff changeset
105 * would extend the array's size, and \p capacity is not \c NULL, the remaining
ceadf0792ded remove the untrue restriction for the index parameter of cx_array_copy() from the documentation
Mike Becker <universe@uap-core.de>
parents: 628
diff changeset
106 * capacity is used.
608
2e93521145ac proposal for a low level array copy
Mike Becker <universe@uap-core.de>
parents: 606
diff changeset
107 *
2e93521145ac proposal for a low level array copy
Mike Becker <universe@uap-core.de>
parents: 606
diff changeset
108 * If the capacity is insufficient to hold the new data, a reallocation
2e93521145ac proposal for a low level array copy
Mike Becker <universe@uap-core.de>
parents: 606
diff changeset
109 * attempt is made, unless the allocator is set to \c NULL, in which case
2e93521145ac proposal for a low level array copy
Mike Becker <universe@uap-core.de>
parents: 606
diff changeset
110 * this function ultimately returns a failure.
2e93521145ac proposal for a low level array copy
Mike Becker <universe@uap-core.de>
parents: 606
diff changeset
111 *
2e93521145ac proposal for a low level array copy
Mike Becker <universe@uap-core.de>
parents: 606
diff changeset
112 * @param target the target array
2e93521145ac proposal for a low level array copy
Mike Becker <universe@uap-core.de>
parents: 606
diff changeset
113 * @param size a pointer to the size of the target array
2e93521145ac proposal for a low level array copy
Mike Becker <universe@uap-core.de>
parents: 606
diff changeset
114 * @param capacity a pointer to the target array's capacity -
2e93521145ac proposal for a low level array copy
Mike Becker <universe@uap-core.de>
parents: 606
diff changeset
115 * \c NULL if only the size shall be used to bound the array
2e93521145ac proposal for a low level array copy
Mike Becker <universe@uap-core.de>
parents: 606
diff changeset
116 * @param index the index where the copied elements shall be placed
2e93521145ac proposal for a low level array copy
Mike Becker <universe@uap-core.de>
parents: 606
diff changeset
117 * @param src the source array
2e93521145ac proposal for a low level array copy
Mike Becker <universe@uap-core.de>
parents: 606
diff changeset
118 * @param elem_size the size of one element
2e93521145ac proposal for a low level array copy
Mike Becker <universe@uap-core.de>
parents: 606
diff changeset
119 * @param elem_count the number of elements to copy
2e93521145ac proposal for a low level array copy
Mike Becker <universe@uap-core.de>
parents: 606
diff changeset
120 * @param reallocator the array re-allocator to use, or \c NULL
2e93521145ac proposal for a low level array copy
Mike Becker <universe@uap-core.de>
parents: 606
diff changeset
121 * if re-allocation shall not happen
610
de5d3ee6435f #219 array list: implement add and at
Mike Becker <universe@uap-core.de>
parents: 609
diff changeset
122 * @return zero on success, non-zero error code on failure
608
2e93521145ac proposal for a low level array copy
Mike Becker <universe@uap-core.de>
parents: 606
diff changeset
123 */
612
820ee59121b4 fix typo in enum cx_array_copy_result
Mike Becker <universe@uap-core.de>
parents: 610
diff changeset
124 enum cx_array_copy_result cx_array_copy(
608
2e93521145ac proposal for a low level array copy
Mike Becker <universe@uap-core.de>
parents: 606
diff changeset
125 void **target,
2e93521145ac proposal for a low level array copy
Mike Becker <universe@uap-core.de>
parents: 606
diff changeset
126 size_t *size,
2e93521145ac proposal for a low level array copy
Mike Becker <universe@uap-core.de>
parents: 606
diff changeset
127 size_t *capacity,
2e93521145ac proposal for a low level array copy
Mike Becker <universe@uap-core.de>
parents: 606
diff changeset
128 size_t index,
2e93521145ac proposal for a low level array copy
Mike Becker <universe@uap-core.de>
parents: 606
diff changeset
129 void const *src,
2e93521145ac proposal for a low level array copy
Mike Becker <universe@uap-core.de>
parents: 606
diff changeset
130 size_t elem_size,
2e93521145ac proposal for a low level array copy
Mike Becker <universe@uap-core.de>
parents: 606
diff changeset
131 size_t elem_count,
610
de5d3ee6435f #219 array list: implement add and at
Mike Becker <universe@uap-core.de>
parents: 609
diff changeset
132 struct cx_array_reallocator_s *reallocator
608
2e93521145ac proposal for a low level array copy
Mike Becker <universe@uap-core.de>
parents: 606
diff changeset
133 ) __attribute__((__nonnull__(1, 2, 5)));
2e93521145ac proposal for a low level array copy
Mike Becker <universe@uap-core.de>
parents: 606
diff changeset
134
623
21082350a590 #219 array list: implement reverse
Mike Becker <universe@uap-core.de>
parents: 617
diff changeset
135
21082350a590 #219 array list: implement reverse
Mike Becker <universe@uap-core.de>
parents: 617
diff changeset
136 /**
21082350a590 #219 array list: implement reverse
Mike Becker <universe@uap-core.de>
parents: 617
diff changeset
137 * Swaps two array elements.
21082350a590 #219 array list: implement reverse
Mike Becker <universe@uap-core.de>
parents: 617
diff changeset
138 *
21082350a590 #219 array list: implement reverse
Mike Becker <universe@uap-core.de>
parents: 617
diff changeset
139 * @param arr the array
21082350a590 #219 array list: implement reverse
Mike Becker <universe@uap-core.de>
parents: 617
diff changeset
140 * @param elem_size the element size
21082350a590 #219 array list: implement reverse
Mike Becker <universe@uap-core.de>
parents: 617
diff changeset
141 * @param idx1 index of first element
21082350a590 #219 array list: implement reverse
Mike Becker <universe@uap-core.de>
parents: 617
diff changeset
142 * @param idx2 index of second element
21082350a590 #219 array list: implement reverse
Mike Becker <universe@uap-core.de>
parents: 617
diff changeset
143 */
21082350a590 #219 array list: implement reverse
Mike Becker <universe@uap-core.de>
parents: 617
diff changeset
144 void cx_array_swap(
21082350a590 #219 array list: implement reverse
Mike Becker <universe@uap-core.de>
parents: 617
diff changeset
145 void *arr,
21082350a590 #219 array list: implement reverse
Mike Becker <universe@uap-core.de>
parents: 617
diff changeset
146 size_t elem_size,
21082350a590 #219 array list: implement reverse
Mike Becker <universe@uap-core.de>
parents: 617
diff changeset
147 size_t idx1,
21082350a590 #219 array list: implement reverse
Mike Becker <universe@uap-core.de>
parents: 617
diff changeset
148 size_t idx2
21082350a590 #219 array list: implement reverse
Mike Becker <universe@uap-core.de>
parents: 617
diff changeset
149 ) __attribute__((__nonnull__));
21082350a590 #219 array list: implement reverse
Mike Becker <universe@uap-core.de>
parents: 617
diff changeset
150
608
2e93521145ac proposal for a low level array copy
Mike Becker <universe@uap-core.de>
parents: 606
diff changeset
151 /**
606
314e9288af2f add array list tests
Mike Becker <universe@uap-core.de>
parents:
diff changeset
152 * Allocates an array list for storing elements with \p item_size bytes each.
314e9288af2f add array list tests
Mike Becker <universe@uap-core.de>
parents:
diff changeset
153 *
669
dce9b8450656 add docs for CX_STORE_POINTERS and remove cxHashMapCreateForPointers()
Mike Becker <universe@uap-core.de>
parents: 662
diff changeset
154 * If \p item_size is CX_STORE_POINTERS, the created list will be created as if
763
741a2040fa33 make cx_cmp_ptr default comparator for pointer lists - relates to #340
Mike Becker <universe@uap-core.de>
parents: 759
diff changeset
155 * cxListStorePointers() was called immediately after creation and the compare
741a2040fa33 make cx_cmp_ptr default comparator for pointer lists - relates to #340
Mike Becker <universe@uap-core.de>
parents: 759
diff changeset
156 * function will be automatically set to cx_cmp_ptr(), if none is given.
669
dce9b8450656 add docs for CX_STORE_POINTERS and remove cxHashMapCreateForPointers()
Mike Becker <universe@uap-core.de>
parents: 662
diff changeset
157 *
606
314e9288af2f add array list tests
Mike Becker <universe@uap-core.de>
parents:
diff changeset
158 * @param allocator the allocator for allocating the list memory
670
4ad8ea3aee49 allow NULL for allocator and comparator
Mike Becker <universe@uap-core.de>
parents: 669
diff changeset
159 * (if \c NULL the cxDefaultAllocator will be used)
606
314e9288af2f add array list tests
Mike Becker <universe@uap-core.de>
parents:
diff changeset
160 * @param comparator the comparator for the elements
763
741a2040fa33 make cx_cmp_ptr default comparator for pointer lists - relates to #340
Mike Becker <universe@uap-core.de>
parents: 759
diff changeset
161 * (if \c NULL, and the list is not storing pointers, sort and find
741a2040fa33 make cx_cmp_ptr default comparator for pointer lists - relates to #340
Mike Becker <universe@uap-core.de>
parents: 759
diff changeset
162 * functions will not work)
606
314e9288af2f add array list tests
Mike Becker <universe@uap-core.de>
parents:
diff changeset
163 * @param item_size the size of each element in bytes
314e9288af2f add array list tests
Mike Becker <universe@uap-core.de>
parents:
diff changeset
164 * @param initial_capacity the initial number of elements the array can store
314e9288af2f add array list tests
Mike Becker <universe@uap-core.de>
parents:
diff changeset
165 * @return the created list
314e9288af2f add array list tests
Mike Becker <universe@uap-core.de>
parents:
diff changeset
166 */
314e9288af2f add array list tests
Mike Becker <universe@uap-core.de>
parents:
diff changeset
167 CxList *cxArrayListCreate(
314e9288af2f add array list tests
Mike Becker <universe@uap-core.de>
parents:
diff changeset
168 CxAllocator const *allocator,
677
b09aae58bba4 refactoring of collections to make use of destructors in map implementations
Mike Becker <universe@uap-core.de>
parents: 670
diff changeset
169 cx_compare_func comparator,
606
314e9288af2f add array list tests
Mike Becker <universe@uap-core.de>
parents:
diff changeset
170 size_t item_size,
314e9288af2f add array list tests
Mike Becker <universe@uap-core.de>
parents:
diff changeset
171 size_t initial_capacity
670
4ad8ea3aee49 allow NULL for allocator and comparator
Mike Becker <universe@uap-core.de>
parents: 669
diff changeset
172 );
606
314e9288af2f add array list tests
Mike Becker <universe@uap-core.de>
parents:
diff changeset
173
662
d0d95740071b add simple functions for creating lists
Mike Becker <universe@uap-core.de>
parents: 637
diff changeset
174 /**
d0d95740071b add simple functions for creating lists
Mike Becker <universe@uap-core.de>
parents: 637
diff changeset
175 * Allocates an array list for storing elements with \p item_size bytes each.
d0d95740071b add simple functions for creating lists
Mike Becker <universe@uap-core.de>
parents: 637
diff changeset
176 *
d0d95740071b add simple functions for creating lists
Mike Becker <universe@uap-core.de>
parents: 637
diff changeset
177 * The list will use the cxDefaultAllocator and \em NO compare function.
d0d95740071b add simple functions for creating lists
Mike Becker <universe@uap-core.de>
parents: 637
diff changeset
178 * If you want to call functions that need a compare function, you have to
d0d95740071b add simple functions for creating lists
Mike Becker <universe@uap-core.de>
parents: 637
diff changeset
179 * set it immediately after creation or use cxArrayListCreate().
d0d95740071b add simple functions for creating lists
Mike Becker <universe@uap-core.de>
parents: 637
diff changeset
180 *
669
dce9b8450656 add docs for CX_STORE_POINTERS and remove cxHashMapCreateForPointers()
Mike Becker <universe@uap-core.de>
parents: 662
diff changeset
181 * If \p item_size is CX_STORE_POINTERS, the created list will be created as if
763
741a2040fa33 make cx_cmp_ptr default comparator for pointer lists - relates to #340
Mike Becker <universe@uap-core.de>
parents: 759
diff changeset
182 * cxListStorePointers() was called immediately after creation and the compare
741a2040fa33 make cx_cmp_ptr default comparator for pointer lists - relates to #340
Mike Becker <universe@uap-core.de>
parents: 759
diff changeset
183 * function will be automatically set to cx_cmp_ptr().
669
dce9b8450656 add docs for CX_STORE_POINTERS and remove cxHashMapCreateForPointers()
Mike Becker <universe@uap-core.de>
parents: 662
diff changeset
184 *
662
d0d95740071b add simple functions for creating lists
Mike Becker <universe@uap-core.de>
parents: 637
diff changeset
185 * @param item_size the size of each element in bytes
d0d95740071b add simple functions for creating lists
Mike Becker <universe@uap-core.de>
parents: 637
diff changeset
186 * @param initial_capacity the initial number of elements the array can store
d0d95740071b add simple functions for creating lists
Mike Becker <universe@uap-core.de>
parents: 637
diff changeset
187 * @return the created list
d0d95740071b add simple functions for creating lists
Mike Becker <universe@uap-core.de>
parents: 637
diff changeset
188 */
670
4ad8ea3aee49 allow NULL for allocator and comparator
Mike Becker <universe@uap-core.de>
parents: 669
diff changeset
189 #define cxArrayListCreateSimple(item_size, initial_capacity) \
4ad8ea3aee49 allow NULL for allocator and comparator
Mike Becker <universe@uap-core.de>
parents: 669
diff changeset
190 cxArrayListCreate(NULL, NULL, item_size, initial_capacity)
606
314e9288af2f add array list tests
Mike Becker <universe@uap-core.de>
parents:
diff changeset
191
314e9288af2f add array list tests
Mike Becker <universe@uap-core.de>
parents:
diff changeset
192 #ifdef __cplusplus
628
1e2be40f0cb5 use //-style single line comments everywhere
Mike Becker <universe@uap-core.de>
parents: 623
diff changeset
193 } // extern "C"
606
314e9288af2f add array list tests
Mike Becker <universe@uap-core.de>
parents:
diff changeset
194 #endif
314e9288af2f add array list tests
Mike Becker <universe@uap-core.de>
parents:
diff changeset
195
628
1e2be40f0cb5 use //-style single line comments everywhere
Mike Becker <universe@uap-core.de>
parents: 623
diff changeset
196 #endif // UCX_ARRAY_LIST_H

mercurial