Sun, 29 Dec 2019 11:29:17 +0100
adds string replace functions
103
08018864fb91
added license and copyright notice to all files
Mike Becker <universe@uap-core.de>
parents:
93
diff
changeset
|
1 | /* |
08018864fb91
added license and copyright notice to all files
Mike Becker <universe@uap-core.de>
parents:
93
diff
changeset
|
2 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. |
08018864fb91
added license and copyright notice to all files
Mike Becker <universe@uap-core.de>
parents:
93
diff
changeset
|
3 | * |
259 | 4 | * Copyright 2017 Mike Becker, Olaf Wintermann All rights reserved. |
103
08018864fb91
added license and copyright notice to all files
Mike Becker <universe@uap-core.de>
parents:
93
diff
changeset
|
5 | * |
08018864fb91
added license and copyright notice to all files
Mike Becker <universe@uap-core.de>
parents:
93
diff
changeset
|
6 | * Redistribution and use in source and binary forms, with or without |
08018864fb91
added license and copyright notice to all files
Mike Becker <universe@uap-core.de>
parents:
93
diff
changeset
|
7 | * modification, are permitted provided that the following conditions are met: |
08018864fb91
added license and copyright notice to all files
Mike Becker <universe@uap-core.de>
parents:
93
diff
changeset
|
8 | * |
08018864fb91
added license and copyright notice to all files
Mike Becker <universe@uap-core.de>
parents:
93
diff
changeset
|
9 | * 1. Redistributions of source code must retain the above copyright |
08018864fb91
added license and copyright notice to all files
Mike Becker <universe@uap-core.de>
parents:
93
diff
changeset
|
10 | * notice, this list of conditions and the following disclaimer. |
08018864fb91
added license and copyright notice to all files
Mike Becker <universe@uap-core.de>
parents:
93
diff
changeset
|
11 | * |
08018864fb91
added license and copyright notice to all files
Mike Becker <universe@uap-core.de>
parents:
93
diff
changeset
|
12 | * 2. Redistributions in binary form must reproduce the above copyright |
08018864fb91
added license and copyright notice to all files
Mike Becker <universe@uap-core.de>
parents:
93
diff
changeset
|
13 | * notice, this list of conditions and the following disclaimer in the |
08018864fb91
added license and copyright notice to all files
Mike Becker <universe@uap-core.de>
parents:
93
diff
changeset
|
14 | * documentation and/or other materials provided with the distribution. |
08018864fb91
added license and copyright notice to all files
Mike Becker <universe@uap-core.de>
parents:
93
diff
changeset
|
15 | * |
08018864fb91
added license and copyright notice to all files
Mike Becker <universe@uap-core.de>
parents:
93
diff
changeset
|
16 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" |
08018864fb91
added license and copyright notice to all files
Mike Becker <universe@uap-core.de>
parents:
93
diff
changeset
|
17 | * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
08018864fb91
added license and copyright notice to all files
Mike Becker <universe@uap-core.de>
parents:
93
diff
changeset
|
18 | * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE |
08018864fb91
added license and copyright notice to all files
Mike Becker <universe@uap-core.de>
parents:
93
diff
changeset
|
19 | * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE |
08018864fb91
added license and copyright notice to all files
Mike Becker <universe@uap-core.de>
parents:
93
diff
changeset
|
20 | * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR |
08018864fb91
added license and copyright notice to all files
Mike Becker <universe@uap-core.de>
parents:
93
diff
changeset
|
21 | * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF |
08018864fb91
added license and copyright notice to all files
Mike Becker <universe@uap-core.de>
parents:
93
diff
changeset
|
22 | * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS |
08018864fb91
added license and copyright notice to all files
Mike Becker <universe@uap-core.de>
parents:
93
diff
changeset
|
23 | * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN |
08018864fb91
added license and copyright notice to all files
Mike Becker <universe@uap-core.de>
parents:
93
diff
changeset
|
24 | * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) |
08018864fb91
added license and copyright notice to all files
Mike Becker <universe@uap-core.de>
parents:
93
diff
changeset
|
25 | * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE |
08018864fb91
added license and copyright notice to all files
Mike Becker <universe@uap-core.de>
parents:
93
diff
changeset
|
26 | * POSSIBILITY OF SUCH DAMAGE. |
4 | 27 | */ |
123
7fb0f74517c5
changed signature of sstrncat + some documentation for UcxList + new features for UcxList
Mike Becker <universe@uap-core.de>
parents:
122
diff
changeset
|
28 | /** |
128
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
29 | * Doubly linked list implementation. |
123
7fb0f74517c5
changed signature of sstrncat + some documentation for UcxList + new features for UcxList
Mike Becker <universe@uap-core.de>
parents:
122
diff
changeset
|
30 | * |
7fb0f74517c5
changed signature of sstrncat + some documentation for UcxList + new features for UcxList
Mike Becker <universe@uap-core.de>
parents:
122
diff
changeset
|
31 | * @file list.h |
7fb0f74517c5
changed signature of sstrncat + some documentation for UcxList + new features for UcxList
Mike Becker <universe@uap-core.de>
parents:
122
diff
changeset
|
32 | * @author Mike Becker |
7fb0f74517c5
changed signature of sstrncat + some documentation for UcxList + new features for UcxList
Mike Becker <universe@uap-core.de>
parents:
122
diff
changeset
|
33 | * @author Olaf Wintermann |
7fb0f74517c5
changed signature of sstrncat + some documentation for UcxList + new features for UcxList
Mike Becker <universe@uap-core.de>
parents:
122
diff
changeset
|
34 | */ |
4 | 35 | |
122
540d99722f1f
removal of single linked list implemenation - step 2: renamed UcxDlist to UcxList (new single implementation)
Mike Becker <universe@uap-core.de>
parents:
121
diff
changeset
|
36 | #ifndef UCX_LIST_H |
540d99722f1f
removal of single linked list implemenation - step 2: renamed UcxDlist to UcxList (new single implementation)
Mike Becker <universe@uap-core.de>
parents:
121
diff
changeset
|
37 | #define UCX_LIST_H |
4 | 38 | |
259 | 39 | #include "ucx.h" |
40 | #include "allocator.h" | |
7
68091406d1cf
added dlist to makefile, implemented first functions, discarded some fails
Mike Becker <universe@uap-core.de>
parents:
4
diff
changeset
|
41 | |
4 | 42 | #ifdef __cplusplus |
43 | extern "C" { | |
44 | #endif | |
45 | ||
121
311cac04d079
removal of single linked list implemenation - step 1: removal
Mike Becker <universe@uap-core.de>
parents:
120
diff
changeset
|
46 | /** |
311cac04d079
removal of single linked list implemenation - step 1: removal
Mike Becker <universe@uap-core.de>
parents:
120
diff
changeset
|
47 | * Loop statement for UCX lists. |
311cac04d079
removal of single linked list implemenation - step 1: removal
Mike Becker <universe@uap-core.de>
parents:
120
diff
changeset
|
48 | * |
220
1f57f196d221
fixes UCX_FOREACH documentation
Mike Becker <universe@uap-core.de>
parents:
212
diff
changeset
|
49 | * The first argument is the name of the iteration variable. The scope of |
1f57f196d221
fixes UCX_FOREACH documentation
Mike Becker <universe@uap-core.de>
parents:
212
diff
changeset
|
50 | * this variable is limited to the <code>UCX_FOREACH</code> statement. |
1f57f196d221
fixes UCX_FOREACH documentation
Mike Becker <universe@uap-core.de>
parents:
212
diff
changeset
|
51 | * |
1f57f196d221
fixes UCX_FOREACH documentation
Mike Becker <universe@uap-core.de>
parents:
212
diff
changeset
|
52 | * The second argument is a pointer to the list. In most cases this will be the |
121
311cac04d079
removal of single linked list implemenation - step 1: removal
Mike Becker <universe@uap-core.de>
parents:
120
diff
changeset
|
53 | * pointer to the first element of the list, but it may also be an arbitrary |
311cac04d079
removal of single linked list implemenation - step 1: removal
Mike Becker <universe@uap-core.de>
parents:
120
diff
changeset
|
54 | * element of the list. The iteration will then start with that element. |
311cac04d079
removal of single linked list implemenation - step 1: removal
Mike Becker <universe@uap-core.de>
parents:
120
diff
changeset
|
55 | * |
311cac04d079
removal of single linked list implemenation - step 1: removal
Mike Becker <universe@uap-core.de>
parents:
120
diff
changeset
|
56 | * @param list The first element of the list |
311cac04d079
removal of single linked list implemenation - step 1: removal
Mike Becker <universe@uap-core.de>
parents:
120
diff
changeset
|
57 | * @param elem The variable name of the element |
311cac04d079
removal of single linked list implemenation - step 1: removal
Mike Becker <universe@uap-core.de>
parents:
120
diff
changeset
|
58 | */ |
122
540d99722f1f
removal of single linked list implemenation - step 2: renamed UcxDlist to UcxList (new single implementation)
Mike Becker <universe@uap-core.de>
parents:
121
diff
changeset
|
59 | #define UCX_FOREACH(elem,list) \ |
371
365b24f20f98
adds set operations to UcxList
Mike Becker <universe@uap-core.de>
parents:
323
diff
changeset
|
60 | for (UcxList* elem = (UcxList*) list ; elem != NULL ; elem = elem->next) |
121
311cac04d079
removal of single linked list implemenation - step 1: removal
Mike Becker <universe@uap-core.de>
parents:
120
diff
changeset
|
61 | |
123
7fb0f74517c5
changed signature of sstrncat + some documentation for UcxList + new features for UcxList
Mike Becker <universe@uap-core.de>
parents:
122
diff
changeset
|
62 | /** |
129
61edec666928
documentation for UcxLogger
Mike Becker <universe@uap-core.de>
parents:
128
diff
changeset
|
63 | * UCX list type. |
123
7fb0f74517c5
changed signature of sstrncat + some documentation for UcxList + new features for UcxList
Mike Becker <universe@uap-core.de>
parents:
122
diff
changeset
|
64 | * @see UcxList |
7fb0f74517c5
changed signature of sstrncat + some documentation for UcxList + new features for UcxList
Mike Becker <universe@uap-core.de>
parents:
122
diff
changeset
|
65 | */ |
122
540d99722f1f
removal of single linked list implemenation - step 2: renamed UcxDlist to UcxList (new single implementation)
Mike Becker <universe@uap-core.de>
parents:
121
diff
changeset
|
66 | typedef struct UcxList UcxList; |
146
aa376dba1ba8
fixed documentation for netbeans parser + added sstrprefix() and sstrsuffix()
Mike Becker <universe@uap-core.de>
parents:
129
diff
changeset
|
67 | |
129
61edec666928
documentation for UcxLogger
Mike Becker <universe@uap-core.de>
parents:
128
diff
changeset
|
68 | /** |
61edec666928
documentation for UcxLogger
Mike Becker <universe@uap-core.de>
parents:
128
diff
changeset
|
69 | * UCX list structure. |
61edec666928
documentation for UcxLogger
Mike Becker <universe@uap-core.de>
parents:
128
diff
changeset
|
70 | */ |
122
540d99722f1f
removal of single linked list implemenation - step 2: renamed UcxDlist to UcxList (new single implementation)
Mike Becker <universe@uap-core.de>
parents:
121
diff
changeset
|
71 | struct UcxList { |
123
7fb0f74517c5
changed signature of sstrncat + some documentation for UcxList + new features for UcxList
Mike Becker <universe@uap-core.de>
parents:
122
diff
changeset
|
72 | /** |
7fb0f74517c5
changed signature of sstrncat + some documentation for UcxList + new features for UcxList
Mike Becker <universe@uap-core.de>
parents:
122
diff
changeset
|
73 | * List element payload. |
7fb0f74517c5
changed signature of sstrncat + some documentation for UcxList + new features for UcxList
Mike Becker <universe@uap-core.de>
parents:
122
diff
changeset
|
74 | */ |
122
540d99722f1f
removal of single linked list implemenation - step 2: renamed UcxDlist to UcxList (new single implementation)
Mike Becker <universe@uap-core.de>
parents:
121
diff
changeset
|
75 | void *data; |
123
7fb0f74517c5
changed signature of sstrncat + some documentation for UcxList + new features for UcxList
Mike Becker <universe@uap-core.de>
parents:
122
diff
changeset
|
76 | /** |
7fb0f74517c5
changed signature of sstrncat + some documentation for UcxList + new features for UcxList
Mike Becker <universe@uap-core.de>
parents:
122
diff
changeset
|
77 | * Pointer to the next list element or <code>NULL</code>, if this is the |
7fb0f74517c5
changed signature of sstrncat + some documentation for UcxList + new features for UcxList
Mike Becker <universe@uap-core.de>
parents:
122
diff
changeset
|
78 | * last element. |
7fb0f74517c5
changed signature of sstrncat + some documentation for UcxList + new features for UcxList
Mike Becker <universe@uap-core.de>
parents:
122
diff
changeset
|
79 | */ |
122
540d99722f1f
removal of single linked list implemenation - step 2: renamed UcxDlist to UcxList (new single implementation)
Mike Becker <universe@uap-core.de>
parents:
121
diff
changeset
|
80 | UcxList *next; |
123
7fb0f74517c5
changed signature of sstrncat + some documentation for UcxList + new features for UcxList
Mike Becker <universe@uap-core.de>
parents:
122
diff
changeset
|
81 | /** |
7fb0f74517c5
changed signature of sstrncat + some documentation for UcxList + new features for UcxList
Mike Becker <universe@uap-core.de>
parents:
122
diff
changeset
|
82 | * Pointer to the previous list element or <code>NULL</code>, if this is |
7fb0f74517c5
changed signature of sstrncat + some documentation for UcxList + new features for UcxList
Mike Becker <universe@uap-core.de>
parents:
122
diff
changeset
|
83 | * the first element. |
7fb0f74517c5
changed signature of sstrncat + some documentation for UcxList + new features for UcxList
Mike Becker <universe@uap-core.de>
parents:
122
diff
changeset
|
84 | */ |
122
540d99722f1f
removal of single linked list implemenation - step 2: renamed UcxDlist to UcxList (new single implementation)
Mike Becker <universe@uap-core.de>
parents:
121
diff
changeset
|
85 | UcxList *prev; |
4 | 86 | }; |
87 | ||
128
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
88 | /** |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
89 | * Creates an element-wise copy of a list. |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
90 | * |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
91 | * This function clones the specified list by creating new list elements and |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
92 | * copying the data with the specified copy_func(). If no copy_func() is |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
93 | * specified, a shallow copy is created and the new list will reference the |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
94 | * same data as the source list. |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
95 | * |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
96 | * @param list the list to copy |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
97 | * @param cpyfnc a pointer to the function that shall copy an element (may be |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
98 | * <code>NULL</code>) |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
99 | * @param data additional data for the copy_func() |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
100 | * @return a pointer to the copy |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
101 | */ |
371
365b24f20f98
adds set operations to UcxList
Mike Becker <universe@uap-core.de>
parents:
323
diff
changeset
|
102 | UcxList *ucx_list_clone(const UcxList *list, copy_func cpyfnc, void* data); |
146
aa376dba1ba8
fixed documentation for netbeans parser + added sstrprefix() and sstrsuffix()
Mike Becker <universe@uap-core.de>
parents:
129
diff
changeset
|
103 | |
128
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
104 | /** |
225
a1a068c2c4ef
updates documenting comments
Mike Becker <universe@uap-core.de>
parents:
220
diff
changeset
|
105 | * Creates an element-wise copy of a list using a UcxAllocator. |
128
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
106 | * |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
107 | * See ucx_list_clone() for details. |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
108 | * |
225
a1a068c2c4ef
updates documenting comments
Mike Becker <universe@uap-core.de>
parents:
220
diff
changeset
|
109 | * You might want to pass the allocator via the <code>data</code> parameter, |
a1a068c2c4ef
updates documenting comments
Mike Becker <universe@uap-core.de>
parents:
220
diff
changeset
|
110 | * to access it within the copy function for making deep copies. |
128
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
111 | * |
129
61edec666928
documentation for UcxLogger
Mike Becker <universe@uap-core.de>
parents:
128
diff
changeset
|
112 | * @param allocator the allocator to use |
128
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
113 | * @param list the list to copy |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
114 | * @param cpyfnc a pointer to the function that shall copy an element (may be |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
115 | * <code>NULL</code>) |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
116 | * @param data additional data for the copy_func() |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
117 | * @return a pointer to the copy |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
118 | * @see ucx_list_clone() |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
119 | */ |
371
365b24f20f98
adds set operations to UcxList
Mike Becker <universe@uap-core.de>
parents:
323
diff
changeset
|
120 | UcxList *ucx_list_clone_a(UcxAllocator *allocator, const UcxList *list, |
125
fca8efb122de
changed suffix for allocator aware functions + added allocator aware functions for UcxList
Mike Becker <universe@uap-core.de>
parents:
124
diff
changeset
|
121 | copy_func cpyfnc, void* data); |
123
7fb0f74517c5
changed signature of sstrncat + some documentation for UcxList + new features for UcxList
Mike Becker <universe@uap-core.de>
parents:
122
diff
changeset
|
122 | |
7fb0f74517c5
changed signature of sstrncat + some documentation for UcxList + new features for UcxList
Mike Becker <universe@uap-core.de>
parents:
122
diff
changeset
|
123 | /** |
7fb0f74517c5
changed signature of sstrncat + some documentation for UcxList + new features for UcxList
Mike Becker <universe@uap-core.de>
parents:
122
diff
changeset
|
124 | * Compares two UCX lists element-wise by using a compare function. |
7fb0f74517c5
changed signature of sstrncat + some documentation for UcxList + new features for UcxList
Mike Becker <universe@uap-core.de>
parents:
122
diff
changeset
|
125 | * |
7fb0f74517c5
changed signature of sstrncat + some documentation for UcxList + new features for UcxList
Mike Becker <universe@uap-core.de>
parents:
122
diff
changeset
|
126 | * Each element of the two specified lists are compared by using the specified |
7fb0f74517c5
changed signature of sstrncat + some documentation for UcxList + new features for UcxList
Mike Becker <universe@uap-core.de>
parents:
122
diff
changeset
|
127 | * compare function and the additional data. The type and content of this |
7fb0f74517c5
changed signature of sstrncat + some documentation for UcxList + new features for UcxList
Mike Becker <universe@uap-core.de>
parents:
122
diff
changeset
|
128 | * additional data depends on the cmp_func() used. |
7fb0f74517c5
changed signature of sstrncat + some documentation for UcxList + new features for UcxList
Mike Becker <universe@uap-core.de>
parents:
122
diff
changeset
|
129 | * |
7fb0f74517c5
changed signature of sstrncat + some documentation for UcxList + new features for UcxList
Mike Becker <universe@uap-core.de>
parents:
122
diff
changeset
|
130 | * If the list pointers denote elements within a list, the lists are compared |
7fb0f74517c5
changed signature of sstrncat + some documentation for UcxList + new features for UcxList
Mike Becker <universe@uap-core.de>
parents:
122
diff
changeset
|
131 | * starting with the denoted elements. Thus any previous elements are not taken |
7fb0f74517c5
changed signature of sstrncat + some documentation for UcxList + new features for UcxList
Mike Becker <universe@uap-core.de>
parents:
122
diff
changeset
|
132 | * into account. This might be useful to check, if certain list tails match |
7fb0f74517c5
changed signature of sstrncat + some documentation for UcxList + new features for UcxList
Mike Becker <universe@uap-core.de>
parents:
122
diff
changeset
|
133 | * each other. |
7fb0f74517c5
changed signature of sstrncat + some documentation for UcxList + new features for UcxList
Mike Becker <universe@uap-core.de>
parents:
122
diff
changeset
|
134 | * |
7fb0f74517c5
changed signature of sstrncat + some documentation for UcxList + new features for UcxList
Mike Becker <universe@uap-core.de>
parents:
122
diff
changeset
|
135 | * @param list1 the first list |
7fb0f74517c5
changed signature of sstrncat + some documentation for UcxList + new features for UcxList
Mike Becker <universe@uap-core.de>
parents:
122
diff
changeset
|
136 | * @param list2 the second list |
7fb0f74517c5
changed signature of sstrncat + some documentation for UcxList + new features for UcxList
Mike Becker <universe@uap-core.de>
parents:
122
diff
changeset
|
137 | * @param cmpfnc the compare function |
7fb0f74517c5
changed signature of sstrncat + some documentation for UcxList + new features for UcxList
Mike Becker <universe@uap-core.de>
parents:
122
diff
changeset
|
138 | * @param data additional data for the compare function |
7fb0f74517c5
changed signature of sstrncat + some documentation for UcxList + new features for UcxList
Mike Becker <universe@uap-core.de>
parents:
122
diff
changeset
|
139 | * @return 1, if and only if the two lists equal element-wise, 0 otherwise |
7fb0f74517c5
changed signature of sstrncat + some documentation for UcxList + new features for UcxList
Mike Becker <universe@uap-core.de>
parents:
122
diff
changeset
|
140 | */ |
7fb0f74517c5
changed signature of sstrncat + some documentation for UcxList + new features for UcxList
Mike Becker <universe@uap-core.de>
parents:
122
diff
changeset
|
141 | int ucx_list_equals(const UcxList *list1, const UcxList *list2, |
7fb0f74517c5
changed signature of sstrncat + some documentation for UcxList + new features for UcxList
Mike Becker <universe@uap-core.de>
parents:
122
diff
changeset
|
142 | cmp_func cmpfnc, void* data); |
18
69636f81db31
added clone and equals to lists
Mike Becker <universe@uap-core.de>
parents:
8
diff
changeset
|
143 | |
123
7fb0f74517c5
changed signature of sstrncat + some documentation for UcxList + new features for UcxList
Mike Becker <universe@uap-core.de>
parents:
122
diff
changeset
|
144 | /** |
7fb0f74517c5
changed signature of sstrncat + some documentation for UcxList + new features for UcxList
Mike Becker <universe@uap-core.de>
parents:
122
diff
changeset
|
145 | * Destroys the entire list. |
7fb0f74517c5
changed signature of sstrncat + some documentation for UcxList + new features for UcxList
Mike Becker <universe@uap-core.de>
parents:
122
diff
changeset
|
146 | * |
7fb0f74517c5
changed signature of sstrncat + some documentation for UcxList + new features for UcxList
Mike Becker <universe@uap-core.de>
parents:
122
diff
changeset
|
147 | * The members of the list are not automatically freed, so ensure they are |
211
07a284486fa1
added ucx_list_free_contents()
Mike Becker <universe@uap-core.de>
parents:
192
diff
changeset
|
148 | * otherwise referenced or destroyed by ucx_list_free_contents(). |
07a284486fa1
added ucx_list_free_contents()
Mike Becker <universe@uap-core.de>
parents:
192
diff
changeset
|
149 | * Otherwise, a memory leak is likely to occur. |
123
7fb0f74517c5
changed signature of sstrncat + some documentation for UcxList + new features for UcxList
Mike Becker <universe@uap-core.de>
parents:
122
diff
changeset
|
150 | * |
7fb0f74517c5
changed signature of sstrncat + some documentation for UcxList + new features for UcxList
Mike Becker <universe@uap-core.de>
parents:
122
diff
changeset
|
151 | * <b>Caution:</b> the argument <b>MUST</b> denote an entire list (i.e. a call |
7fb0f74517c5
changed signature of sstrncat + some documentation for UcxList + new features for UcxList
Mike Becker <universe@uap-core.de>
parents:
122
diff
changeset
|
152 | * to ucx_list_first() on the argument must return the argument itself) |
7fb0f74517c5
changed signature of sstrncat + some documentation for UcxList + new features for UcxList
Mike Becker <universe@uap-core.de>
parents:
122
diff
changeset
|
153 | * |
128
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
154 | * @param list the list to free |
211
07a284486fa1
added ucx_list_free_contents()
Mike Becker <universe@uap-core.de>
parents:
192
diff
changeset
|
155 | * @see ucx_list_free_contents() |
123
7fb0f74517c5
changed signature of sstrncat + some documentation for UcxList + new features for UcxList
Mike Becker <universe@uap-core.de>
parents:
122
diff
changeset
|
156 | */ |
7fb0f74517c5
changed signature of sstrncat + some documentation for UcxList + new features for UcxList
Mike Becker <universe@uap-core.de>
parents:
122
diff
changeset
|
157 | void ucx_list_free(UcxList *list); |
146
aa376dba1ba8
fixed documentation for netbeans parser + added sstrprefix() and sstrsuffix()
Mike Becker <universe@uap-core.de>
parents:
129
diff
changeset
|
158 | |
128
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
159 | /** |
225
a1a068c2c4ef
updates documenting comments
Mike Becker <universe@uap-core.de>
parents:
220
diff
changeset
|
160 | * Destroys the entire list using a UcxAllocator. |
128
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
161 | * |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
162 | * See ucx_list_free() for details. |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
163 | * |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
164 | * @param allocator the allocator to use |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
165 | * @param list the list to free |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
166 | * @see ucx_list_free() |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
167 | */ |
125
fca8efb122de
changed suffix for allocator aware functions + added allocator aware functions for UcxList
Mike Becker <universe@uap-core.de>
parents:
124
diff
changeset
|
168 | void ucx_list_free_a(UcxAllocator *allocator, UcxList *list); |
146
aa376dba1ba8
fixed documentation for netbeans parser + added sstrprefix() and sstrsuffix()
Mike Becker <universe@uap-core.de>
parents:
129
diff
changeset
|
169 | |
128
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
170 | /** |
211
07a284486fa1
added ucx_list_free_contents()
Mike Becker <universe@uap-core.de>
parents:
192
diff
changeset
|
171 | * Destroys the contents of the specified list by calling the specified |
07a284486fa1
added ucx_list_free_contents()
Mike Becker <universe@uap-core.de>
parents:
192
diff
changeset
|
172 | * destructor on each of them. |
07a284486fa1
added ucx_list_free_contents()
Mike Becker <universe@uap-core.de>
parents:
192
diff
changeset
|
173 | * |
07a284486fa1
added ucx_list_free_contents()
Mike Becker <universe@uap-core.de>
parents:
192
diff
changeset
|
174 | * Note, that the contents are not usable afterwards and the list should be |
07a284486fa1
added ucx_list_free_contents()
Mike Becker <universe@uap-core.de>
parents:
192
diff
changeset
|
175 | * destroyed with ucx_list_free(). |
277
f819fe5e20f5
makes destructor functions for *_free_content() optional + more documentation for UcxProperties
Mike Becker <universe@uap-core.de>
parents:
259
diff
changeset
|
176 | * |
f819fe5e20f5
makes destructor functions for *_free_content() optional + more documentation for UcxProperties
Mike Becker <universe@uap-core.de>
parents:
259
diff
changeset
|
177 | * If no destructor is specified (<code>NULL</code>), stdlib's free() is used. |
211
07a284486fa1
added ucx_list_free_contents()
Mike Becker <universe@uap-core.de>
parents:
192
diff
changeset
|
178 | * |
07a284486fa1
added ucx_list_free_contents()
Mike Becker <universe@uap-core.de>
parents:
192
diff
changeset
|
179 | * @param list the list for which the contents shall be freed |
277
f819fe5e20f5
makes destructor functions for *_free_content() optional + more documentation for UcxProperties
Mike Becker <universe@uap-core.de>
parents:
259
diff
changeset
|
180 | * @param destr optional destructor function |
211
07a284486fa1
added ucx_list_free_contents()
Mike Becker <universe@uap-core.de>
parents:
192
diff
changeset
|
181 | * @see ucx_list_free() |
07a284486fa1
added ucx_list_free_contents()
Mike Becker <universe@uap-core.de>
parents:
192
diff
changeset
|
182 | */ |
212
c766c423dee6
fixed name of ucx_list_free_content()
Mike Becker <universe@uap-core.de>
parents:
211
diff
changeset
|
183 | void ucx_list_free_content(UcxList* list, ucx_destructor destr); |
211
07a284486fa1
added ucx_list_free_contents()
Mike Becker <universe@uap-core.de>
parents:
192
diff
changeset
|
184 | |
07a284486fa1
added ucx_list_free_contents()
Mike Becker <universe@uap-core.de>
parents:
192
diff
changeset
|
185 | |
07a284486fa1
added ucx_list_free_contents()
Mike Becker <universe@uap-core.de>
parents:
192
diff
changeset
|
186 | /** |
128
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
187 | * Inserts an element at the end of the list. |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
188 | * |
172
7084e8e8433c
refactoring of list tests + some bug fixes
Mike Becker <universe@uap-core.de>
parents:
146
diff
changeset
|
189 | * This is generally an O(n) operation, as the end of the list is retrieved with |
128
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
190 | * ucx_list_last(). |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
191 | * |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
192 | * @param list the list where to append the data, or <code>NULL</code> to |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
193 | * create a new list |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
194 | * @param data the data to insert |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
195 | * @return <code>list</code>, if it is not <code>NULL</code> or a pointer to |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
196 | * the newly created list otherwise |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
197 | */ |
123
7fb0f74517c5
changed signature of sstrncat + some documentation for UcxList + new features for UcxList
Mike Becker <universe@uap-core.de>
parents:
122
diff
changeset
|
198 | UcxList *ucx_list_append(UcxList *list, void *data); |
146
aa376dba1ba8
fixed documentation for netbeans parser + added sstrprefix() and sstrsuffix()
Mike Becker <universe@uap-core.de>
parents:
129
diff
changeset
|
199 | |
128
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
200 | /** |
225
a1a068c2c4ef
updates documenting comments
Mike Becker <universe@uap-core.de>
parents:
220
diff
changeset
|
201 | * Inserts an element at the end of the list using a UcxAllocator. |
128
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
202 | * |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
203 | * See ucx_list_append() for details. |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
204 | * |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
205 | * @param allocator the allocator to use |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
206 | * @param list the list where to append the data, or <code>NULL</code> to |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
207 | * create a new list |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
208 | * @param data the data to insert |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
209 | * @return <code>list</code>, if it is not <code>NULL</code> or a pointer to |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
210 | * the newly created list otherwise |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
211 | * @see ucx_list_append() |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
212 | */ |
125
fca8efb122de
changed suffix for allocator aware functions + added allocator aware functions for UcxList
Mike Becker <universe@uap-core.de>
parents:
124
diff
changeset
|
213 | UcxList *ucx_list_append_a(UcxAllocator *allocator, UcxList *list, void *data); |
146
aa376dba1ba8
fixed documentation for netbeans parser + added sstrprefix() and sstrsuffix()
Mike Becker <universe@uap-core.de>
parents:
129
diff
changeset
|
214 | |
291
deb0035635eb
adds ucx_list_prepend_once() and ucx_list_prepend_once_a()
Mike Becker <universe@uap-core.de>
parents:
277
diff
changeset
|
215 | |
deb0035635eb
adds ucx_list_prepend_once() and ucx_list_prepend_once_a()
Mike Becker <universe@uap-core.de>
parents:
277
diff
changeset
|
216 | /** |
128
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
217 | * Inserts an element at the beginning of the list. |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
218 | * |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
219 | * You <i>should</i> overwrite the old list pointer by calling |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
220 | * <code>mylist = ucx_list_prepend(mylist, mydata);</code>. However, you may |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
221 | * also perform successive calls of ucx_list_prepend() on the same list pointer, |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
222 | * as this function always searchs for the head of the list with |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
223 | * ucx_list_first(). |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
224 | * |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
225 | * @param list the list where to insert the data or <code>NULL</code> to create |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
226 | * a new list |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
227 | * @param data the data to insert |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
228 | * @return a pointer to the new list head |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
229 | */ |
123
7fb0f74517c5
changed signature of sstrncat + some documentation for UcxList + new features for UcxList
Mike Becker <universe@uap-core.de>
parents:
122
diff
changeset
|
230 | UcxList *ucx_list_prepend(UcxList *list, void *data); |
146
aa376dba1ba8
fixed documentation for netbeans parser + added sstrprefix() and sstrsuffix()
Mike Becker <universe@uap-core.de>
parents:
129
diff
changeset
|
231 | |
128
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
232 | /** |
225
a1a068c2c4ef
updates documenting comments
Mike Becker <universe@uap-core.de>
parents:
220
diff
changeset
|
233 | * Inserts an element at the beginning of the list using a UcxAllocator. |
128
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
234 | * |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
235 | * See ucx_list_prepend() for details. |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
236 | * |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
237 | * @param allocator the allocator to use |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
238 | * @param list the list where to insert the data or <code>NULL</code> to create |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
239 | * a new list |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
240 | * @param data the data to insert |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
241 | * @return a pointer to the new list head |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
242 | * @see ucx_list_prepend() |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
243 | */ |
125
fca8efb122de
changed suffix for allocator aware functions + added allocator aware functions for UcxList
Mike Becker <universe@uap-core.de>
parents:
124
diff
changeset
|
244 | UcxList *ucx_list_prepend_a(UcxAllocator *allocator, UcxList *list, void *data); |
146
aa376dba1ba8
fixed documentation for netbeans parser + added sstrprefix() and sstrsuffix()
Mike Becker <universe@uap-core.de>
parents:
129
diff
changeset
|
245 | |
128
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
246 | /** |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
247 | * Concatenates two lists. |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
248 | * |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
249 | * Either of the two arguments may be <code>NULL</code>. |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
250 | * |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
251 | * This function modifies the references to the next/previous element of |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
252 | * the last/first element of <code>list1</code>/<code> |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
253 | * list2</code>. |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
254 | * |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
255 | * @param list1 first list |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
256 | * @param list2 second list |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
257 | * @return if <code>list1</code> is <code>NULL</code>, <code>list2</code> is |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
258 | * returned, otherwise <code>list1</code> is returned |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
259 | */ |
123
7fb0f74517c5
changed signature of sstrncat + some documentation for UcxList + new features for UcxList
Mike Becker <universe@uap-core.de>
parents:
122
diff
changeset
|
260 | UcxList *ucx_list_concat(UcxList *list1, UcxList *list2); |
146
aa376dba1ba8
fixed documentation for netbeans parser + added sstrprefix() and sstrsuffix()
Mike Becker <universe@uap-core.de>
parents:
129
diff
changeset
|
261 | |
124
8b44653541ef
more documentation for UcxList
Mike Becker <universe@uap-core.de>
parents:
123
diff
changeset
|
262 | /** |
8b44653541ef
more documentation for UcxList
Mike Becker <universe@uap-core.de>
parents:
123
diff
changeset
|
263 | * Returns the first element of a list. |
8b44653541ef
more documentation for UcxList
Mike Becker <universe@uap-core.de>
parents:
123
diff
changeset
|
264 | * |
8b44653541ef
more documentation for UcxList
Mike Becker <universe@uap-core.de>
parents:
123
diff
changeset
|
265 | * If the argument is the list pointer, it is directly returned. Otherwise |
8b44653541ef
more documentation for UcxList
Mike Becker <universe@uap-core.de>
parents:
123
diff
changeset
|
266 | * this function traverses to the first element of the list and returns the |
8b44653541ef
more documentation for UcxList
Mike Becker <universe@uap-core.de>
parents:
123
diff
changeset
|
267 | * list pointer. |
8b44653541ef
more documentation for UcxList
Mike Becker <universe@uap-core.de>
parents:
123
diff
changeset
|
268 | * |
8b44653541ef
more documentation for UcxList
Mike Becker <universe@uap-core.de>
parents:
123
diff
changeset
|
269 | * @param elem one element of the list |
8b44653541ef
more documentation for UcxList
Mike Becker <universe@uap-core.de>
parents:
123
diff
changeset
|
270 | * @return the first element of the list, the specified element is a member of |
8b44653541ef
more documentation for UcxList
Mike Becker <universe@uap-core.de>
parents:
123
diff
changeset
|
271 | */ |
8b44653541ef
more documentation for UcxList
Mike Becker <universe@uap-core.de>
parents:
123
diff
changeset
|
272 | UcxList *ucx_list_first(const UcxList *elem); |
146
aa376dba1ba8
fixed documentation for netbeans parser + added sstrprefix() and sstrsuffix()
Mike Becker <universe@uap-core.de>
parents:
129
diff
changeset
|
273 | |
124
8b44653541ef
more documentation for UcxList
Mike Becker <universe@uap-core.de>
parents:
123
diff
changeset
|
274 | /** |
8b44653541ef
more documentation for UcxList
Mike Becker <universe@uap-core.de>
parents:
123
diff
changeset
|
275 | * Returns the last element of a list. |
8b44653541ef
more documentation for UcxList
Mike Becker <universe@uap-core.de>
parents:
123
diff
changeset
|
276 | * |
8b44653541ef
more documentation for UcxList
Mike Becker <universe@uap-core.de>
parents:
123
diff
changeset
|
277 | * If the argument has no successor, it is the last element and therefore |
8b44653541ef
more documentation for UcxList
Mike Becker <universe@uap-core.de>
parents:
123
diff
changeset
|
278 | * directly returned. Otherwise this function traverses to the last element of |
8b44653541ef
more documentation for UcxList
Mike Becker <universe@uap-core.de>
parents:
123
diff
changeset
|
279 | * the list and returns it. |
8b44653541ef
more documentation for UcxList
Mike Becker <universe@uap-core.de>
parents:
123
diff
changeset
|
280 | * |
8b44653541ef
more documentation for UcxList
Mike Becker <universe@uap-core.de>
parents:
123
diff
changeset
|
281 | * @param elem one element of the list |
8b44653541ef
more documentation for UcxList
Mike Becker <universe@uap-core.de>
parents:
123
diff
changeset
|
282 | * @return the last element of the list, the specified element is a member of |
8b44653541ef
more documentation for UcxList
Mike Becker <universe@uap-core.de>
parents:
123
diff
changeset
|
283 | */ |
8b44653541ef
more documentation for UcxList
Mike Becker <universe@uap-core.de>
parents:
123
diff
changeset
|
284 | UcxList *ucx_list_last(const UcxList *elem); |
146
aa376dba1ba8
fixed documentation for netbeans parser + added sstrprefix() and sstrsuffix()
Mike Becker <universe@uap-core.de>
parents:
129
diff
changeset
|
285 | |
128
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
286 | /** |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
287 | * Returns the list element at the specified index. |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
288 | * |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
289 | * @param list the list to retrieve the element from |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
290 | * @param index index of the element to return |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
291 | * @return the element at the specified index or <code>NULL</code>, if the |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
292 | * index is greater than the list size |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
293 | */ |
172
7084e8e8433c
refactoring of list tests + some bug fixes
Mike Becker <universe@uap-core.de>
parents:
146
diff
changeset
|
294 | UcxList *ucx_list_get(const UcxList *list, size_t index); |
146
aa376dba1ba8
fixed documentation for netbeans parser + added sstrprefix() and sstrsuffix()
Mike Becker <universe@uap-core.de>
parents:
129
diff
changeset
|
295 | |
128
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
296 | /** |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
297 | * Returns the index of an element. |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
298 | * |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
299 | * @param list the list where to search for the element |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
300 | * @param elem the element to find |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
301 | * @return the index of the element or -1 if the list does not contain the |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
302 | * element |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
303 | */ |
123
7fb0f74517c5
changed signature of sstrncat + some documentation for UcxList + new features for UcxList
Mike Becker <universe@uap-core.de>
parents:
122
diff
changeset
|
304 | ssize_t ucx_list_indexof(const UcxList *list, const UcxList *elem); |
146
aa376dba1ba8
fixed documentation for netbeans parser + added sstrprefix() and sstrsuffix()
Mike Becker <universe@uap-core.de>
parents:
129
diff
changeset
|
305 | |
128
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
306 | /** |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
307 | * Returns the element count of the list. |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
308 | * |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
309 | * @param list the list whose elements are counted |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
310 | * @return the element count |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
311 | */ |
123
7fb0f74517c5
changed signature of sstrncat + some documentation for UcxList + new features for UcxList
Mike Becker <universe@uap-core.de>
parents:
122
diff
changeset
|
312 | size_t ucx_list_size(const UcxList *list); |
146
aa376dba1ba8
fixed documentation for netbeans parser + added sstrprefix() and sstrsuffix()
Mike Becker <universe@uap-core.de>
parents:
129
diff
changeset
|
313 | |
128
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
314 | /** |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
315 | * Returns the index of an element containing the specified data. |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
316 | * |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
317 | * This function uses a cmp_func() to compare the data of each list element |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
318 | * with the specified data. If no cmp_func is provided, the pointers are |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
319 | * compared. |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
320 | * |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
321 | * If the list contains the data more than once, the index of the first |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
322 | * occurrence is returned. |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
323 | * |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
324 | * @param list the list where to search for the data |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
325 | * @param elem the element data |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
326 | * @param cmpfnc the compare function |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
327 | * @param data additional data for the compare function |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
328 | * @return the index of the element containing the specified data or -1 if the |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
329 | * data is not found in this list |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
330 | */ |
371
365b24f20f98
adds set operations to UcxList
Mike Becker <universe@uap-core.de>
parents:
323
diff
changeset
|
331 | ssize_t ucx_list_find(const UcxList *list, void *elem, |
365b24f20f98
adds set operations to UcxList
Mike Becker <universe@uap-core.de>
parents:
323
diff
changeset
|
332 | cmp_func cmpfnc, void *data); |
146
aa376dba1ba8
fixed documentation for netbeans parser + added sstrprefix() and sstrsuffix()
Mike Becker <universe@uap-core.de>
parents:
129
diff
changeset
|
333 | |
128
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
334 | /** |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
335 | * Checks, if a list contains a specific element. |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
336 | * |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
337 | * An element is found, if ucx_list_find() returns a value greater than -1. |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
338 | * |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
339 | * @param list the list where to search for the data |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
340 | * @param elem the element data |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
341 | * @param cmpfnc the compare function |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
342 | * @param data additional data for the compare function |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
343 | * @return 1, if and only if the list contains the specified element data |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
344 | * @see ucx_list_find() |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
345 | */ |
371
365b24f20f98
adds set operations to UcxList
Mike Becker <universe@uap-core.de>
parents:
323
diff
changeset
|
346 | int ucx_list_contains(const UcxList *list, void *elem, |
365b24f20f98
adds set operations to UcxList
Mike Becker <universe@uap-core.de>
parents:
323
diff
changeset
|
347 | cmp_func cmpfnc, void *data); |
4 | 348 | |
128
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
349 | /** |
225
a1a068c2c4ef
updates documenting comments
Mike Becker <universe@uap-core.de>
parents:
220
diff
changeset
|
350 | * Sorts a UcxList with natural merge sort. |
128
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
351 | * |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
352 | * This function uses O(n) additional temporary memory for merge operations |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
353 | * that is automatically freed after each merge. |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
354 | * |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
355 | * As the head of the list might change, you <b>MUST</b> call this function |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
356 | * as follows: <code>mylist = ucx_list_sort(mylist, mycmpfnc, mydata);</code>. |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
357 | * |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
358 | * @param list the list to sort |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
359 | * @param cmpfnc the function that shall be used to compare the element data |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
360 | * @param data additional data for the cmp_func() |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
361 | * @return the sorted list |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
362 | */ |
123
7fb0f74517c5
changed signature of sstrncat + some documentation for UcxList + new features for UcxList
Mike Becker <universe@uap-core.de>
parents:
122
diff
changeset
|
363 | UcxList *ucx_list_sort(UcxList *list, cmp_func cmpfnc, void *data); |
35
fdabd1240b69
added mkdir for build directory to makefile + added qsort for list and dlist
Mike Becker <universe@uap-core.de>
parents:
27
diff
changeset
|
364 | |
124
8b44653541ef
more documentation for UcxList
Mike Becker <universe@uap-core.de>
parents:
123
diff
changeset
|
365 | /** |
8b44653541ef
more documentation for UcxList
Mike Becker <universe@uap-core.de>
parents:
123
diff
changeset
|
366 | * Removes an element from the list. |
8b44653541ef
more documentation for UcxList
Mike Becker <universe@uap-core.de>
parents:
123
diff
changeset
|
367 | * |
8b44653541ef
more documentation for UcxList
Mike Becker <universe@uap-core.de>
parents:
123
diff
changeset
|
368 | * If the first element is removed, the list pointer changes. So it is |
8b44653541ef
more documentation for UcxList
Mike Becker <universe@uap-core.de>
parents:
123
diff
changeset
|
369 | * <i>highly recommended</i> to <i>always</i> update the pointer by calling |
8b44653541ef
more documentation for UcxList
Mike Becker <universe@uap-core.de>
parents:
123
diff
changeset
|
370 | * <code>mylist = ucx_list_remove(mylist, myelem);</code>. |
8b44653541ef
more documentation for UcxList
Mike Becker <universe@uap-core.de>
parents:
123
diff
changeset
|
371 | * |
8b44653541ef
more documentation for UcxList
Mike Becker <universe@uap-core.de>
parents:
123
diff
changeset
|
372 | * @param list the list from which the element shall be removed |
172
7084e8e8433c
refactoring of list tests + some bug fixes
Mike Becker <universe@uap-core.de>
parents:
146
diff
changeset
|
373 | * @param element the element to remove |
124
8b44653541ef
more documentation for UcxList
Mike Becker <universe@uap-core.de>
parents:
123
diff
changeset
|
374 | * @return returns the updated list pointer or <code>NULL</code>, if the list |
8b44653541ef
more documentation for UcxList
Mike Becker <universe@uap-core.de>
parents:
123
diff
changeset
|
375 | * is now empty |
8b44653541ef
more documentation for UcxList
Mike Becker <universe@uap-core.de>
parents:
123
diff
changeset
|
376 | */ |
123
7fb0f74517c5
changed signature of sstrncat + some documentation for UcxList + new features for UcxList
Mike Becker <universe@uap-core.de>
parents:
122
diff
changeset
|
377 | UcxList *ucx_list_remove(UcxList *list, UcxList *element); |
146
aa376dba1ba8
fixed documentation for netbeans parser + added sstrprefix() and sstrsuffix()
Mike Becker <universe@uap-core.de>
parents:
129
diff
changeset
|
378 | |
128
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
379 | /** |
225
a1a068c2c4ef
updates documenting comments
Mike Becker <universe@uap-core.de>
parents:
220
diff
changeset
|
380 | * Removes an element from the list using a UcxAllocator. |
128
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
381 | * |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
382 | * See ucx_list_remove() for details. |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
383 | * |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
384 | * @param allocator the allocator to use |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
385 | * @param list the list from which the element shall be removed |
172
7084e8e8433c
refactoring of list tests + some bug fixes
Mike Becker <universe@uap-core.de>
parents:
146
diff
changeset
|
386 | * @param element the element to remove |
128
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
387 | * @return returns the updated list pointer or <code>NULL</code>, if the list |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
388 | * @see ucx_list_remove() |
b79b1ce438dd
finished documentation of UcxList
Mike Becker <universe@uap-core.de>
parents:
127
diff
changeset
|
389 | */ |
125
fca8efb122de
changed suffix for allocator aware functions + added allocator aware functions for UcxList
Mike Becker <universe@uap-core.de>
parents:
124
diff
changeset
|
390 | UcxList *ucx_list_remove_a(UcxAllocator *allocator, UcxList *list, |
fca8efb122de
changed suffix for allocator aware functions + added allocator aware functions for UcxList
Mike Becker <universe@uap-core.de>
parents:
124
diff
changeset
|
391 | UcxList *element); |
4 | 392 | |
371
365b24f20f98
adds set operations to UcxList
Mike Becker <universe@uap-core.de>
parents:
323
diff
changeset
|
393 | /** |
365b24f20f98
adds set operations to UcxList
Mike Becker <universe@uap-core.de>
parents:
323
diff
changeset
|
394 | * Returns the union of two lists. |
365b24f20f98
adds set operations to UcxList
Mike Becker <universe@uap-core.de>
parents:
323
diff
changeset
|
395 | * |
365b24f20f98
adds set operations to UcxList
Mike Becker <universe@uap-core.de>
parents:
323
diff
changeset
|
396 | * The union is a list of unique elements regarding cmpfnc obtained from |
365b24f20f98
adds set operations to UcxList
Mike Becker <universe@uap-core.de>
parents:
323
diff
changeset
|
397 | * both source lists. |
365b24f20f98
adds set operations to UcxList
Mike Becker <universe@uap-core.de>
parents:
323
diff
changeset
|
398 | * |
365b24f20f98
adds set operations to UcxList
Mike Becker <universe@uap-core.de>
parents:
323
diff
changeset
|
399 | * @param left the left source list |
365b24f20f98
adds set operations to UcxList
Mike Becker <universe@uap-core.de>
parents:
323
diff
changeset
|
400 | * @param right the right source list |
365b24f20f98
adds set operations to UcxList
Mike Becker <universe@uap-core.de>
parents:
323
diff
changeset
|
401 | * @param cmpfnc a function to compare elements |
365b24f20f98
adds set operations to UcxList
Mike Becker <universe@uap-core.de>
parents:
323
diff
changeset
|
402 | * @param cmpdata additional data for the compare function |
365b24f20f98
adds set operations to UcxList
Mike Becker <universe@uap-core.de>
parents:
323
diff
changeset
|
403 | * @param cpfnc a function to copy the elements |
365b24f20f98
adds set operations to UcxList
Mike Becker <universe@uap-core.de>
parents:
323
diff
changeset
|
404 | * @param cpdata additional data for the copy function |
365b24f20f98
adds set operations to UcxList
Mike Becker <universe@uap-core.de>
parents:
323
diff
changeset
|
405 | * @return a new list containing the union |
365b24f20f98
adds set operations to UcxList
Mike Becker <universe@uap-core.de>
parents:
323
diff
changeset
|
406 | */ |
365b24f20f98
adds set operations to UcxList
Mike Becker <universe@uap-core.de>
parents:
323
diff
changeset
|
407 | UcxList* ucx_list_union(const UcxList *left, const UcxList *right, |
365b24f20f98
adds set operations to UcxList
Mike Becker <universe@uap-core.de>
parents:
323
diff
changeset
|
408 | cmp_func cmpfnc, void* cmpdata, |
365b24f20f98
adds set operations to UcxList
Mike Becker <universe@uap-core.de>
parents:
323
diff
changeset
|
409 | copy_func cpfnc, void* cpdata); |
365b24f20f98
adds set operations to UcxList
Mike Becker <universe@uap-core.de>
parents:
323
diff
changeset
|
410 | |
365b24f20f98
adds set operations to UcxList
Mike Becker <universe@uap-core.de>
parents:
323
diff
changeset
|
411 | /** |
365b24f20f98
adds set operations to UcxList
Mike Becker <universe@uap-core.de>
parents:
323
diff
changeset
|
412 | * Returns the union of two lists. |
365b24f20f98
adds set operations to UcxList
Mike Becker <universe@uap-core.de>
parents:
323
diff
changeset
|
413 | * |
365b24f20f98
adds set operations to UcxList
Mike Becker <universe@uap-core.de>
parents:
323
diff
changeset
|
414 | * The union is a list of unique elements regarding cmpfnc obtained from |
365b24f20f98
adds set operations to UcxList
Mike Becker <universe@uap-core.de>
parents:
323
diff
changeset
|
415 | * both source lists. |
365b24f20f98
adds set operations to UcxList
Mike Becker <universe@uap-core.de>
parents:
323
diff
changeset
|
416 | * |
365b24f20f98
adds set operations to UcxList
Mike Becker <universe@uap-core.de>
parents:
323
diff
changeset
|
417 | * @param allocator allocates the new list elements |
365b24f20f98
adds set operations to UcxList
Mike Becker <universe@uap-core.de>
parents:
323
diff
changeset
|
418 | * @param left the left source list |
365b24f20f98
adds set operations to UcxList
Mike Becker <universe@uap-core.de>
parents:
323
diff
changeset
|
419 | * @param right the right source list |
365b24f20f98
adds set operations to UcxList
Mike Becker <universe@uap-core.de>
parents:
323
diff
changeset
|
420 | * @param cmpfnc a function to compare elements |
365b24f20f98
adds set operations to UcxList
Mike Becker <universe@uap-core.de>
parents:
323
diff
changeset
|
421 | * @param cmpdata additional data for the compare function |
365b24f20f98
adds set operations to UcxList
Mike Becker <universe@uap-core.de>
parents:
323
diff
changeset
|
422 | * @param cpfnc a function to copy the elements |
365b24f20f98
adds set operations to UcxList
Mike Becker <universe@uap-core.de>
parents:
323
diff
changeset
|
423 | * @param cpdata additional data for the copy function |
365b24f20f98
adds set operations to UcxList
Mike Becker <universe@uap-core.de>
parents:
323
diff
changeset
|
424 | * @return a new list containing the union |
365b24f20f98
adds set operations to UcxList
Mike Becker <universe@uap-core.de>
parents:
323
diff
changeset
|
425 | */ |
365b24f20f98
adds set operations to UcxList
Mike Becker <universe@uap-core.de>
parents:
323
diff
changeset
|
426 | UcxList* ucx_list_union_a(UcxAllocator *allocator, |
365b24f20f98
adds set operations to UcxList
Mike Becker <universe@uap-core.de>
parents:
323
diff
changeset
|
427 | const UcxList *left, const UcxList *right, |
365b24f20f98
adds set operations to UcxList
Mike Becker <universe@uap-core.de>
parents:
323
diff
changeset
|
428 | cmp_func cmpfnc, void* cmpdata, |
365b24f20f98
adds set operations to UcxList
Mike Becker <universe@uap-core.de>
parents:
323
diff
changeset
|
429 | copy_func cpfnc, void* cpdata); |
365b24f20f98
adds set operations to UcxList
Mike Becker <universe@uap-core.de>
parents:
323
diff
changeset
|
430 | |
365b24f20f98
adds set operations to UcxList
Mike Becker <universe@uap-core.de>
parents:
323
diff
changeset
|
431 | /** |
365b24f20f98
adds set operations to UcxList
Mike Becker <universe@uap-core.de>
parents:
323
diff
changeset
|
432 | * Returns the intersection of two lists. |
365b24f20f98
adds set operations to UcxList
Mike Becker <universe@uap-core.de>
parents:
323
diff
changeset
|
433 | * |
365b24f20f98
adds set operations to UcxList
Mike Becker <universe@uap-core.de>
parents:
323
diff
changeset
|
434 | * The intersection contains all elements of the left list |
365b24f20f98
adds set operations to UcxList
Mike Becker <universe@uap-core.de>
parents:
323
diff
changeset
|
435 | * (including duplicates) that can be found in the right list. |
365b24f20f98
adds set operations to UcxList
Mike Becker <universe@uap-core.de>
parents:
323
diff
changeset
|
436 | * |
365b24f20f98
adds set operations to UcxList
Mike Becker <universe@uap-core.de>
parents:
323
diff
changeset
|
437 | * @param left the left source list |
365b24f20f98
adds set operations to UcxList
Mike Becker <universe@uap-core.de>
parents:
323
diff
changeset
|
438 | * @param right the right source list |
365b24f20f98
adds set operations to UcxList
Mike Becker <universe@uap-core.de>
parents:
323
diff
changeset
|
439 | * @param cmpfnc a function to compare elements |
365b24f20f98
adds set operations to UcxList
Mike Becker <universe@uap-core.de>
parents:
323
diff
changeset
|
440 | * @param cmpdata additional data for the compare function |
365b24f20f98
adds set operations to UcxList
Mike Becker <universe@uap-core.de>
parents:
323
diff
changeset
|
441 | * @param cpfnc a function to copy the elements |
365b24f20f98
adds set operations to UcxList
Mike Becker <universe@uap-core.de>
parents:
323
diff
changeset
|
442 | * @param cpdata additional data for the copy function |
365b24f20f98
adds set operations to UcxList
Mike Becker <universe@uap-core.de>
parents:
323
diff
changeset
|
443 | * @return a new list containing the intersection |
365b24f20f98
adds set operations to UcxList
Mike Becker <universe@uap-core.de>
parents:
323
diff
changeset
|
444 | */ |
365b24f20f98
adds set operations to UcxList
Mike Becker <universe@uap-core.de>
parents:
323
diff
changeset
|
445 | UcxList* ucx_list_intersection(const UcxList *left, const UcxList *right, |
365b24f20f98
adds set operations to UcxList
Mike Becker <universe@uap-core.de>
parents:
323
diff
changeset
|
446 | cmp_func cmpfnc, void* cmpdata, |
365b24f20f98
adds set operations to UcxList
Mike Becker <universe@uap-core.de>
parents:
323
diff
changeset
|
447 | copy_func cpfnc, void* cpdata); |
365b24f20f98
adds set operations to UcxList
Mike Becker <universe@uap-core.de>
parents:
323
diff
changeset
|
448 | |
365b24f20f98
adds set operations to UcxList
Mike Becker <universe@uap-core.de>
parents:
323
diff
changeset
|
449 | /** |
365b24f20f98
adds set operations to UcxList
Mike Becker <universe@uap-core.de>
parents:
323
diff
changeset
|
450 | * Returns the intersection of two lists. |
365b24f20f98
adds set operations to UcxList
Mike Becker <universe@uap-core.de>
parents:
323
diff
changeset
|
451 | * |
365b24f20f98
adds set operations to UcxList
Mike Becker <universe@uap-core.de>
parents:
323
diff
changeset
|
452 | * The intersection contains all elements of the left list |
365b24f20f98
adds set operations to UcxList
Mike Becker <universe@uap-core.de>
parents:
323
diff
changeset
|
453 | * (including duplicates) that can be found in the right list. |
365b24f20f98
adds set operations to UcxList
Mike Becker <universe@uap-core.de>
parents:
323
diff
changeset
|
454 | * |
365b24f20f98
adds set operations to UcxList
Mike Becker <universe@uap-core.de>
parents:
323
diff
changeset
|
455 | * @param allocator allocates the new list elements |
365b24f20f98
adds set operations to UcxList
Mike Becker <universe@uap-core.de>
parents:
323
diff
changeset
|
456 | * @param left the left source list |
365b24f20f98
adds set operations to UcxList
Mike Becker <universe@uap-core.de>
parents:
323
diff
changeset
|
457 | * @param right the right source list |
365b24f20f98
adds set operations to UcxList
Mike Becker <universe@uap-core.de>
parents:
323
diff
changeset
|
458 | * @param cmpfnc a function to compare elements |
365b24f20f98
adds set operations to UcxList
Mike Becker <universe@uap-core.de>
parents:
323
diff
changeset
|
459 | * @param cmpdata additional data for the compare function |
365b24f20f98
adds set operations to UcxList
Mike Becker <universe@uap-core.de>
parents:
323
diff
changeset
|
460 | * @param cpfnc a function to copy the elements |
365b24f20f98
adds set operations to UcxList
Mike Becker <universe@uap-core.de>
parents:
323
diff
changeset
|
461 | * @param cpdata additional data for the copy function |
365b24f20f98
adds set operations to UcxList
Mike Becker <universe@uap-core.de>
parents:
323
diff
changeset
|
462 | * @return a new list containing the intersection |
365b24f20f98
adds set operations to UcxList
Mike Becker <universe@uap-core.de>
parents:
323
diff
changeset
|
463 | */ |
365b24f20f98
adds set operations to UcxList
Mike Becker <universe@uap-core.de>
parents:
323
diff
changeset
|
464 | UcxList* ucx_list_intersection_a(UcxAllocator *allocator, |
365b24f20f98
adds set operations to UcxList
Mike Becker <universe@uap-core.de>
parents:
323
diff
changeset
|
465 | const UcxList *left, const UcxList *right, |
365b24f20f98
adds set operations to UcxList
Mike Becker <universe@uap-core.de>
parents:
323
diff
changeset
|
466 | cmp_func cmpfnc, void* cmpdata, |
365b24f20f98
adds set operations to UcxList
Mike Becker <universe@uap-core.de>
parents:
323
diff
changeset
|
467 | copy_func cpfnc, void* cpdata); |
365b24f20f98
adds set operations to UcxList
Mike Becker <universe@uap-core.de>
parents:
323
diff
changeset
|
468 | |
365b24f20f98
adds set operations to UcxList
Mike Becker <universe@uap-core.de>
parents:
323
diff
changeset
|
469 | /** |
365b24f20f98
adds set operations to UcxList
Mike Becker <universe@uap-core.de>
parents:
323
diff
changeset
|
470 | * Returns the difference of two lists. |
365b24f20f98
adds set operations to UcxList
Mike Becker <universe@uap-core.de>
parents:
323
diff
changeset
|
471 | * |
365b24f20f98
adds set operations to UcxList
Mike Becker <universe@uap-core.de>
parents:
323
diff
changeset
|
472 | * The difference contains all elements of the left list |
365b24f20f98
adds set operations to UcxList
Mike Becker <universe@uap-core.de>
parents:
323
diff
changeset
|
473 | * (including duplicates) that are not equal to any element of the right list. |
365b24f20f98
adds set operations to UcxList
Mike Becker <universe@uap-core.de>
parents:
323
diff
changeset
|
474 | * |
365b24f20f98
adds set operations to UcxList
Mike Becker <universe@uap-core.de>
parents:
323
diff
changeset
|
475 | * @param left the left source list |
365b24f20f98
adds set operations to UcxList
Mike Becker <universe@uap-core.de>
parents:
323
diff
changeset
|
476 | * @param right the right source list |
365b24f20f98
adds set operations to UcxList
Mike Becker <universe@uap-core.de>
parents:
323
diff
changeset
|
477 | * @param cmpfnc a function to compare elements |
365b24f20f98
adds set operations to UcxList
Mike Becker <universe@uap-core.de>
parents:
323
diff
changeset
|
478 | * @param cmpdata additional data for the compare function |
365b24f20f98
adds set operations to UcxList
Mike Becker <universe@uap-core.de>
parents:
323
diff
changeset
|
479 | * @param cpfnc a function to copy the elements |
365b24f20f98
adds set operations to UcxList
Mike Becker <universe@uap-core.de>
parents:
323
diff
changeset
|
480 | * @param cpdata additional data for the copy function |
365b24f20f98
adds set operations to UcxList
Mike Becker <universe@uap-core.de>
parents:
323
diff
changeset
|
481 | * @return a new list containing the difference |
365b24f20f98
adds set operations to UcxList
Mike Becker <universe@uap-core.de>
parents:
323
diff
changeset
|
482 | */ |
365b24f20f98
adds set operations to UcxList
Mike Becker <universe@uap-core.de>
parents:
323
diff
changeset
|
483 | UcxList* ucx_list_difference(const UcxList *left, const UcxList *right, |
365b24f20f98
adds set operations to UcxList
Mike Becker <universe@uap-core.de>
parents:
323
diff
changeset
|
484 | cmp_func cmpfnc, void* cmpdata, |
365b24f20f98
adds set operations to UcxList
Mike Becker <universe@uap-core.de>
parents:
323
diff
changeset
|
485 | copy_func cpfnc, void* cpdata); |
365b24f20f98
adds set operations to UcxList
Mike Becker <universe@uap-core.de>
parents:
323
diff
changeset
|
486 | |
365b24f20f98
adds set operations to UcxList
Mike Becker <universe@uap-core.de>
parents:
323
diff
changeset
|
487 | /** |
365b24f20f98
adds set operations to UcxList
Mike Becker <universe@uap-core.de>
parents:
323
diff
changeset
|
488 | * Returns the difference of two lists. |
365b24f20f98
adds set operations to UcxList
Mike Becker <universe@uap-core.de>
parents:
323
diff
changeset
|
489 | * |
365b24f20f98
adds set operations to UcxList
Mike Becker <universe@uap-core.de>
parents:
323
diff
changeset
|
490 | * The difference contains all elements of the left list |
365b24f20f98
adds set operations to UcxList
Mike Becker <universe@uap-core.de>
parents:
323
diff
changeset
|
491 | * (including duplicates) that are not equal to any element of the right list. |
365b24f20f98
adds set operations to UcxList
Mike Becker <universe@uap-core.de>
parents:
323
diff
changeset
|
492 | * |
365b24f20f98
adds set operations to UcxList
Mike Becker <universe@uap-core.de>
parents:
323
diff
changeset
|
493 | * @param allocator allocates the new list elements |
365b24f20f98
adds set operations to UcxList
Mike Becker <universe@uap-core.de>
parents:
323
diff
changeset
|
494 | * @param left the left source list |
365b24f20f98
adds set operations to UcxList
Mike Becker <universe@uap-core.de>
parents:
323
diff
changeset
|
495 | * @param right the right source list |
365b24f20f98
adds set operations to UcxList
Mike Becker <universe@uap-core.de>
parents:
323
diff
changeset
|
496 | * @param cmpfnc a function to compare elements |
365b24f20f98
adds set operations to UcxList
Mike Becker <universe@uap-core.de>
parents:
323
diff
changeset
|
497 | * @param cmpdata additional data for the compare function |
365b24f20f98
adds set operations to UcxList
Mike Becker <universe@uap-core.de>
parents:
323
diff
changeset
|
498 | * @param cpfnc a function to copy the elements |
365b24f20f98
adds set operations to UcxList
Mike Becker <universe@uap-core.de>
parents:
323
diff
changeset
|
499 | * @param cpdata additional data for the copy function |
365b24f20f98
adds set operations to UcxList
Mike Becker <universe@uap-core.de>
parents:
323
diff
changeset
|
500 | * @return a new list containing the difference |
365b24f20f98
adds set operations to UcxList
Mike Becker <universe@uap-core.de>
parents:
323
diff
changeset
|
501 | */ |
365b24f20f98
adds set operations to UcxList
Mike Becker <universe@uap-core.de>
parents:
323
diff
changeset
|
502 | UcxList* ucx_list_difference_a(UcxAllocator *allocator, |
365b24f20f98
adds set operations to UcxList
Mike Becker <universe@uap-core.de>
parents:
323
diff
changeset
|
503 | const UcxList *left, const UcxList *right, |
365b24f20f98
adds set operations to UcxList
Mike Becker <universe@uap-core.de>
parents:
323
diff
changeset
|
504 | cmp_func cmpfnc, void* cmpdata, |
365b24f20f98
adds set operations to UcxList
Mike Becker <universe@uap-core.de>
parents:
323
diff
changeset
|
505 | copy_func cpfnc, void* cpdata); |
365b24f20f98
adds set operations to UcxList
Mike Becker <universe@uap-core.de>
parents:
323
diff
changeset
|
506 | |
4 | 507 | #ifdef __cplusplus |
508 | } | |
509 | #endif | |
510 | ||
122
540d99722f1f
removal of single linked list implemenation - step 2: renamed UcxDlist to UcxList (new single implementation)
Mike Becker <universe@uap-core.de>
parents:
121
diff
changeset
|
511 | #endif /* UCX_LIST_H */ |
4 | 512 |