Mon, 11 Nov 2024 21:42:14 +0100
simplify cx_array_copy() - fixes #474
606 | 1 | /* |
2 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. | |
3 | * | |
4 | * Copyright 2021 Mike Becker, Olaf Wintermann All rights reserved. | |
5 | * | |
6 | * Redistribution and use in source and binary forms, with or without | |
7 | * modification, are permitted provided that the following conditions are met: | |
8 | * | |
9 | * 1. Redistributions of source code must retain the above copyright | |
10 | * notice, this list of conditions and the following disclaimer. | |
11 | * | |
12 | * 2. Redistributions in binary form must reproduce the above copyright | |
13 | * notice, this list of conditions and the following disclaimer in the | |
14 | * documentation and/or other materials provided with the distribution. | |
15 | * | |
16 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" | |
17 | * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | |
18 | * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE | |
19 | * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE | |
20 | * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR | |
21 | * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF | |
22 | * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS | |
23 | * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN | |
24 | * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) | |
25 | * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE | |
26 | * POSSIBILITY OF SUCH DAMAGE. | |
27 | */ | |
28 | /** | |
29 | * \file array_list.h | |
30 | * \brief Array list implementation. | |
31 | * \author Mike Becker | |
32 | * \author Olaf Wintermann | |
33 | * \copyright 2-Clause BSD License | |
34 | */ | |
35 | ||
36 | ||
37 | #ifndef UCX_ARRAY_LIST_H | |
38 | #define UCX_ARRAY_LIST_H | |
39 | ||
617
cec11387c1be
fix include in array_list.h
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
612
diff
changeset
|
40 | #include "list.h" |
606 | 41 | |
42 | #ifdef __cplusplus | |
43 | extern "C" { | |
44 | #endif | |
45 | ||
46 | /** | |
985
68754c7de906
major refactoring of attributes
Mike Becker <universe@uap-core.de>
parents:
953
diff
changeset
|
47 | * The maximum item size in an array list that fits into stack buffer |
68754c7de906
major refactoring of attributes
Mike Becker <universe@uap-core.de>
parents:
953
diff
changeset
|
48 | * when swapped. |
804
5136f2fc32ec
add CX_DISABLE_ARRAY_LIST_SWAP_SBO flag
Mike Becker <universe@uap-core.de>
parents:
795
diff
changeset
|
49 | */ |
926
8fdd8d78c14b
fix several survivors of east-const and some missing consts
Mike Becker <universe@uap-core.de>
parents:
891
diff
changeset
|
50 | extern const unsigned cx_array_swap_sbo_size; |
804
5136f2fc32ec
add CX_DISABLE_ARRAY_LIST_SWAP_SBO flag
Mike Becker <universe@uap-core.de>
parents:
795
diff
changeset
|
51 | |
5136f2fc32ec
add CX_DISABLE_ARRAY_LIST_SWAP_SBO flag
Mike Becker <universe@uap-core.de>
parents:
795
diff
changeset
|
52 | /** |
831
7970eac1c598
add convenience macros for cx_array_*
Mike Becker <universe@uap-core.de>
parents:
819
diff
changeset
|
53 | * Declares variables for an array that can be used with the convenience macros. |
7970eac1c598
add convenience macros for cx_array_*
Mike Becker <universe@uap-core.de>
parents:
819
diff
changeset
|
54 | * |
7970eac1c598
add convenience macros for cx_array_*
Mike Becker <universe@uap-core.de>
parents:
819
diff
changeset
|
55 | * @see cx_array_simple_add() |
7970eac1c598
add convenience macros for cx_array_*
Mike Becker <universe@uap-core.de>
parents:
819
diff
changeset
|
56 | * @see cx_array_simple_copy() |
834
04c53b3c8378
capitalize cx_array_declare()
Mike Becker <universe@uap-core.de>
parents:
832
diff
changeset
|
57 | * @see cx_array_initialize() |
883
3012e9b4214e
add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents:
855
diff
changeset
|
58 | * @see cx_array_simple_add_sorted() |
3012e9b4214e
add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents:
855
diff
changeset
|
59 | * @see cx_array_simple_insert_sorted() |
831
7970eac1c598
add convenience macros for cx_array_*
Mike Becker <universe@uap-core.de>
parents:
819
diff
changeset
|
60 | */ |
834
04c53b3c8378
capitalize cx_array_declare()
Mike Becker <universe@uap-core.de>
parents:
832
diff
changeset
|
61 | #define CX_ARRAY_DECLARE(type, name) \ |
831
7970eac1c598
add convenience macros for cx_array_*
Mike Becker <universe@uap-core.de>
parents:
819
diff
changeset
|
62 | type * name; \ |
7970eac1c598
add convenience macros for cx_array_*
Mike Becker <universe@uap-core.de>
parents:
819
diff
changeset
|
63 | size_t name##_size; \ |
844
3270ea9e41ef
fix another superfluous semicolon...
Mike Becker <universe@uap-core.de>
parents:
843
diff
changeset
|
64 | size_t name##_capacity |
831
7970eac1c598
add convenience macros for cx_array_*
Mike Becker <universe@uap-core.de>
parents:
819
diff
changeset
|
65 | |
7970eac1c598
add convenience macros for cx_array_*
Mike Becker <universe@uap-core.de>
parents:
819
diff
changeset
|
66 | /** |
834
04c53b3c8378
capitalize cx_array_declare()
Mike Becker <universe@uap-core.de>
parents:
832
diff
changeset
|
67 | * Initializes an array declared with CX_ARRAY_DECLARE(). |
832
97df2e4c68fb
make cx_array_simple_add() automatically take the address of the element
Mike Becker <universe@uap-core.de>
parents:
831
diff
changeset
|
68 | * |
97df2e4c68fb
make cx_array_simple_add() automatically take the address of the element
Mike Becker <universe@uap-core.de>
parents:
831
diff
changeset
|
69 | * The memory for the array is allocated with stdlib malloc(). |
97df2e4c68fb
make cx_array_simple_add() automatically take the address of the element
Mike Becker <universe@uap-core.de>
parents:
831
diff
changeset
|
70 | * @param array the array |
97df2e4c68fb
make cx_array_simple_add() automatically take the address of the element
Mike Becker <universe@uap-core.de>
parents:
831
diff
changeset
|
71 | * @param capacity the initial capacity |
97df2e4c68fb
make cx_array_simple_add() automatically take the address of the element
Mike Becker <universe@uap-core.de>
parents:
831
diff
changeset
|
72 | */ |
97df2e4c68fb
make cx_array_simple_add() automatically take the address of the element
Mike Becker <universe@uap-core.de>
parents:
831
diff
changeset
|
73 | #define cx_array_initialize(array, capacity) \ |
97df2e4c68fb
make cx_array_simple_add() automatically take the address of the element
Mike Becker <universe@uap-core.de>
parents:
831
diff
changeset
|
74 | array##_capacity = capacity; \ |
97df2e4c68fb
make cx_array_simple_add() automatically take the address of the element
Mike Becker <universe@uap-core.de>
parents:
831
diff
changeset
|
75 | array##_size = 0; \ |
843
7d2959b7fff2
fix superfluous semicolon
Mike Becker <universe@uap-core.de>
parents:
834
diff
changeset
|
76 | array = malloc(sizeof(array[0]) * capacity) |
832
97df2e4c68fb
make cx_array_simple_add() automatically take the address of the element
Mike Becker <universe@uap-core.de>
parents:
831
diff
changeset
|
77 | |
97df2e4c68fb
make cx_array_simple_add() automatically take the address of the element
Mike Becker <universe@uap-core.de>
parents:
831
diff
changeset
|
78 | /** |
608
2e93521145ac
proposal for a low level array copy
Mike Becker <universe@uap-core.de>
parents:
606
diff
changeset
|
79 | * Defines a reallocation mechanism for arrays. |
2e93521145ac
proposal for a low level array copy
Mike Becker <universe@uap-core.de>
parents:
606
diff
changeset
|
80 | */ |
2e93521145ac
proposal for a low level array copy
Mike Becker <universe@uap-core.de>
parents:
606
diff
changeset
|
81 | struct cx_array_reallocator_s { |
2e93521145ac
proposal for a low level array copy
Mike Becker <universe@uap-core.de>
parents:
606
diff
changeset
|
82 | /** |
831
7970eac1c598
add convenience macros for cx_array_*
Mike Becker <universe@uap-core.de>
parents:
819
diff
changeset
|
83 | * Reallocates space for the given array. |
608
2e93521145ac
proposal for a low level array copy
Mike Becker <universe@uap-core.de>
parents:
606
diff
changeset
|
84 | * |
2e93521145ac
proposal for a low level array copy
Mike Becker <universe@uap-core.de>
parents:
606
diff
changeset
|
85 | * Implementations are not required to free the original array. |
831
7970eac1c598
add convenience macros for cx_array_*
Mike Becker <universe@uap-core.de>
parents:
819
diff
changeset
|
86 | * This allows reallocation of static memory by allocating heap memory |
795
00ba1bfa4ab4
fix documentation of reallocator struct
Mike Becker <universe@uap-core.de>
parents:
763
diff
changeset
|
87 | * and copying the array contents. The information in the custom fields of |
00ba1bfa4ab4
fix documentation of reallocator struct
Mike Becker <universe@uap-core.de>
parents:
763
diff
changeset
|
88 | * the referenced allocator can be used to track the state of the memory |
00ba1bfa4ab4
fix documentation of reallocator struct
Mike Becker <universe@uap-core.de>
parents:
763
diff
changeset
|
89 | * or to transport other additional data. |
608
2e93521145ac
proposal for a low level array copy
Mike Becker <universe@uap-core.de>
parents:
606
diff
changeset
|
90 | * |
2e93521145ac
proposal for a low level array copy
Mike Becker <universe@uap-core.de>
parents:
606
diff
changeset
|
91 | * @param array the array to reallocate |
2e93521145ac
proposal for a low level array copy
Mike Becker <universe@uap-core.de>
parents:
606
diff
changeset
|
92 | * @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
|
93 | * @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
|
94 | * @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
|
95 | * @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
|
96 | */ |
985
68754c7de906
major refactoring of attributes
Mike Becker <universe@uap-core.de>
parents:
953
diff
changeset
|
97 | cx_attr_nodiscard |
68754c7de906
major refactoring of attributes
Mike Becker <universe@uap-core.de>
parents:
953
diff
changeset
|
98 | cx_attr_nonnull_arg(4) |
68754c7de906
major refactoring of attributes
Mike Becker <universe@uap-core.de>
parents:
953
diff
changeset
|
99 | cx_attr_allocsize(2, 3) |
608
2e93521145ac
proposal for a low level array copy
Mike Becker <universe@uap-core.de>
parents:
606
diff
changeset
|
100 | void *(*realloc)( |
2e93521145ac
proposal for a low level array copy
Mike Becker <universe@uap-core.de>
parents:
606
diff
changeset
|
101 | void *array, |
2e93521145ac
proposal for a low level array copy
Mike Becker <universe@uap-core.de>
parents:
606
diff
changeset
|
102 | size_t capacity, |
2e93521145ac
proposal for a low level array copy
Mike Becker <universe@uap-core.de>
parents:
606
diff
changeset
|
103 | size_t elem_size, |
609
6ae8146d9f62
more custom data for array re-allocator
Mike Becker <universe@uap-core.de>
parents:
608
diff
changeset
|
104 | 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
|
105 | ); |
2e93521145ac
proposal for a low level array copy
Mike Becker <universe@uap-core.de>
parents:
606
diff
changeset
|
106 | |
2e93521145ac
proposal for a low level array copy
Mike Becker <universe@uap-core.de>
parents:
606
diff
changeset
|
107 | /** |
609
6ae8146d9f62
more custom data for array re-allocator
Mike Becker <universe@uap-core.de>
parents:
608
diff
changeset
|
108 | * Custom data pointer. |
6ae8146d9f62
more custom data for array re-allocator
Mike Becker <universe@uap-core.de>
parents:
608
diff
changeset
|
109 | */ |
6ae8146d9f62
more custom data for array re-allocator
Mike Becker <universe@uap-core.de>
parents:
608
diff
changeset
|
110 | void *ptr1; |
6ae8146d9f62
more custom data for array re-allocator
Mike Becker <universe@uap-core.de>
parents:
608
diff
changeset
|
111 | /** |
6ae8146d9f62
more custom data for array re-allocator
Mike Becker <universe@uap-core.de>
parents:
608
diff
changeset
|
112 | * Custom data pointer. |
608
2e93521145ac
proposal for a low level array copy
Mike Becker <universe@uap-core.de>
parents:
606
diff
changeset
|
113 | */ |
609
6ae8146d9f62
more custom data for array re-allocator
Mike Becker <universe@uap-core.de>
parents:
608
diff
changeset
|
114 | void *ptr2; |
6ae8146d9f62
more custom data for array re-allocator
Mike Becker <universe@uap-core.de>
parents:
608
diff
changeset
|
115 | /** |
6ae8146d9f62
more custom data for array re-allocator
Mike Becker <universe@uap-core.de>
parents:
608
diff
changeset
|
116 | * Custom data integer. |
6ae8146d9f62
more custom data for array re-allocator
Mike Becker <universe@uap-core.de>
parents:
608
diff
changeset
|
117 | */ |
6ae8146d9f62
more custom data for array re-allocator
Mike Becker <universe@uap-core.de>
parents:
608
diff
changeset
|
118 | size_t int1; |
6ae8146d9f62
more custom data for array re-allocator
Mike Becker <universe@uap-core.de>
parents:
608
diff
changeset
|
119 | /** |
6ae8146d9f62
more custom data for array re-allocator
Mike Becker <universe@uap-core.de>
parents:
608
diff
changeset
|
120 | * Custom data integer. |
6ae8146d9f62
more custom data for array re-allocator
Mike Becker <universe@uap-core.de>
parents:
608
diff
changeset
|
121 | */ |
6ae8146d9f62
more custom data for array re-allocator
Mike Becker <universe@uap-core.de>
parents:
608
diff
changeset
|
122 | size_t int2; |
608
2e93521145ac
proposal for a low level array copy
Mike Becker <universe@uap-core.de>
parents:
606
diff
changeset
|
123 | }; |
2e93521145ac
proposal for a low level array copy
Mike Becker <universe@uap-core.de>
parents:
606
diff
changeset
|
124 | |
2e93521145ac
proposal for a low level array copy
Mike Becker <universe@uap-core.de>
parents:
606
diff
changeset
|
125 | /** |
953
581ad4fd01e9
add function to create array reallocator that can move arrays from stack to heap
Mike Becker <universe@uap-core.de>
parents:
926
diff
changeset
|
126 | * Typedef for the array reallocator struct. |
581ad4fd01e9
add function to create array reallocator that can move arrays from stack to heap
Mike Becker <universe@uap-core.de>
parents:
926
diff
changeset
|
127 | */ |
581ad4fd01e9
add function to create array reallocator that can move arrays from stack to heap
Mike Becker <universe@uap-core.de>
parents:
926
diff
changeset
|
128 | typedef struct cx_array_reallocator_s CxArrayReallocator; |
581ad4fd01e9
add function to create array reallocator that can move arrays from stack to heap
Mike Becker <universe@uap-core.de>
parents:
926
diff
changeset
|
129 | |
581ad4fd01e9
add function to create array reallocator that can move arrays from stack to heap
Mike Becker <universe@uap-core.de>
parents:
926
diff
changeset
|
130 | /** |
817
949908c97474
add cx_array_default_reallocator
Mike Becker <universe@uap-core.de>
parents:
807
diff
changeset
|
131 | * A default stdlib-based array reallocator. |
949908c97474
add cx_array_default_reallocator
Mike Becker <universe@uap-core.de>
parents:
807
diff
changeset
|
132 | */ |
818
2be8fe3d5a2d
add cx_array_add() + fix type of cx_array_default_reallocator
Mike Becker <universe@uap-core.de>
parents:
817
diff
changeset
|
133 | extern struct cx_array_reallocator_s *cx_array_default_reallocator; |
817
949908c97474
add cx_array_default_reallocator
Mike Becker <universe@uap-core.de>
parents:
807
diff
changeset
|
134 | |
949908c97474
add cx_array_default_reallocator
Mike Becker <universe@uap-core.de>
parents:
807
diff
changeset
|
135 | /** |
953
581ad4fd01e9
add function to create array reallocator that can move arrays from stack to heap
Mike Becker <universe@uap-core.de>
parents:
926
diff
changeset
|
136 | * Creates a new array reallocator. |
581ad4fd01e9
add function to create array reallocator that can move arrays from stack to heap
Mike Becker <universe@uap-core.de>
parents:
926
diff
changeset
|
137 | * |
581ad4fd01e9
add function to create array reallocator that can move arrays from stack to heap
Mike Becker <universe@uap-core.de>
parents:
926
diff
changeset
|
138 | * When \p allocator is \c NULL, the stdlib default allocator will be used. |
581ad4fd01e9
add function to create array reallocator that can move arrays from stack to heap
Mike Becker <universe@uap-core.de>
parents:
926
diff
changeset
|
139 | * |
581ad4fd01e9
add function to create array reallocator that can move arrays from stack to heap
Mike Becker <universe@uap-core.de>
parents:
926
diff
changeset
|
140 | * When \p stackmem is not \c NULL, the reallocator is supposed to be used |
581ad4fd01e9
add function to create array reallocator that can move arrays from stack to heap
Mike Becker <universe@uap-core.de>
parents:
926
diff
changeset
|
141 | * \em only for the specific array that is initially located at \p stackmem. |
581ad4fd01e9
add function to create array reallocator that can move arrays from stack to heap
Mike Becker <universe@uap-core.de>
parents:
926
diff
changeset
|
142 | * When reallocation is needed, the reallocator checks, if the array is |
581ad4fd01e9
add function to create array reallocator that can move arrays from stack to heap
Mike Becker <universe@uap-core.de>
parents:
926
diff
changeset
|
143 | * still located at \p stackmem and copies the contents to the heap. |
581ad4fd01e9
add function to create array reallocator that can move arrays from stack to heap
Mike Becker <universe@uap-core.de>
parents:
926
diff
changeset
|
144 | * |
581ad4fd01e9
add function to create array reallocator that can move arrays from stack to heap
Mike Becker <universe@uap-core.de>
parents:
926
diff
changeset
|
145 | * @param allocator the allocator this reallocator shall be based on |
581ad4fd01e9
add function to create array reallocator that can move arrays from stack to heap
Mike Becker <universe@uap-core.de>
parents:
926
diff
changeset
|
146 | * @param stackmem the address of the array when the array is initially located |
581ad4fd01e9
add function to create array reallocator that can move arrays from stack to heap
Mike Becker <universe@uap-core.de>
parents:
926
diff
changeset
|
147 | * on the stack |
581ad4fd01e9
add function to create array reallocator that can move arrays from stack to heap
Mike Becker <universe@uap-core.de>
parents:
926
diff
changeset
|
148 | * @return an array reallocator |
581ad4fd01e9
add function to create array reallocator that can move arrays from stack to heap
Mike Becker <universe@uap-core.de>
parents:
926
diff
changeset
|
149 | */ |
581ad4fd01e9
add function to create array reallocator that can move arrays from stack to heap
Mike Becker <universe@uap-core.de>
parents:
926
diff
changeset
|
150 | struct cx_array_reallocator_s cx_array_reallocator( |
581ad4fd01e9
add function to create array reallocator that can move arrays from stack to heap
Mike Becker <universe@uap-core.de>
parents:
926
diff
changeset
|
151 | const struct cx_allocator_s *allocator, |
581ad4fd01e9
add function to create array reallocator that can move arrays from stack to heap
Mike Becker <universe@uap-core.de>
parents:
926
diff
changeset
|
152 | const void *stackmem |
581ad4fd01e9
add function to create array reallocator that can move arrays from stack to heap
Mike Becker <universe@uap-core.de>
parents:
926
diff
changeset
|
153 | ); |
581ad4fd01e9
add function to create array reallocator that can move arrays from stack to heap
Mike Becker <universe@uap-core.de>
parents:
926
diff
changeset
|
154 | |
581ad4fd01e9
add function to create array reallocator that can move arrays from stack to heap
Mike Becker <universe@uap-core.de>
parents:
926
diff
changeset
|
155 | /** |
608
2e93521145ac
proposal for a low level array copy
Mike Becker <universe@uap-core.de>
parents:
606
diff
changeset
|
156 | * 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
|
157 | * |
2e93521145ac
proposal for a low level array copy
Mike Becker <universe@uap-core.de>
parents:
606
diff
changeset
|
158 | * 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
|
159 | * 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
|
160 | * the current array \p size. If the new index plus the number of elements added |
986
38fa7e41194c
simplify cx_array_copy() - fixes #474
Mike Becker <universe@uap-core.de>
parents:
985
diff
changeset
|
161 | * would extend the array's size, the remaining \p capacity is used. |
608
2e93521145ac
proposal for a low level array copy
Mike Becker <universe@uap-core.de>
parents:
606
diff
changeset
|
162 | * |
986
38fa7e41194c
simplify cx_array_copy() - fixes #474
Mike Becker <universe@uap-core.de>
parents:
985
diff
changeset
|
163 | * If the \p capacity is also insufficient to hold the new data, a reallocation |
38fa7e41194c
simplify cx_array_copy() - fixes #474
Mike Becker <universe@uap-core.de>
parents:
985
diff
changeset
|
164 | * attempt is made with the specified \p reallocator. |
608
2e93521145ac
proposal for a low level array copy
Mike Becker <universe@uap-core.de>
parents:
606
diff
changeset
|
165 | * |
831
7970eac1c598
add convenience macros for cx_array_*
Mike Becker <universe@uap-core.de>
parents:
819
diff
changeset
|
166 | * @param target a pointer to the target array |
608
2e93521145ac
proposal for a low level array copy
Mike Becker <universe@uap-core.de>
parents:
606
diff
changeset
|
167 | * @param size a pointer to the size of the target array |
986
38fa7e41194c
simplify cx_array_copy() - fixes #474
Mike Becker <universe@uap-core.de>
parents:
985
diff
changeset
|
168 | * @param capacity a pointer to the capacity of the target array |
608
2e93521145ac
proposal for a low level array copy
Mike Becker <universe@uap-core.de>
parents:
606
diff
changeset
|
169 | * @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
|
170 | * @param src the source array |
2e93521145ac
proposal for a low level array copy
Mike Becker <universe@uap-core.de>
parents:
606
diff
changeset
|
171 | * @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
|
172 | * @param elem_count the number of elements to copy |
986
38fa7e41194c
simplify cx_array_copy() - fixes #474
Mike Becker <universe@uap-core.de>
parents:
985
diff
changeset
|
173 | * @param reallocator the array reallocator to use |
38fa7e41194c
simplify cx_array_copy() - fixes #474
Mike Becker <universe@uap-core.de>
parents:
985
diff
changeset
|
174 | * @return zero on success, non-zero on failure |
608
2e93521145ac
proposal for a low level array copy
Mike Becker <universe@uap-core.de>
parents:
606
diff
changeset
|
175 | */ |
986
38fa7e41194c
simplify cx_array_copy() - fixes #474
Mike Becker <universe@uap-core.de>
parents:
985
diff
changeset
|
176 | cx_attr_nonnull |
38fa7e41194c
simplify cx_array_copy() - fixes #474
Mike Becker <universe@uap-core.de>
parents:
985
diff
changeset
|
177 | int cx_array_copy( |
608
2e93521145ac
proposal for a low level array copy
Mike Becker <universe@uap-core.de>
parents:
606
diff
changeset
|
178 | void **target, |
2e93521145ac
proposal for a low level array copy
Mike Becker <universe@uap-core.de>
parents:
606
diff
changeset
|
179 | size_t *size, |
2e93521145ac
proposal for a low level array copy
Mike Becker <universe@uap-core.de>
parents:
606
diff
changeset
|
180 | size_t *capacity, |
2e93521145ac
proposal for a low level array copy
Mike Becker <universe@uap-core.de>
parents:
606
diff
changeset
|
181 | size_t index, |
890
54565fd74e74
move all const keywords to the west - fixes #426
Mike Becker <universe@uap-core.de>
parents:
887
diff
changeset
|
182 | const void *src, |
608
2e93521145ac
proposal for a low level array copy
Mike Becker <universe@uap-core.de>
parents:
606
diff
changeset
|
183 | size_t elem_size, |
2e93521145ac
proposal for a low level array copy
Mike Becker <universe@uap-core.de>
parents:
606
diff
changeset
|
184 | size_t elem_count, |
610
de5d3ee6435f
#219 array list: implement add and at
Mike Becker <universe@uap-core.de>
parents:
609
diff
changeset
|
185 | struct cx_array_reallocator_s *reallocator |
891
49d8cff6f0ee
make all function attributes leading - fixes #425
Mike Becker <universe@uap-core.de>
parents:
890
diff
changeset
|
186 | ); |
608
2e93521145ac
proposal for a low level array copy
Mike Becker <universe@uap-core.de>
parents:
606
diff
changeset
|
187 | |
818
2be8fe3d5a2d
add cx_array_add() + fix type of cx_array_default_reallocator
Mike Becker <universe@uap-core.de>
parents:
817
diff
changeset
|
188 | /** |
986
38fa7e41194c
simplify cx_array_copy() - fixes #474
Mike Becker <universe@uap-core.de>
parents:
985
diff
changeset
|
189 | * Convenience macro that uses cx_array_copy() with a default layout and |
38fa7e41194c
simplify cx_array_copy() - fixes #474
Mike Becker <universe@uap-core.de>
parents:
985
diff
changeset
|
190 | * the default reallocator. |
831
7970eac1c598
add convenience macros for cx_array_*
Mike Becker <universe@uap-core.de>
parents:
819
diff
changeset
|
191 | * |
7970eac1c598
add convenience macros for cx_array_*
Mike Becker <universe@uap-core.de>
parents:
819
diff
changeset
|
192 | * @param array the name of the array (NOT a pointer to the array) |
7970eac1c598
add convenience macros for cx_array_*
Mike Becker <universe@uap-core.de>
parents:
819
diff
changeset
|
193 | * @param index the index where the copied elements shall be placed |
7970eac1c598
add convenience macros for cx_array_*
Mike Becker <universe@uap-core.de>
parents:
819
diff
changeset
|
194 | * @param src the source array |
7970eac1c598
add convenience macros for cx_array_*
Mike Becker <universe@uap-core.de>
parents:
819
diff
changeset
|
195 | * @param count the number of elements to copy |
986
38fa7e41194c
simplify cx_array_copy() - fixes #474
Mike Becker <universe@uap-core.de>
parents:
985
diff
changeset
|
196 | * @return zero on success, non-zero on failure |
883
3012e9b4214e
add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents:
855
diff
changeset
|
197 | * @see CX_ARRAY_DECLARE() |
831
7970eac1c598
add convenience macros for cx_array_*
Mike Becker <universe@uap-core.de>
parents:
819
diff
changeset
|
198 | */ |
7970eac1c598
add convenience macros for cx_array_*
Mike Becker <universe@uap-core.de>
parents:
819
diff
changeset
|
199 | #define cx_array_simple_copy(array, index, src, count) \ |
7970eac1c598
add convenience macros for cx_array_*
Mike Becker <universe@uap-core.de>
parents:
819
diff
changeset
|
200 | cx_array_copy((void**)&(array), &(array##_size), &(array##_capacity), \ |
7970eac1c598
add convenience macros for cx_array_*
Mike Becker <universe@uap-core.de>
parents:
819
diff
changeset
|
201 | index, src, sizeof((array)[0]), count, cx_array_default_reallocator) |
7970eac1c598
add convenience macros for cx_array_*
Mike Becker <universe@uap-core.de>
parents:
819
diff
changeset
|
202 | |
7970eac1c598
add convenience macros for cx_array_*
Mike Becker <universe@uap-core.de>
parents:
819
diff
changeset
|
203 | /** |
818
2be8fe3d5a2d
add cx_array_add() + fix type of cx_array_default_reallocator
Mike Becker <universe@uap-core.de>
parents:
817
diff
changeset
|
204 | * Adds an element to an array with the possibility of allocating more space. |
2be8fe3d5a2d
add cx_array_add() + fix type of cx_array_default_reallocator
Mike Becker <universe@uap-core.de>
parents:
817
diff
changeset
|
205 | * |
986
38fa7e41194c
simplify cx_array_copy() - fixes #474
Mike Becker <universe@uap-core.de>
parents:
985
diff
changeset
|
206 | * The element \p elem is added to the end of the \p target array which contains |
38fa7e41194c
simplify cx_array_copy() - fixes #474
Mike Becker <universe@uap-core.de>
parents:
985
diff
changeset
|
207 | * \p size elements, already. The \p capacity must point to a variable denoting |
38fa7e41194c
simplify cx_array_copy() - fixes #474
Mike Becker <universe@uap-core.de>
parents:
985
diff
changeset
|
208 | * the current maximum number of elements the array can hold. |
818
2be8fe3d5a2d
add cx_array_add() + fix type of cx_array_default_reallocator
Mike Becker <universe@uap-core.de>
parents:
817
diff
changeset
|
209 | * |
986
38fa7e41194c
simplify cx_array_copy() - fixes #474
Mike Becker <universe@uap-core.de>
parents:
985
diff
changeset
|
210 | * If the capacity is insufficient to hold the new element, an attempt to |
38fa7e41194c
simplify cx_array_copy() - fixes #474
Mike Becker <universe@uap-core.de>
parents:
985
diff
changeset
|
211 | * increase the \p capacity is made and the new capacity is written back. |
818
2be8fe3d5a2d
add cx_array_add() + fix type of cx_array_default_reallocator
Mike Becker <universe@uap-core.de>
parents:
817
diff
changeset
|
212 | * |
831
7970eac1c598
add convenience macros for cx_array_*
Mike Becker <universe@uap-core.de>
parents:
819
diff
changeset
|
213 | * @param target a pointer to the target array |
818
2be8fe3d5a2d
add cx_array_add() + fix type of cx_array_default_reallocator
Mike Becker <universe@uap-core.de>
parents:
817
diff
changeset
|
214 | * @param size a pointer to the size of the target array |
986
38fa7e41194c
simplify cx_array_copy() - fixes #474
Mike Becker <universe@uap-core.de>
parents:
985
diff
changeset
|
215 | * @param capacity a pointer to the capacity of the target array |
818
2be8fe3d5a2d
add cx_array_add() + fix type of cx_array_default_reallocator
Mike Becker <universe@uap-core.de>
parents:
817
diff
changeset
|
216 | * @param elem_size the size of one element |
832
97df2e4c68fb
make cx_array_simple_add() automatically take the address of the element
Mike Becker <universe@uap-core.de>
parents:
831
diff
changeset
|
217 | * @param elem a pointer to the element to add |
986
38fa7e41194c
simplify cx_array_copy() - fixes #474
Mike Becker <universe@uap-core.de>
parents:
985
diff
changeset
|
218 | * @param reallocator the array reallocator to use |
38fa7e41194c
simplify cx_array_copy() - fixes #474
Mike Becker <universe@uap-core.de>
parents:
985
diff
changeset
|
219 | * @return zero on success, non-zero on failure |
818
2be8fe3d5a2d
add cx_array_add() + fix type of cx_array_default_reallocator
Mike Becker <universe@uap-core.de>
parents:
817
diff
changeset
|
220 | */ |
2be8fe3d5a2d
add cx_array_add() + fix type of cx_array_default_reallocator
Mike Becker <universe@uap-core.de>
parents:
817
diff
changeset
|
221 | #define cx_array_add(target, size, capacity, elem_size, elem, reallocator) \ |
2be8fe3d5a2d
add cx_array_add() + fix type of cx_array_default_reallocator
Mike Becker <universe@uap-core.de>
parents:
817
diff
changeset
|
222 | cx_array_copy((void**)(target), size, capacity, *(size), elem, elem_size, 1, reallocator) |
623
21082350a590
#219 array list: implement reverse
Mike Becker <universe@uap-core.de>
parents:
617
diff
changeset
|
223 | |
21082350a590
#219 array list: implement reverse
Mike Becker <universe@uap-core.de>
parents:
617
diff
changeset
|
224 | /** |
883
3012e9b4214e
add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents:
855
diff
changeset
|
225 | * Convenience macro that uses cx_array_add() with a default layout and |
3012e9b4214e
add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents:
855
diff
changeset
|
226 | * the default reallocator. |
831
7970eac1c598
add convenience macros for cx_array_*
Mike Becker <universe@uap-core.de>
parents:
819
diff
changeset
|
227 | * |
7970eac1c598
add convenience macros for cx_array_*
Mike Becker <universe@uap-core.de>
parents:
819
diff
changeset
|
228 | * @param array the name of the array (NOT a pointer to the array) |
832
97df2e4c68fb
make cx_array_simple_add() automatically take the address of the element
Mike Becker <universe@uap-core.de>
parents:
831
diff
changeset
|
229 | * @param elem the element to add (NOT a pointer, address is automatically taken) |
986
38fa7e41194c
simplify cx_array_copy() - fixes #474
Mike Becker <universe@uap-core.de>
parents:
985
diff
changeset
|
230 | * @return zero on success, non-zero on failure |
883
3012e9b4214e
add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents:
855
diff
changeset
|
231 | * @see CX_ARRAY_DECLARE() |
831
7970eac1c598
add convenience macros for cx_array_*
Mike Becker <universe@uap-core.de>
parents:
819
diff
changeset
|
232 | */ |
7970eac1c598
add convenience macros for cx_array_*
Mike Becker <universe@uap-core.de>
parents:
819
diff
changeset
|
233 | #define cx_array_simple_add(array, elem) \ |
832
97df2e4c68fb
make cx_array_simple_add() automatically take the address of the element
Mike Becker <universe@uap-core.de>
parents:
831
diff
changeset
|
234 | cx_array_simple_copy(array, array##_size, &(elem), 1) |
831
7970eac1c598
add convenience macros for cx_array_*
Mike Becker <universe@uap-core.de>
parents:
819
diff
changeset
|
235 | |
883
3012e9b4214e
add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents:
855
diff
changeset
|
236 | |
3012e9b4214e
add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents:
855
diff
changeset
|
237 | /** |
3012e9b4214e
add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents:
855
diff
changeset
|
238 | * Inserts a sorted array into another sorted array. |
3012e9b4214e
add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents:
855
diff
changeset
|
239 | * |
3012e9b4214e
add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents:
855
diff
changeset
|
240 | * If either the target or the source array is not already sorted with respect |
3012e9b4214e
add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents:
855
diff
changeset
|
241 | * to the specified \p cmp_func, the behavior is undefined. |
3012e9b4214e
add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents:
855
diff
changeset
|
242 | * |
3012e9b4214e
add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents:
855
diff
changeset
|
243 | * If the capacity is insufficient to hold the new data, a reallocation |
3012e9b4214e
add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents:
855
diff
changeset
|
244 | * attempt is made. |
3012e9b4214e
add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents:
855
diff
changeset
|
245 | * |
3012e9b4214e
add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents:
855
diff
changeset
|
246 | * @param target a pointer to the target array |
3012e9b4214e
add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents:
855
diff
changeset
|
247 | * @param size a pointer to the size of the target array |
986
38fa7e41194c
simplify cx_array_copy() - fixes #474
Mike Becker <universe@uap-core.de>
parents:
985
diff
changeset
|
248 | * @param capacity a pointer to the capacity of the target array |
883
3012e9b4214e
add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents:
855
diff
changeset
|
249 | * @param cmp_func the compare function for the elements |
3012e9b4214e
add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents:
855
diff
changeset
|
250 | * @param src the source array |
3012e9b4214e
add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents:
855
diff
changeset
|
251 | * @param elem_size the size of one element |
3012e9b4214e
add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents:
855
diff
changeset
|
252 | * @param elem_count the number of elements to insert |
3012e9b4214e
add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents:
855
diff
changeset
|
253 | * @param reallocator the array reallocator to use |
986
38fa7e41194c
simplify cx_array_copy() - fixes #474
Mike Becker <universe@uap-core.de>
parents:
985
diff
changeset
|
254 | * @return zero on success, non-zero on failure |
883
3012e9b4214e
add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents:
855
diff
changeset
|
255 | */ |
985
68754c7de906
major refactoring of attributes
Mike Becker <universe@uap-core.de>
parents:
953
diff
changeset
|
256 | cx_attr_nonnull |
986
38fa7e41194c
simplify cx_array_copy() - fixes #474
Mike Becker <universe@uap-core.de>
parents:
985
diff
changeset
|
257 | int cx_array_insert_sorted( |
883
3012e9b4214e
add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents:
855
diff
changeset
|
258 | void **target, |
3012e9b4214e
add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents:
855
diff
changeset
|
259 | size_t *size, |
3012e9b4214e
add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents:
855
diff
changeset
|
260 | size_t *capacity, |
3012e9b4214e
add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents:
855
diff
changeset
|
261 | cx_compare_func cmp_func, |
890
54565fd74e74
move all const keywords to the west - fixes #426
Mike Becker <universe@uap-core.de>
parents:
887
diff
changeset
|
262 | const void *src, |
883
3012e9b4214e
add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents:
855
diff
changeset
|
263 | size_t elem_size, |
3012e9b4214e
add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents:
855
diff
changeset
|
264 | size_t elem_count, |
3012e9b4214e
add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents:
855
diff
changeset
|
265 | struct cx_array_reallocator_s *reallocator |
891
49d8cff6f0ee
make all function attributes leading - fixes #425
Mike Becker <universe@uap-core.de>
parents:
890
diff
changeset
|
266 | ); |
883
3012e9b4214e
add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents:
855
diff
changeset
|
267 | |
3012e9b4214e
add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents:
855
diff
changeset
|
268 | /** |
3012e9b4214e
add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents:
855
diff
changeset
|
269 | * Inserts an element into a sorted array. |
3012e9b4214e
add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents:
855
diff
changeset
|
270 | * |
3012e9b4214e
add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents:
855
diff
changeset
|
271 | * If the target array is not already sorted with respect |
3012e9b4214e
add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents:
855
diff
changeset
|
272 | * to the specified \p cmp_func, the behavior is undefined. |
3012e9b4214e
add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents:
855
diff
changeset
|
273 | * |
3012e9b4214e
add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents:
855
diff
changeset
|
274 | * If the capacity is insufficient to hold the new data, a reallocation |
3012e9b4214e
add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents:
855
diff
changeset
|
275 | * attempt is made. |
3012e9b4214e
add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents:
855
diff
changeset
|
276 | * |
3012e9b4214e
add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents:
855
diff
changeset
|
277 | * @param target a pointer to the target array |
3012e9b4214e
add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents:
855
diff
changeset
|
278 | * @param size a pointer to the size of the target array |
986
38fa7e41194c
simplify cx_array_copy() - fixes #474
Mike Becker <universe@uap-core.de>
parents:
985
diff
changeset
|
279 | * @param capacity a pointer to the capacity of the target array |
883
3012e9b4214e
add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents:
855
diff
changeset
|
280 | * @param elem_size the size of one element |
3012e9b4214e
add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents:
855
diff
changeset
|
281 | * @param elem a pointer to the element to add |
3012e9b4214e
add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents:
855
diff
changeset
|
282 | * @param reallocator the array reallocator to use |
986
38fa7e41194c
simplify cx_array_copy() - fixes #474
Mike Becker <universe@uap-core.de>
parents:
985
diff
changeset
|
283 | * @return zero on success, non-zero on failure |
883
3012e9b4214e
add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents:
855
diff
changeset
|
284 | */ |
3012e9b4214e
add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents:
855
diff
changeset
|
285 | #define cx_array_add_sorted(target, size, capacity, elem_size, elem, cmp_func, reallocator) \ |
3012e9b4214e
add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents:
855
diff
changeset
|
286 | cx_array_insert_sorted((void**)(target), size, capacity, cmp_func, elem, elem_size, 1, reallocator) |
3012e9b4214e
add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents:
855
diff
changeset
|
287 | |
3012e9b4214e
add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents:
855
diff
changeset
|
288 | /** |
3012e9b4214e
add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents:
855
diff
changeset
|
289 | * Convenience macro for cx_array_add_sorted() with a default |
3012e9b4214e
add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents:
855
diff
changeset
|
290 | * layout and the default reallocator. |
3012e9b4214e
add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents:
855
diff
changeset
|
291 | * |
3012e9b4214e
add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents:
855
diff
changeset
|
292 | * @param array the name of the array (NOT a pointer to the array) |
3012e9b4214e
add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents:
855
diff
changeset
|
293 | * @param elem the element to add (NOT a pointer, address is automatically taken) |
3012e9b4214e
add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents:
855
diff
changeset
|
294 | * @param cmp_func the compare function for the elements |
986
38fa7e41194c
simplify cx_array_copy() - fixes #474
Mike Becker <universe@uap-core.de>
parents:
985
diff
changeset
|
295 | * @return zero on success, non-zero on failure |
883
3012e9b4214e
add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents:
855
diff
changeset
|
296 | * @see CX_ARRAY_DECLARE() |
3012e9b4214e
add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents:
855
diff
changeset
|
297 | */ |
3012e9b4214e
add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents:
855
diff
changeset
|
298 | #define cx_array_simple_add_sorted(array, elem, cmp_func) \ |
3012e9b4214e
add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents:
855
diff
changeset
|
299 | cx_array_add_sorted(&array, &(array##_size), &(array##_capacity), \ |
3012e9b4214e
add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents:
855
diff
changeset
|
300 | sizeof((array)[0]), &(elem), cmp_func, cx_array_default_reallocator) |
3012e9b4214e
add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents:
855
diff
changeset
|
301 | |
3012e9b4214e
add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents:
855
diff
changeset
|
302 | /** |
3012e9b4214e
add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents:
855
diff
changeset
|
303 | * Convenience macro for cx_array_insert_sorted() with a default |
3012e9b4214e
add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents:
855
diff
changeset
|
304 | * layout and the default reallocator. |
3012e9b4214e
add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents:
855
diff
changeset
|
305 | * |
3012e9b4214e
add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents:
855
diff
changeset
|
306 | * @param array the name of the array (NOT a pointer to the array) |
3012e9b4214e
add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents:
855
diff
changeset
|
307 | * @param src pointer to the source array |
3012e9b4214e
add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents:
855
diff
changeset
|
308 | * @param n number of elements in the source array |
3012e9b4214e
add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents:
855
diff
changeset
|
309 | * @param cmp_func the compare function for the elements |
986
38fa7e41194c
simplify cx_array_copy() - fixes #474
Mike Becker <universe@uap-core.de>
parents:
985
diff
changeset
|
310 | * @return zero on success, non-zero on failure |
883
3012e9b4214e
add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents:
855
diff
changeset
|
311 | * @see CX_ARRAY_DECLARE() |
3012e9b4214e
add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents:
855
diff
changeset
|
312 | */ |
3012e9b4214e
add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents:
855
diff
changeset
|
313 | #define cx_array_simple_insert_sorted(array, src, n, cmp_func) \ |
3012e9b4214e
add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents:
855
diff
changeset
|
314 | cx_array_insert_sorted((void**)(&array), &(array##_size), &(array##_capacity), \ |
3012e9b4214e
add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents:
855
diff
changeset
|
315 | cmp_func, src, sizeof((array)[0]), n, cx_array_default_reallocator) |
3012e9b4214e
add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents:
855
diff
changeset
|
316 | |
884
d375d8056262
add cx_array_binary_search() - fixes #424
Mike Becker <universe@uap-core.de>
parents:
883
diff
changeset
|
317 | |
d375d8056262
add cx_array_binary_search() - fixes #424
Mike Becker <universe@uap-core.de>
parents:
883
diff
changeset
|
318 | /** |
d375d8056262
add cx_array_binary_search() - fixes #424
Mike Becker <universe@uap-core.de>
parents:
883
diff
changeset
|
319 | * Searches the largest lower bound in a sorted array. |
d375d8056262
add cx_array_binary_search() - fixes #424
Mike Becker <universe@uap-core.de>
parents:
883
diff
changeset
|
320 | * |
d375d8056262
add cx_array_binary_search() - fixes #424
Mike Becker <universe@uap-core.de>
parents:
883
diff
changeset
|
321 | * In other words, this function returns the index of the largest element |
d375d8056262
add cx_array_binary_search() - fixes #424
Mike Becker <universe@uap-core.de>
parents:
883
diff
changeset
|
322 | * in \p arr that is less or equal to \p elem with respect to \p cmp_func. |
885
878a450e79bd
fixes incorrect result from cx_array_binary_search() when searched element is smaller than the entire array
Mike Becker <universe@uap-core.de>
parents:
884
diff
changeset
|
323 | * When no such element exists, \p size is returned. |
884
d375d8056262
add cx_array_binary_search() - fixes #424
Mike Becker <universe@uap-core.de>
parents:
883
diff
changeset
|
324 | * |
d375d8056262
add cx_array_binary_search() - fixes #424
Mike Becker <universe@uap-core.de>
parents:
883
diff
changeset
|
325 | * If \p elem is contained in the array, this is identical to |
d375d8056262
add cx_array_binary_search() - fixes #424
Mike Becker <universe@uap-core.de>
parents:
883
diff
changeset
|
326 | * #cx_array_binary_search(). |
d375d8056262
add cx_array_binary_search() - fixes #424
Mike Becker <universe@uap-core.de>
parents:
883
diff
changeset
|
327 | * |
d375d8056262
add cx_array_binary_search() - fixes #424
Mike Becker <universe@uap-core.de>
parents:
883
diff
changeset
|
328 | * If the array is not sorted with respect to the \p cmp_func, the behavior |
d375d8056262
add cx_array_binary_search() - fixes #424
Mike Becker <universe@uap-core.de>
parents:
883
diff
changeset
|
329 | * is undefined. |
d375d8056262
add cx_array_binary_search() - fixes #424
Mike Becker <universe@uap-core.de>
parents:
883
diff
changeset
|
330 | * |
d375d8056262
add cx_array_binary_search() - fixes #424
Mike Becker <universe@uap-core.de>
parents:
883
diff
changeset
|
331 | * @param arr the array to search |
d375d8056262
add cx_array_binary_search() - fixes #424
Mike Becker <universe@uap-core.de>
parents:
883
diff
changeset
|
332 | * @param size the size of the array |
d375d8056262
add cx_array_binary_search() - fixes #424
Mike Becker <universe@uap-core.de>
parents:
883
diff
changeset
|
333 | * @param elem_size the size of one element |
d375d8056262
add cx_array_binary_search() - fixes #424
Mike Becker <universe@uap-core.de>
parents:
883
diff
changeset
|
334 | * @param elem the element to find |
d375d8056262
add cx_array_binary_search() - fixes #424
Mike Becker <universe@uap-core.de>
parents:
883
diff
changeset
|
335 | * @param cmp_func the compare function |
887 | 336 | * @return the index of the largest lower bound, or \p size |
884
d375d8056262
add cx_array_binary_search() - fixes #424
Mike Becker <universe@uap-core.de>
parents:
883
diff
changeset
|
337 | */ |
985
68754c7de906
major refactoring of attributes
Mike Becker <universe@uap-core.de>
parents:
953
diff
changeset
|
338 | cx_attr_nonnull |
884
d375d8056262
add cx_array_binary_search() - fixes #424
Mike Becker <universe@uap-core.de>
parents:
883
diff
changeset
|
339 | size_t cx_array_binary_search_inf( |
890
54565fd74e74
move all const keywords to the west - fixes #426
Mike Becker <universe@uap-core.de>
parents:
887
diff
changeset
|
340 | const void *arr, |
884
d375d8056262
add cx_array_binary_search() - fixes #424
Mike Becker <universe@uap-core.de>
parents:
883
diff
changeset
|
341 | size_t size, |
d375d8056262
add cx_array_binary_search() - fixes #424
Mike Becker <universe@uap-core.de>
parents:
883
diff
changeset
|
342 | size_t elem_size, |
890
54565fd74e74
move all const keywords to the west - fixes #426
Mike Becker <universe@uap-core.de>
parents:
887
diff
changeset
|
343 | const void *elem, |
884
d375d8056262
add cx_array_binary_search() - fixes #424
Mike Becker <universe@uap-core.de>
parents:
883
diff
changeset
|
344 | cx_compare_func cmp_func |
891
49d8cff6f0ee
make all function attributes leading - fixes #425
Mike Becker <universe@uap-core.de>
parents:
890
diff
changeset
|
345 | ); |
884
d375d8056262
add cx_array_binary_search() - fixes #424
Mike Becker <universe@uap-core.de>
parents:
883
diff
changeset
|
346 | |
d375d8056262
add cx_array_binary_search() - fixes #424
Mike Becker <universe@uap-core.de>
parents:
883
diff
changeset
|
347 | /** |
d375d8056262
add cx_array_binary_search() - fixes #424
Mike Becker <universe@uap-core.de>
parents:
883
diff
changeset
|
348 | * Searches an item in a sorted array. |
d375d8056262
add cx_array_binary_search() - fixes #424
Mike Becker <universe@uap-core.de>
parents:
883
diff
changeset
|
349 | * |
d375d8056262
add cx_array_binary_search() - fixes #424
Mike Becker <universe@uap-core.de>
parents:
883
diff
changeset
|
350 | * If the array is not sorted with respect to the \p cmp_func, the behavior |
d375d8056262
add cx_array_binary_search() - fixes #424
Mike Becker <universe@uap-core.de>
parents:
883
diff
changeset
|
351 | * is undefined. |
d375d8056262
add cx_array_binary_search() - fixes #424
Mike Becker <universe@uap-core.de>
parents:
883
diff
changeset
|
352 | * |
d375d8056262
add cx_array_binary_search() - fixes #424
Mike Becker <universe@uap-core.de>
parents:
883
diff
changeset
|
353 | * @param arr the array to search |
d375d8056262
add cx_array_binary_search() - fixes #424
Mike Becker <universe@uap-core.de>
parents:
883
diff
changeset
|
354 | * @param size the size of the array |
d375d8056262
add cx_array_binary_search() - fixes #424
Mike Becker <universe@uap-core.de>
parents:
883
diff
changeset
|
355 | * @param elem_size the size of one element |
d375d8056262
add cx_array_binary_search() - fixes #424
Mike Becker <universe@uap-core.de>
parents:
883
diff
changeset
|
356 | * @param elem the element to find |
d375d8056262
add cx_array_binary_search() - fixes #424
Mike Becker <universe@uap-core.de>
parents:
883
diff
changeset
|
357 | * @param cmp_func the compare function |
d375d8056262
add cx_array_binary_search() - fixes #424
Mike Becker <universe@uap-core.de>
parents:
883
diff
changeset
|
358 | * @return the index of the element in the array, or \p size if the element |
d375d8056262
add cx_array_binary_search() - fixes #424
Mike Becker <universe@uap-core.de>
parents:
883
diff
changeset
|
359 | * cannot be found |
d375d8056262
add cx_array_binary_search() - fixes #424
Mike Becker <universe@uap-core.de>
parents:
883
diff
changeset
|
360 | */ |
985
68754c7de906
major refactoring of attributes
Mike Becker <universe@uap-core.de>
parents:
953
diff
changeset
|
361 | cx_attr_nonnull |
68754c7de906
major refactoring of attributes
Mike Becker <universe@uap-core.de>
parents:
953
diff
changeset
|
362 | size_t cx_array_binary_search( |
890
54565fd74e74
move all const keywords to the west - fixes #426
Mike Becker <universe@uap-core.de>
parents:
887
diff
changeset
|
363 | const void *arr, |
884
d375d8056262
add cx_array_binary_search() - fixes #424
Mike Becker <universe@uap-core.de>
parents:
883
diff
changeset
|
364 | size_t size, |
d375d8056262
add cx_array_binary_search() - fixes #424
Mike Becker <universe@uap-core.de>
parents:
883
diff
changeset
|
365 | size_t elem_size, |
890
54565fd74e74
move all const keywords to the west - fixes #426
Mike Becker <universe@uap-core.de>
parents:
887
diff
changeset
|
366 | const void *elem, |
884
d375d8056262
add cx_array_binary_search() - fixes #424
Mike Becker <universe@uap-core.de>
parents:
883
diff
changeset
|
367 | cx_compare_func cmp_func |
985
68754c7de906
major refactoring of attributes
Mike Becker <universe@uap-core.de>
parents:
953
diff
changeset
|
368 | ); |
884
d375d8056262
add cx_array_binary_search() - fixes #424
Mike Becker <universe@uap-core.de>
parents:
883
diff
changeset
|
369 | |
831
7970eac1c598
add convenience macros for cx_array_*
Mike Becker <universe@uap-core.de>
parents:
819
diff
changeset
|
370 | /** |
886
5f5514bb104b
also add a binary search for the supremum
Mike Becker <universe@uap-core.de>
parents:
885
diff
changeset
|
371 | * Searches the smallest upper bound in a sorted array. |
5f5514bb104b
also add a binary search for the supremum
Mike Becker <universe@uap-core.de>
parents:
885
diff
changeset
|
372 | * |
5f5514bb104b
also add a binary search for the supremum
Mike Becker <universe@uap-core.de>
parents:
885
diff
changeset
|
373 | * In other words, this function returns the index of the smallest element |
5f5514bb104b
also add a binary search for the supremum
Mike Becker <universe@uap-core.de>
parents:
885
diff
changeset
|
374 | * in \p arr that is greater or equal to \p elem with respect to \p cmp_func. |
5f5514bb104b
also add a binary search for the supremum
Mike Becker <universe@uap-core.de>
parents:
885
diff
changeset
|
375 | * When no such element exists, \p size is returned. |
5f5514bb104b
also add a binary search for the supremum
Mike Becker <universe@uap-core.de>
parents:
885
diff
changeset
|
376 | * |
5f5514bb104b
also add a binary search for the supremum
Mike Becker <universe@uap-core.de>
parents:
885
diff
changeset
|
377 | * If \p elem is contained in the array, this is identical to |
5f5514bb104b
also add a binary search for the supremum
Mike Becker <universe@uap-core.de>
parents:
885
diff
changeset
|
378 | * #cx_array_binary_search(). |
5f5514bb104b
also add a binary search for the supremum
Mike Becker <universe@uap-core.de>
parents:
885
diff
changeset
|
379 | * |
5f5514bb104b
also add a binary search for the supremum
Mike Becker <universe@uap-core.de>
parents:
885
diff
changeset
|
380 | * If the array is not sorted with respect to the \p cmp_func, the behavior |
5f5514bb104b
also add a binary search for the supremum
Mike Becker <universe@uap-core.de>
parents:
885
diff
changeset
|
381 | * is undefined. |
5f5514bb104b
also add a binary search for the supremum
Mike Becker <universe@uap-core.de>
parents:
885
diff
changeset
|
382 | * |
5f5514bb104b
also add a binary search for the supremum
Mike Becker <universe@uap-core.de>
parents:
885
diff
changeset
|
383 | * @param arr the array to search |
5f5514bb104b
also add a binary search for the supremum
Mike Becker <universe@uap-core.de>
parents:
885
diff
changeset
|
384 | * @param size the size of the array |
5f5514bb104b
also add a binary search for the supremum
Mike Becker <universe@uap-core.de>
parents:
885
diff
changeset
|
385 | * @param elem_size the size of one element |
5f5514bb104b
also add a binary search for the supremum
Mike Becker <universe@uap-core.de>
parents:
885
diff
changeset
|
386 | * @param elem the element to find |
5f5514bb104b
also add a binary search for the supremum
Mike Becker <universe@uap-core.de>
parents:
885
diff
changeset
|
387 | * @param cmp_func the compare function |
887 | 388 | * @return the index of the smallest upper bound, or \p size |
886
5f5514bb104b
also add a binary search for the supremum
Mike Becker <universe@uap-core.de>
parents:
885
diff
changeset
|
389 | */ |
985
68754c7de906
major refactoring of attributes
Mike Becker <universe@uap-core.de>
parents:
953
diff
changeset
|
390 | cx_attr_nonnull |
68754c7de906
major refactoring of attributes
Mike Becker <universe@uap-core.de>
parents:
953
diff
changeset
|
391 | size_t cx_array_binary_search_sup( |
890
54565fd74e74
move all const keywords to the west - fixes #426
Mike Becker <universe@uap-core.de>
parents:
887
diff
changeset
|
392 | const void *arr, |
886
5f5514bb104b
also add a binary search for the supremum
Mike Becker <universe@uap-core.de>
parents:
885
diff
changeset
|
393 | size_t size, |
5f5514bb104b
also add a binary search for the supremum
Mike Becker <universe@uap-core.de>
parents:
885
diff
changeset
|
394 | size_t elem_size, |
890
54565fd74e74
move all const keywords to the west - fixes #426
Mike Becker <universe@uap-core.de>
parents:
887
diff
changeset
|
395 | const void *elem, |
886
5f5514bb104b
also add a binary search for the supremum
Mike Becker <universe@uap-core.de>
parents:
885
diff
changeset
|
396 | cx_compare_func cmp_func |
985
68754c7de906
major refactoring of attributes
Mike Becker <universe@uap-core.de>
parents:
953
diff
changeset
|
397 | ); |
886
5f5514bb104b
also add a binary search for the supremum
Mike Becker <universe@uap-core.de>
parents:
885
diff
changeset
|
398 | |
5f5514bb104b
also add a binary search for the supremum
Mike Becker <universe@uap-core.de>
parents:
885
diff
changeset
|
399 | /** |
623
21082350a590
#219 array list: implement reverse
Mike Becker <universe@uap-core.de>
parents:
617
diff
changeset
|
400 | * Swaps two array elements. |
21082350a590
#219 array list: implement reverse
Mike Becker <universe@uap-core.de>
parents:
617
diff
changeset
|
401 | * |
21082350a590
#219 array list: implement reverse
Mike Becker <universe@uap-core.de>
parents:
617
diff
changeset
|
402 | * @param arr the array |
21082350a590
#219 array list: implement reverse
Mike Becker <universe@uap-core.de>
parents:
617
diff
changeset
|
403 | * @param elem_size the element size |
21082350a590
#219 array list: implement reverse
Mike Becker <universe@uap-core.de>
parents:
617
diff
changeset
|
404 | * @param idx1 index of first element |
21082350a590
#219 array list: implement reverse
Mike Becker <universe@uap-core.de>
parents:
617
diff
changeset
|
405 | * @param idx2 index of second element |
21082350a590
#219 array list: implement reverse
Mike Becker <universe@uap-core.de>
parents:
617
diff
changeset
|
406 | */ |
985
68754c7de906
major refactoring of attributes
Mike Becker <universe@uap-core.de>
parents:
953
diff
changeset
|
407 | cx_attr_nonnull |
623
21082350a590
#219 array list: implement reverse
Mike Becker <universe@uap-core.de>
parents:
617
diff
changeset
|
408 | void cx_array_swap( |
21082350a590
#219 array list: implement reverse
Mike Becker <universe@uap-core.de>
parents:
617
diff
changeset
|
409 | void *arr, |
21082350a590
#219 array list: implement reverse
Mike Becker <universe@uap-core.de>
parents:
617
diff
changeset
|
410 | size_t elem_size, |
21082350a590
#219 array list: implement reverse
Mike Becker <universe@uap-core.de>
parents:
617
diff
changeset
|
411 | size_t idx1, |
21082350a590
#219 array list: implement reverse
Mike Becker <universe@uap-core.de>
parents:
617
diff
changeset
|
412 | size_t idx2 |
891
49d8cff6f0ee
make all function attributes leading - fixes #425
Mike Becker <universe@uap-core.de>
parents:
890
diff
changeset
|
413 | ); |
623
21082350a590
#219 array list: implement reverse
Mike Becker <universe@uap-core.de>
parents:
617
diff
changeset
|
414 | |
608
2e93521145ac
proposal for a low level array copy
Mike Becker <universe@uap-core.de>
parents:
606
diff
changeset
|
415 | /** |
855
35bcb3216c0d
fix inconsistent use of item_size and elem_size
Mike Becker <universe@uap-core.de>
parents:
844
diff
changeset
|
416 | * Allocates an array list for storing elements with \p elem_size bytes each. |
606 | 417 | * |
855
35bcb3216c0d
fix inconsistent use of item_size and elem_size
Mike Becker <universe@uap-core.de>
parents:
844
diff
changeset
|
418 | * If \p elem_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
|
419 | * 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
|
420 | * 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
|
421 | * |
606 | 422 | * @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
|
423 | * (if \c NULL the cxDefaultAllocator will be used) |
606 | 424 | * @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
|
425 | * (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
|
426 | * functions will not work) |
855
35bcb3216c0d
fix inconsistent use of item_size and elem_size
Mike Becker <universe@uap-core.de>
parents:
844
diff
changeset
|
427 | * @param elem_size the size of each element in bytes |
606 | 428 | * @param initial_capacity the initial number of elements the array can store |
429 | * @return the created list | |
430 | */ | |
985
68754c7de906
major refactoring of attributes
Mike Becker <universe@uap-core.de>
parents:
953
diff
changeset
|
431 | cx_attr_nodiscard |
68754c7de906
major refactoring of attributes
Mike Becker <universe@uap-core.de>
parents:
953
diff
changeset
|
432 | cx_attr_malloc |
68754c7de906
major refactoring of attributes
Mike Becker <universe@uap-core.de>
parents:
953
diff
changeset
|
433 | cx_attr_dealloc(cxListDestroy, 1) |
606 | 434 | CxList *cxArrayListCreate( |
890
54565fd74e74
move all const keywords to the west - fixes #426
Mike Becker <universe@uap-core.de>
parents:
887
diff
changeset
|
435 | const CxAllocator *allocator, |
677
b09aae58bba4
refactoring of collections to make use of destructors in map implementations
Mike Becker <universe@uap-core.de>
parents:
670
diff
changeset
|
436 | cx_compare_func comparator, |
855
35bcb3216c0d
fix inconsistent use of item_size and elem_size
Mike Becker <universe@uap-core.de>
parents:
844
diff
changeset
|
437 | size_t elem_size, |
606 | 438 | size_t initial_capacity |
670
4ad8ea3aee49
allow NULL for allocator and comparator
Mike Becker <universe@uap-core.de>
parents:
669
diff
changeset
|
439 | ); |
606 | 440 | |
662
d0d95740071b
add simple functions for creating lists
Mike Becker <universe@uap-core.de>
parents:
637
diff
changeset
|
441 | /** |
855
35bcb3216c0d
fix inconsistent use of item_size and elem_size
Mike Becker <universe@uap-core.de>
parents:
844
diff
changeset
|
442 | * Allocates an array list for storing elements with \p elem_size bytes each. |
662
d0d95740071b
add simple functions for creating lists
Mike Becker <universe@uap-core.de>
parents:
637
diff
changeset
|
443 | * |
d0d95740071b
add simple functions for creating lists
Mike Becker <universe@uap-core.de>
parents:
637
diff
changeset
|
444 | * 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
|
445 | * 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
|
446 | * 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
|
447 | * |
855
35bcb3216c0d
fix inconsistent use of item_size and elem_size
Mike Becker <universe@uap-core.de>
parents:
844
diff
changeset
|
448 | * If \p elem_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
|
449 | * 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
|
450 | * 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
|
451 | * |
855
35bcb3216c0d
fix inconsistent use of item_size and elem_size
Mike Becker <universe@uap-core.de>
parents:
844
diff
changeset
|
452 | * @param elem_size the size of each element in bytes |
662
d0d95740071b
add simple functions for creating lists
Mike Becker <universe@uap-core.de>
parents:
637
diff
changeset
|
453 | * @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
|
454 | * @return the created list |
d0d95740071b
add simple functions for creating lists
Mike Becker <universe@uap-core.de>
parents:
637
diff
changeset
|
455 | */ |
855
35bcb3216c0d
fix inconsistent use of item_size and elem_size
Mike Becker <universe@uap-core.de>
parents:
844
diff
changeset
|
456 | #define cxArrayListCreateSimple(elem_size, initial_capacity) \ |
35bcb3216c0d
fix inconsistent use of item_size and elem_size
Mike Becker <universe@uap-core.de>
parents:
844
diff
changeset
|
457 | cxArrayListCreate(NULL, NULL, elem_size, initial_capacity) |
606 | 458 | |
459 | #ifdef __cplusplus | |
628
1e2be40f0cb5
use //-style single line comments everywhere
Mike Becker <universe@uap-core.de>
parents:
623
diff
changeset
|
460 | } // extern "C" |
606 | 461 | #endif |
462 | ||
628
1e2be40f0cb5
use //-style single line comments everywhere
Mike Becker <universe@uap-core.de>
parents:
623
diff
changeset
|
463 | #endif // UCX_ARRAY_LIST_H |