src/ucx/avl.h

Mon, 14 May 2018 17:58:06 +0200

author
Mike Becker <universe@uap-core.de>
date
Mon, 14 May 2018 17:58:06 +0200
branch
constsstr
changeset 307
e2b2b9a5b5ea
parent 259
2f5dea574a75
child 287
98da78a1e69a
permissions
-rw-r--r--

closes constsstr branch

192
1e51558b9d09 updated copyright notice + added files for upcoming AVL tree implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1 /*
1e51558b9d09 updated copyright notice + added files for upcoming AVL tree implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
1e51558b9d09 updated copyright notice + added files for upcoming AVL tree implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
3 *
259
2f5dea574a75 modules documentation
Mike Becker <universe@uap-core.de>
parents: 251
diff changeset
4 * Copyright 2017 Mike Becker, Olaf Wintermann All rights reserved.
192
1e51558b9d09 updated copyright notice + added files for upcoming AVL tree implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
5 *
1e51558b9d09 updated copyright notice + added files for upcoming AVL tree implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
6 * Redistribution and use in source and binary forms, with or without
1e51558b9d09 updated copyright notice + added files for upcoming AVL tree implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
7 * modification, are permitted provided that the following conditions are met:
1e51558b9d09 updated copyright notice + added files for upcoming AVL tree implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
8 *
1e51558b9d09 updated copyright notice + added files for upcoming AVL tree implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
9 * 1. Redistributions of source code must retain the above copyright
1e51558b9d09 updated copyright notice + added files for upcoming AVL tree implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
10 * notice, this list of conditions and the following disclaimer.
1e51558b9d09 updated copyright notice + added files for upcoming AVL tree implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
11 *
1e51558b9d09 updated copyright notice + added files for upcoming AVL tree implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
12 * 2. Redistributions in binary form must reproduce the above copyright
1e51558b9d09 updated copyright notice + added files for upcoming AVL tree implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
13 * notice, this list of conditions and the following disclaimer in the
1e51558b9d09 updated copyright notice + added files for upcoming AVL tree implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
14 * documentation and/or other materials provided with the distribution.
1e51558b9d09 updated copyright notice + added files for upcoming AVL tree implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
15 *
1e51558b9d09 updated copyright notice + added files for upcoming AVL tree implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
1e51558b9d09 updated copyright notice + added files for upcoming AVL tree implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
17 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
1e51558b9d09 updated copyright notice + added files for upcoming AVL tree implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
1e51558b9d09 updated copyright notice + added files for upcoming AVL tree implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
1e51558b9d09 updated copyright notice + added files for upcoming AVL tree implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
20 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
1e51558b9d09 updated copyright notice + added files for upcoming AVL tree implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
21 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
1e51558b9d09 updated copyright notice + added files for upcoming AVL tree implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
22 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
1e51558b9d09 updated copyright notice + added files for upcoming AVL tree implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
23 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
1e51558b9d09 updated copyright notice + added files for upcoming AVL tree implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
24 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
1e51558b9d09 updated copyright notice + added files for upcoming AVL tree implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
25 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
1e51558b9d09 updated copyright notice + added files for upcoming AVL tree implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
26 * POSSIBILITY OF SUCH DAMAGE.
1e51558b9d09 updated copyright notice + added files for upcoming AVL tree implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
27 */
1e51558b9d09 updated copyright notice + added files for upcoming AVL tree implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
28
1e51558b9d09 updated copyright notice + added files for upcoming AVL tree implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
29
1e51558b9d09 updated copyright notice + added files for upcoming AVL tree implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
30 /**
1e51558b9d09 updated copyright notice + added files for upcoming AVL tree implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
31 * @file avl.h
1e51558b9d09 updated copyright notice + added files for upcoming AVL tree implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
32 *
1e51558b9d09 updated copyright notice + added files for upcoming AVL tree implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
33 * AVL tree implementation.
1e51558b9d09 updated copyright notice + added files for upcoming AVL tree implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
34 *
1e51558b9d09 updated copyright notice + added files for upcoming AVL tree implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
35 * This binary search tree implementation allows average O(1) insertion and
204
4477987d40cd better and better and better AVL API
Mike Becker <universe@uap-core.de>
parents: 199
diff changeset
36 * removal of elements (excluding binary search time).
192
1e51558b9d09 updated copyright notice + added files for upcoming AVL tree implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
37 *
1e51558b9d09 updated copyright notice + added files for upcoming AVL tree implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
38 * @author Mike Becker
1e51558b9d09 updated copyright notice + added files for upcoming AVL tree implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
39 * @author Olaf Wintermann
1e51558b9d09 updated copyright notice + added files for upcoming AVL tree implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
40 */
1e51558b9d09 updated copyright notice + added files for upcoming AVL tree implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
41
1e51558b9d09 updated copyright notice + added files for upcoming AVL tree implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
42 #ifndef UCX_AVL_H
194
0c1b7676e74c finalized AVL tree interface + added implementation skeleton + fixed ucx_ptrcmp()
Mike Becker <universe@uap-core.de>
parents: 193
diff changeset
43 #define UCX_AVL_H
192
1e51558b9d09 updated copyright notice + added files for upcoming AVL tree implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
44
259
2f5dea574a75 modules documentation
Mike Becker <universe@uap-core.de>
parents: 251
diff changeset
45 #include "ucx.h"
2f5dea574a75 modules documentation
Mike Becker <universe@uap-core.de>
parents: 251
diff changeset
46 #include "allocator.h"
218
b20d6088795c fixed further usages of SIZE_MAX
Mike Becker <universe@uap-core.de>
parents: 205
diff changeset
47 #include <inttypes.h>
193
fb05d315a0ba defined AVL tree functional interface
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
48
192
1e51558b9d09 updated copyright notice + added files for upcoming AVL tree implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
49 #ifdef __cplusplus
1e51558b9d09 updated copyright notice + added files for upcoming AVL tree implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
50 extern "C" {
1e51558b9d09 updated copyright notice + added files for upcoming AVL tree implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
51 #endif
1e51558b9d09 updated copyright notice + added files for upcoming AVL tree implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
52
193
fb05d315a0ba defined AVL tree functional interface
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
53 /**
fb05d315a0ba defined AVL tree functional interface
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
54 * UCX AVL Node type.
fb05d315a0ba defined AVL tree functional interface
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
55 *
fb05d315a0ba defined AVL tree functional interface
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
56 * @see UcxAVLNode
fb05d315a0ba defined AVL tree functional interface
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
57 */
fb05d315a0ba defined AVL tree functional interface
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
58 typedef struct UcxAVLNode UcxAVLNode;
fb05d315a0ba defined AVL tree functional interface
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
59
fb05d315a0ba defined AVL tree functional interface
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
60 /**
fb05d315a0ba defined AVL tree functional interface
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
61 * UCX AVL Node.
fb05d315a0ba defined AVL tree functional interface
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
62 */
fb05d315a0ba defined AVL tree functional interface
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
63 struct UcxAVLNode {
fb05d315a0ba defined AVL tree functional interface
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
64 /**
fb05d315a0ba defined AVL tree functional interface
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
65 * The key for this node.
fb05d315a0ba defined AVL tree functional interface
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
66 */
194
0c1b7676e74c finalized AVL tree interface + added implementation skeleton + fixed ucx_ptrcmp()
Mike Becker <universe@uap-core.de>
parents: 193
diff changeset
67 intptr_t key;
193
fb05d315a0ba defined AVL tree functional interface
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
68 /**
fb05d315a0ba defined AVL tree functional interface
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
69 * Data contained by this node.
fb05d315a0ba defined AVL tree functional interface
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
70 */
fb05d315a0ba defined AVL tree functional interface
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
71 void *value;
fb05d315a0ba defined AVL tree functional interface
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
72 /**
fb05d315a0ba defined AVL tree functional interface
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
73 * The height of this (sub)-tree.
fb05d315a0ba defined AVL tree functional interface
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
74 */
fb05d315a0ba defined AVL tree functional interface
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
75 size_t height;
fb05d315a0ba defined AVL tree functional interface
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
76 /**
fb05d315a0ba defined AVL tree functional interface
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
77 * Parent node.
fb05d315a0ba defined AVL tree functional interface
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
78 */
fb05d315a0ba defined AVL tree functional interface
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
79 UcxAVLNode *parent;
fb05d315a0ba defined AVL tree functional interface
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
80 /**
fb05d315a0ba defined AVL tree functional interface
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
81 * Root node of left subtree.
fb05d315a0ba defined AVL tree functional interface
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
82 */
fb05d315a0ba defined AVL tree functional interface
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
83 UcxAVLNode *left;
fb05d315a0ba defined AVL tree functional interface
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
84 /**
fb05d315a0ba defined AVL tree functional interface
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
85 * Root node of right subtree.
fb05d315a0ba defined AVL tree functional interface
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
86 */
fb05d315a0ba defined AVL tree functional interface
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
87 UcxAVLNode *right;
fb05d315a0ba defined AVL tree functional interface
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
88 };
fb05d315a0ba defined AVL tree functional interface
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
89
fb05d315a0ba defined AVL tree functional interface
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
90 /**
fb05d315a0ba defined AVL tree functional interface
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
91 * UCX AVL Tree.
fb05d315a0ba defined AVL tree functional interface
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
92 */
fb05d315a0ba defined AVL tree functional interface
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
93 typedef struct {
fb05d315a0ba defined AVL tree functional interface
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
94 /**
194
0c1b7676e74c finalized AVL tree interface + added implementation skeleton + fixed ucx_ptrcmp()
Mike Becker <universe@uap-core.de>
parents: 193
diff changeset
95 * The UcxAllocator that shall be used to manage the memory for node data.
0c1b7676e74c finalized AVL tree interface + added implementation skeleton + fixed ucx_ptrcmp()
Mike Becker <universe@uap-core.de>
parents: 193
diff changeset
96 */
0c1b7676e74c finalized AVL tree interface + added implementation skeleton + fixed ucx_ptrcmp()
Mike Becker <universe@uap-core.de>
parents: 193
diff changeset
97 UcxAllocator *allocator;
0c1b7676e74c finalized AVL tree interface + added implementation skeleton + fixed ucx_ptrcmp()
Mike Becker <universe@uap-core.de>
parents: 193
diff changeset
98 /**
193
fb05d315a0ba defined AVL tree functional interface
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
99 * Root node of the tree.
fb05d315a0ba defined AVL tree functional interface
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
100 */
fb05d315a0ba defined AVL tree functional interface
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
101 UcxAVLNode *root;
fb05d315a0ba defined AVL tree functional interface
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
102 /**
fb05d315a0ba defined AVL tree functional interface
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
103 * Compare function that shall be used to compare the UcxAVLNode keys.
fb05d315a0ba defined AVL tree functional interface
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
104 * @see UcxAVLNode.key
fb05d315a0ba defined AVL tree functional interface
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
105 */
fb05d315a0ba defined AVL tree functional interface
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
106 cmp_func cmpfunc;
fb05d315a0ba defined AVL tree functional interface
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
107 /**
fb05d315a0ba defined AVL tree functional interface
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
108 * Custom user data.
fb05d315a0ba defined AVL tree functional interface
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
109 * This data will also be provided to the cmpfunc.
fb05d315a0ba defined AVL tree functional interface
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
110 */
fb05d315a0ba defined AVL tree functional interface
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
111 void *userdata;
fb05d315a0ba defined AVL tree functional interface
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
112 } UcxAVLTree;
fb05d315a0ba defined AVL tree functional interface
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
113
fb05d315a0ba defined AVL tree functional interface
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
114 /**
194
0c1b7676e74c finalized AVL tree interface + added implementation skeleton + fixed ucx_ptrcmp()
Mike Becker <universe@uap-core.de>
parents: 193
diff changeset
115 * Initializes a new UcxAVLTree with a default allocator.
0c1b7676e74c finalized AVL tree interface + added implementation skeleton + fixed ucx_ptrcmp()
Mike Becker <universe@uap-core.de>
parents: 193
diff changeset
116 *
0c1b7676e74c finalized AVL tree interface + added implementation skeleton + fixed ucx_ptrcmp()
Mike Becker <universe@uap-core.de>
parents: 193
diff changeset
117 * @param cmpfunc the compare function that shall be used
0c1b7676e74c finalized AVL tree interface + added implementation skeleton + fixed ucx_ptrcmp()
Mike Becker <universe@uap-core.de>
parents: 193
diff changeset
118 * @return a new UcxAVLTree object
0c1b7676e74c finalized AVL tree interface + added implementation skeleton + fixed ucx_ptrcmp()
Mike Becker <universe@uap-core.de>
parents: 193
diff changeset
119 * @see ucx_avl_new_a()
0c1b7676e74c finalized AVL tree interface + added implementation skeleton + fixed ucx_ptrcmp()
Mike Becker <universe@uap-core.de>
parents: 193
diff changeset
120 */
0c1b7676e74c finalized AVL tree interface + added implementation skeleton + fixed ucx_ptrcmp()
Mike Becker <universe@uap-core.de>
parents: 193
diff changeset
121 UcxAVLTree *ucx_avl_new(cmp_func cmpfunc);
0c1b7676e74c finalized AVL tree interface + added implementation skeleton + fixed ucx_ptrcmp()
Mike Becker <universe@uap-core.de>
parents: 193
diff changeset
122
0c1b7676e74c finalized AVL tree interface + added implementation skeleton + fixed ucx_ptrcmp()
Mike Becker <universe@uap-core.de>
parents: 193
diff changeset
123 /**
0c1b7676e74c finalized AVL tree interface + added implementation skeleton + fixed ucx_ptrcmp()
Mike Becker <universe@uap-core.de>
parents: 193
diff changeset
124 * Initializes a new UcxAVLTree with the specified allocator.
0c1b7676e74c finalized AVL tree interface + added implementation skeleton + fixed ucx_ptrcmp()
Mike Becker <universe@uap-core.de>
parents: 193
diff changeset
125 *
0c1b7676e74c finalized AVL tree interface + added implementation skeleton + fixed ucx_ptrcmp()
Mike Becker <universe@uap-core.de>
parents: 193
diff changeset
126 * The cmpfunc should be capable of comparing two keys within this AVL tree.
0c1b7676e74c finalized AVL tree interface + added implementation skeleton + fixed ucx_ptrcmp()
Mike Becker <universe@uap-core.de>
parents: 193
diff changeset
127 * So if you want to use null terminated strings as keys, you could use the
0c1b7676e74c finalized AVL tree interface + added implementation skeleton + fixed ucx_ptrcmp()
Mike Becker <universe@uap-core.de>
parents: 193
diff changeset
128 * ucx_strcmp() function here.
0c1b7676e74c finalized AVL tree interface + added implementation skeleton + fixed ucx_ptrcmp()
Mike Becker <universe@uap-core.de>
parents: 193
diff changeset
129 *
0c1b7676e74c finalized AVL tree interface + added implementation skeleton + fixed ucx_ptrcmp()
Mike Becker <universe@uap-core.de>
parents: 193
diff changeset
130 * @param cmpfunc the compare function that shall be used
0c1b7676e74c finalized AVL tree interface + added implementation skeleton + fixed ucx_ptrcmp()
Mike Becker <universe@uap-core.de>
parents: 193
diff changeset
131 * @param allocator the UcxAllocator that shall be used
0c1b7676e74c finalized AVL tree interface + added implementation skeleton + fixed ucx_ptrcmp()
Mike Becker <universe@uap-core.de>
parents: 193
diff changeset
132 * @return a new UcxAVLTree object
0c1b7676e74c finalized AVL tree interface + added implementation skeleton + fixed ucx_ptrcmp()
Mike Becker <universe@uap-core.de>
parents: 193
diff changeset
133 */
0c1b7676e74c finalized AVL tree interface + added implementation skeleton + fixed ucx_ptrcmp()
Mike Becker <universe@uap-core.de>
parents: 193
diff changeset
134 UcxAVLTree *ucx_avl_new_a(cmp_func cmpfunc, UcxAllocator *allocator);
0c1b7676e74c finalized AVL tree interface + added implementation skeleton + fixed ucx_ptrcmp()
Mike Becker <universe@uap-core.de>
parents: 193
diff changeset
135
0c1b7676e74c finalized AVL tree interface + added implementation skeleton + fixed ucx_ptrcmp()
Mike Becker <universe@uap-core.de>
parents: 193
diff changeset
136 /**
225
a1a068c2c4ef updates documenting comments
Mike Becker <universe@uap-core.de>
parents: 218
diff changeset
137 * Destroys a UcxAVLTree.
196
1b4cdafef2eb added free() to AVL tree implementation + use UcxAllocator
Mike Becker <universe@uap-core.de>
parents: 194
diff changeset
138 * @param tree the tree to destroy
1b4cdafef2eb added free() to AVL tree implementation + use UcxAllocator
Mike Becker <universe@uap-core.de>
parents: 194
diff changeset
139 */
1b4cdafef2eb added free() to AVL tree implementation + use UcxAllocator
Mike Becker <universe@uap-core.de>
parents: 194
diff changeset
140 void ucx_avl_free(UcxAVLTree *tree);
1b4cdafef2eb added free() to AVL tree implementation + use UcxAllocator
Mike Becker <universe@uap-core.de>
parents: 194
diff changeset
141
1b4cdafef2eb added free() to AVL tree implementation + use UcxAllocator
Mike Becker <universe@uap-core.de>
parents: 194
diff changeset
142 /**
194
0c1b7676e74c finalized AVL tree interface + added implementation skeleton + fixed ucx_ptrcmp()
Mike Becker <universe@uap-core.de>
parents: 193
diff changeset
143 * Macro for initializing a new UcxAVLTree with the default allocator and a
0c1b7676e74c finalized AVL tree interface + added implementation skeleton + fixed ucx_ptrcmp()
Mike Becker <universe@uap-core.de>
parents: 193
diff changeset
144 * ucx_ptrcmp() compare function.
0c1b7676e74c finalized AVL tree interface + added implementation skeleton + fixed ucx_ptrcmp()
Mike Becker <universe@uap-core.de>
parents: 193
diff changeset
145 *
0c1b7676e74c finalized AVL tree interface + added implementation skeleton + fixed ucx_ptrcmp()
Mike Becker <universe@uap-core.de>
parents: 193
diff changeset
146 * @return a new default UcxAVLTree object
0c1b7676e74c finalized AVL tree interface + added implementation skeleton + fixed ucx_ptrcmp()
Mike Becker <universe@uap-core.de>
parents: 193
diff changeset
147 */
0c1b7676e74c finalized AVL tree interface + added implementation skeleton + fixed ucx_ptrcmp()
Mike Becker <universe@uap-core.de>
parents: 193
diff changeset
148 #define ucx_avl_default_new() ucx_avl_new_a(ucx_ptrcmp, ucx_default_allocator())
0c1b7676e74c finalized AVL tree interface + added implementation skeleton + fixed ucx_ptrcmp()
Mike Becker <universe@uap-core.de>
parents: 193
diff changeset
149
0c1b7676e74c finalized AVL tree interface + added implementation skeleton + fixed ucx_ptrcmp()
Mike Becker <universe@uap-core.de>
parents: 193
diff changeset
150 /**
204
4477987d40cd better and better and better AVL API
Mike Becker <universe@uap-core.de>
parents: 199
diff changeset
151 * Gets the node from the tree, that is associated with the specified key.
4477987d40cd better and better and better AVL API
Mike Becker <universe@uap-core.de>
parents: 199
diff changeset
152 * @param tree the UcxAVLTree
4477987d40cd better and better and better AVL API
Mike Becker <universe@uap-core.de>
parents: 199
diff changeset
153 * @param key the key
4477987d40cd better and better and better AVL API
Mike Becker <universe@uap-core.de>
parents: 199
diff changeset
154 * @return the node (or <code>NULL</code>, if the key is not present)
4477987d40cd better and better and better AVL API
Mike Becker <universe@uap-core.de>
parents: 199
diff changeset
155 */
205
54a7ceb9151f improved avl function names
Mike Becker <universe@uap-core.de>
parents: 204
diff changeset
156 UcxAVLNode *ucx_avl_get_node(UcxAVLTree *tree, intptr_t key);
204
4477987d40cd better and better and better AVL API
Mike Becker <universe@uap-core.de>
parents: 199
diff changeset
157
4477987d40cd better and better and better AVL API
Mike Becker <universe@uap-core.de>
parents: 199
diff changeset
158 /**
193
fb05d315a0ba defined AVL tree functional interface
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
159 * Gets the value from the tree, that is associated with the specified key.
fb05d315a0ba defined AVL tree functional interface
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
160 * @param tree the UcxAVLTree
fb05d315a0ba defined AVL tree functional interface
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
161 * @param key the key
fb05d315a0ba defined AVL tree functional interface
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
162 * @return the value (or <code>NULL</code>, if the key is not present)
fb05d315a0ba defined AVL tree functional interface
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
163 */
194
0c1b7676e74c finalized AVL tree interface + added implementation skeleton + fixed ucx_ptrcmp()
Mike Becker <universe@uap-core.de>
parents: 193
diff changeset
164 void *ucx_avl_get(UcxAVLTree *tree, intptr_t key);
193
fb05d315a0ba defined AVL tree functional interface
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
165
fb05d315a0ba defined AVL tree functional interface
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
166 /**
243
2e74828c5e94 adds distance function and ucx_avl_find_node()
Mike Becker <universe@uap-core.de>
parents: 225
diff changeset
167 * A mode for #ucx_avl_find_node() with the same behavior as
2e74828c5e94 adds distance function and ucx_avl_find_node()
Mike Becker <universe@uap-core.de>
parents: 225
diff changeset
168 * #ucx_avl_get_node().
2e74828c5e94 adds distance function and ucx_avl_find_node()
Mike Becker <universe@uap-core.de>
parents: 225
diff changeset
169 */
2e74828c5e94 adds distance function and ucx_avl_find_node()
Mike Becker <universe@uap-core.de>
parents: 225
diff changeset
170 #define UCX_AVL_FIND_EXACT 0
2e74828c5e94 adds distance function and ucx_avl_find_node()
Mike Becker <universe@uap-core.de>
parents: 225
diff changeset
171 /**
2e74828c5e94 adds distance function and ucx_avl_find_node()
Mike Becker <universe@uap-core.de>
parents: 225
diff changeset
172 * A mode for #ucx_avl_find_node() finding the node whose key is at least
2e74828c5e94 adds distance function and ucx_avl_find_node()
Mike Becker <universe@uap-core.de>
parents: 225
diff changeset
173 * as large as the specified key.
2e74828c5e94 adds distance function and ucx_avl_find_node()
Mike Becker <universe@uap-core.de>
parents: 225
diff changeset
174 */
2e74828c5e94 adds distance function and ucx_avl_find_node()
Mike Becker <universe@uap-core.de>
parents: 225
diff changeset
175 #define UCX_AVL_FIND_LOWER_BOUNDED 1
2e74828c5e94 adds distance function and ucx_avl_find_node()
Mike Becker <universe@uap-core.de>
parents: 225
diff changeset
176 /**
2e74828c5e94 adds distance function and ucx_avl_find_node()
Mike Becker <universe@uap-core.de>
parents: 225
diff changeset
177 * A mode for #ucx_avl_find_node() finding the node whose key is at most
2e74828c5e94 adds distance function and ucx_avl_find_node()
Mike Becker <universe@uap-core.de>
parents: 225
diff changeset
178 * as large as the specified key.
2e74828c5e94 adds distance function and ucx_avl_find_node()
Mike Becker <universe@uap-core.de>
parents: 225
diff changeset
179 */
2e74828c5e94 adds distance function and ucx_avl_find_node()
Mike Becker <universe@uap-core.de>
parents: 225
diff changeset
180 #define UCX_AVL_FIND_UPPER_BOUNDED 2
2e74828c5e94 adds distance function and ucx_avl_find_node()
Mike Becker <universe@uap-core.de>
parents: 225
diff changeset
181 /**
2e74828c5e94 adds distance function and ucx_avl_find_node()
Mike Becker <universe@uap-core.de>
parents: 225
diff changeset
182 * A mode for #ucx_avl_find_node() finding the node with a key that is as close
2e74828c5e94 adds distance function and ucx_avl_find_node()
Mike Becker <universe@uap-core.de>
parents: 225
diff changeset
183 * to the specified key as possible. If the key is present, the behavior is
2e74828c5e94 adds distance function and ucx_avl_find_node()
Mike Becker <universe@uap-core.de>
parents: 225
diff changeset
184 * like #ucx_avl_get_node(). This mode only returns <code>NULL</code> on
2e74828c5e94 adds distance function and ucx_avl_find_node()
Mike Becker <universe@uap-core.de>
parents: 225
diff changeset
185 * empty trees.
2e74828c5e94 adds distance function and ucx_avl_find_node()
Mike Becker <universe@uap-core.de>
parents: 225
diff changeset
186 */
2e74828c5e94 adds distance function and ucx_avl_find_node()
Mike Becker <universe@uap-core.de>
parents: 225
diff changeset
187 #define UCX_AVL_FIND_CLOSEST 3
2e74828c5e94 adds distance function and ucx_avl_find_node()
Mike Becker <universe@uap-core.de>
parents: 225
diff changeset
188
2e74828c5e94 adds distance function and ucx_avl_find_node()
Mike Becker <universe@uap-core.de>
parents: 225
diff changeset
189 /**
2e74828c5e94 adds distance function and ucx_avl_find_node()
Mike Becker <universe@uap-core.de>
parents: 225
diff changeset
190 * Finds a node within the tree. The following modes are supported:
2e74828c5e94 adds distance function and ucx_avl_find_node()
Mike Becker <universe@uap-core.de>
parents: 225
diff changeset
191 * <ul>
2e74828c5e94 adds distance function and ucx_avl_find_node()
Mike Becker <universe@uap-core.de>
parents: 225
diff changeset
192 * <li>#UCX_AVL_FIND_EXACT: the same behavior as #ucx_avl_get_node()</li>
2e74828c5e94 adds distance function and ucx_avl_find_node()
Mike Becker <universe@uap-core.de>
parents: 225
diff changeset
193 * <li>#UCX_AVL_FIND_LOWER_BOUNDED: finds the node whose key is at least
2e74828c5e94 adds distance function and ucx_avl_find_node()
Mike Becker <universe@uap-core.de>
parents: 225
diff changeset
194 * as large as the specified key</li>
2e74828c5e94 adds distance function and ucx_avl_find_node()
Mike Becker <universe@uap-core.de>
parents: 225
diff changeset
195 * <li>#UCX_AVL_FIND_UPPER_BOUNDED: finds the node whose key is at most
2e74828c5e94 adds distance function and ucx_avl_find_node()
Mike Becker <universe@uap-core.de>
parents: 225
diff changeset
196 * as large as the specified key</li>
2e74828c5e94 adds distance function and ucx_avl_find_node()
Mike Becker <universe@uap-core.de>
parents: 225
diff changeset
197 * <li>#UCX_AVL_FIND_CLOSEST: finds the node with a key that is as close to
2e74828c5e94 adds distance function and ucx_avl_find_node()
Mike Becker <universe@uap-core.de>
parents: 225
diff changeset
198 * the specified key as possible. If the key is present, the behavior is
2e74828c5e94 adds distance function and ucx_avl_find_node()
Mike Becker <universe@uap-core.de>
parents: 225
diff changeset
199 * like #ucx_avl_get_node(). This mode only returns <code>NULL</code> on
2e74828c5e94 adds distance function and ucx_avl_find_node()
Mike Becker <universe@uap-core.de>
parents: 225
diff changeset
200 * empty trees.</li>
2e74828c5e94 adds distance function and ucx_avl_find_node()
Mike Becker <universe@uap-core.de>
parents: 225
diff changeset
201 * </ul>
2e74828c5e94 adds distance function and ucx_avl_find_node()
Mike Becker <universe@uap-core.de>
parents: 225
diff changeset
202 *
2e74828c5e94 adds distance function and ucx_avl_find_node()
Mike Becker <universe@uap-core.de>
parents: 225
diff changeset
203 * The distance function provided MUST agree with the compare function of
2e74828c5e94 adds distance function and ucx_avl_find_node()
Mike Becker <universe@uap-core.de>
parents: 225
diff changeset
204 * the AVL tree.
2e74828c5e94 adds distance function and ucx_avl_find_node()
Mike Becker <universe@uap-core.de>
parents: 225
diff changeset
205 *
2e74828c5e94 adds distance function and ucx_avl_find_node()
Mike Becker <universe@uap-core.de>
parents: 225
diff changeset
206 * @param tree the UcxAVLTree
2e74828c5e94 adds distance function and ucx_avl_find_node()
Mike Becker <universe@uap-core.de>
parents: 225
diff changeset
207 * @param key the key
2e74828c5e94 adds distance function and ucx_avl_find_node()
Mike Becker <universe@uap-core.de>
parents: 225
diff changeset
208 * @param dfnc the distance function
2e74828c5e94 adds distance function and ucx_avl_find_node()
Mike Becker <universe@uap-core.de>
parents: 225
diff changeset
209 * @param mode the find mode
2e74828c5e94 adds distance function and ucx_avl_find_node()
Mike Becker <universe@uap-core.de>
parents: 225
diff changeset
210 * @return the node (or <code>NULL</code>, if no node can be found)
2e74828c5e94 adds distance function and ucx_avl_find_node()
Mike Becker <universe@uap-core.de>
parents: 225
diff changeset
211 */
2e74828c5e94 adds distance function and ucx_avl_find_node()
Mike Becker <universe@uap-core.de>
parents: 225
diff changeset
212 UcxAVLNode *ucx_avl_find_node(UcxAVLTree *tree, intptr_t key,
2e74828c5e94 adds distance function and ucx_avl_find_node()
Mike Becker <universe@uap-core.de>
parents: 225
diff changeset
213 distance_func dfnc, int mode);
2e74828c5e94 adds distance function and ucx_avl_find_node()
Mike Becker <universe@uap-core.de>
parents: 225
diff changeset
214
2e74828c5e94 adds distance function and ucx_avl_find_node()
Mike Becker <universe@uap-core.de>
parents: 225
diff changeset
215 /**
2e74828c5e94 adds distance function and ucx_avl_find_node()
Mike Becker <universe@uap-core.de>
parents: 225
diff changeset
216 * Finds a value within the tree.
2e74828c5e94 adds distance function and ucx_avl_find_node()
Mike Becker <universe@uap-core.de>
parents: 225
diff changeset
217 * See #ucx_avl_find_node() for details.
2e74828c5e94 adds distance function and ucx_avl_find_node()
Mike Becker <universe@uap-core.de>
parents: 225
diff changeset
218 *
2e74828c5e94 adds distance function and ucx_avl_find_node()
Mike Becker <universe@uap-core.de>
parents: 225
diff changeset
219 * @param tree the UcxAVLTree
2e74828c5e94 adds distance function and ucx_avl_find_node()
Mike Becker <universe@uap-core.de>
parents: 225
diff changeset
220 * @param key the key
2e74828c5e94 adds distance function and ucx_avl_find_node()
Mike Becker <universe@uap-core.de>
parents: 225
diff changeset
221 * @param dfnc the distance function
2e74828c5e94 adds distance function and ucx_avl_find_node()
Mike Becker <universe@uap-core.de>
parents: 225
diff changeset
222 * @param mode the find mode
2e74828c5e94 adds distance function and ucx_avl_find_node()
Mike Becker <universe@uap-core.de>
parents: 225
diff changeset
223 * @return the value (or <code>NULL</code>, if no value can be found)
2e74828c5e94 adds distance function and ucx_avl_find_node()
Mike Becker <universe@uap-core.de>
parents: 225
diff changeset
224 */
2e74828c5e94 adds distance function and ucx_avl_find_node()
Mike Becker <universe@uap-core.de>
parents: 225
diff changeset
225 void *ucx_avl_find(UcxAVLTree *tree, intptr_t key,
2e74828c5e94 adds distance function and ucx_avl_find_node()
Mike Becker <universe@uap-core.de>
parents: 225
diff changeset
226 distance_func dfnc, int mode);
2e74828c5e94 adds distance function and ucx_avl_find_node()
Mike Becker <universe@uap-core.de>
parents: 225
diff changeset
227
2e74828c5e94 adds distance function and ucx_avl_find_node()
Mike Becker <universe@uap-core.de>
parents: 225
diff changeset
228 /**
193
fb05d315a0ba defined AVL tree functional interface
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
229 * Puts a key/value pair into the tree.
204
4477987d40cd better and better and better AVL API
Mike Becker <universe@uap-core.de>
parents: 199
diff changeset
230 *
4477987d40cd better and better and better AVL API
Mike Becker <universe@uap-core.de>
parents: 199
diff changeset
231 * Attention: use this function only, if a possible old value does not need
4477987d40cd better and better and better AVL API
Mike Becker <universe@uap-core.de>
parents: 199
diff changeset
232 * to be preserved.
4477987d40cd better and better and better AVL API
Mike Becker <universe@uap-core.de>
parents: 199
diff changeset
233 *
4477987d40cd better and better and better AVL API
Mike Becker <universe@uap-core.de>
parents: 199
diff changeset
234 * @param tree the UcxAVLTree
4477987d40cd better and better and better AVL API
Mike Becker <universe@uap-core.de>
parents: 199
diff changeset
235 * @param key the key
4477987d40cd better and better and better AVL API
Mike Becker <universe@uap-core.de>
parents: 199
diff changeset
236 * @param value the new value
4477987d40cd better and better and better AVL API
Mike Becker <universe@uap-core.de>
parents: 199
diff changeset
237 * @return zero, if and only if the operation succeeded
4477987d40cd better and better and better AVL API
Mike Becker <universe@uap-core.de>
parents: 199
diff changeset
238 */
4477987d40cd better and better and better AVL API
Mike Becker <universe@uap-core.de>
parents: 199
diff changeset
239 int ucx_avl_put(UcxAVLTree *tree, intptr_t key, void *value);
4477987d40cd better and better and better AVL API
Mike Becker <universe@uap-core.de>
parents: 199
diff changeset
240
4477987d40cd better and better and better AVL API
Mike Becker <universe@uap-core.de>
parents: 199
diff changeset
241 /**
4477987d40cd better and better and better AVL API
Mike Becker <universe@uap-core.de>
parents: 199
diff changeset
242 * Puts a key/value pair into the tree.
4477987d40cd better and better and better AVL API
Mike Becker <universe@uap-core.de>
parents: 199
diff changeset
243 *
4477987d40cd better and better and better AVL API
Mike Becker <universe@uap-core.de>
parents: 199
diff changeset
244 * This is a secure function which saves the old value to the variable pointed
4477987d40cd better and better and better AVL API
Mike Becker <universe@uap-core.de>
parents: 199
diff changeset
245 * at by oldvalue.
4477987d40cd better and better and better AVL API
Mike Becker <universe@uap-core.de>
parents: 199
diff changeset
246 *
193
fb05d315a0ba defined AVL tree functional interface
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
247 * @param tree the UcxAVLTree
fb05d315a0ba defined AVL tree functional interface
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
248 * @param key the key
fb05d315a0ba defined AVL tree functional interface
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
249 * @param value the new value
204
4477987d40cd better and better and better AVL API
Mike Becker <universe@uap-core.de>
parents: 199
diff changeset
250 * @param oldvalue optional: a pointer to the location where a possible old
4477987d40cd better and better and better AVL API
Mike Becker <universe@uap-core.de>
parents: 199
diff changeset
251 * value shall be stored
4477987d40cd better and better and better AVL API
Mike Becker <universe@uap-core.de>
parents: 199
diff changeset
252 * @return zero, if and only if the operation succeeded
193
fb05d315a0ba defined AVL tree functional interface
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
253 */
204
4477987d40cd better and better and better AVL API
Mike Becker <universe@uap-core.de>
parents: 199
diff changeset
254 int ucx_avl_put_s(UcxAVLTree *tree, intptr_t key, void *value, void **oldvalue);
4477987d40cd better and better and better AVL API
Mike Becker <universe@uap-core.de>
parents: 199
diff changeset
255
4477987d40cd better and better and better AVL API
Mike Becker <universe@uap-core.de>
parents: 199
diff changeset
256 /**
4477987d40cd better and better and better AVL API
Mike Becker <universe@uap-core.de>
parents: 199
diff changeset
257 * Removes a node from the AVL tree.
4477987d40cd better and better and better AVL API
Mike Becker <universe@uap-core.de>
parents: 199
diff changeset
258 *
4477987d40cd better and better and better AVL API
Mike Becker <universe@uap-core.de>
parents: 199
diff changeset
259 * Note: the specified node is logically removed. The tree implementation
4477987d40cd better and better and better AVL API
Mike Becker <universe@uap-core.de>
parents: 199
diff changeset
260 * decides which memory area is freed. In most cases the here provided node
243
2e74828c5e94 adds distance function and ucx_avl_find_node()
Mike Becker <universe@uap-core.de>
parents: 225
diff changeset
261 * is freed, so its further use is generally undefined.
204
4477987d40cd better and better and better AVL API
Mike Becker <universe@uap-core.de>
parents: 199
diff changeset
262 *
4477987d40cd better and better and better AVL API
Mike Becker <universe@uap-core.de>
parents: 199
diff changeset
263 * @param tree the UcxAVLTree
4477987d40cd better and better and better AVL API
Mike Becker <universe@uap-core.de>
parents: 199
diff changeset
264 * @param node the node to remove
4477987d40cd better and better and better AVL API
Mike Becker <universe@uap-core.de>
parents: 199
diff changeset
265 * @return zero, if and only if an element has been removed
4477987d40cd better and better and better AVL API
Mike Becker <universe@uap-core.de>
parents: 199
diff changeset
266 */
205
54a7ceb9151f improved avl function names
Mike Becker <universe@uap-core.de>
parents: 204
diff changeset
267 int ucx_avl_remove_node(UcxAVLTree *tree, UcxAVLNode *node);
193
fb05d315a0ba defined AVL tree functional interface
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
268
fb05d315a0ba defined AVL tree functional interface
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
269 /**
fb05d315a0ba defined AVL tree functional interface
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
270 * Removes an element from the AVL tree.
204
4477987d40cd better and better and better AVL API
Mike Becker <universe@uap-core.de>
parents: 199
diff changeset
271 *
193
fb05d315a0ba defined AVL tree functional interface
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
272 * @param tree the UcxAVLTree
fb05d315a0ba defined AVL tree functional interface
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
273 * @param key the key
204
4477987d40cd better and better and better AVL API
Mike Becker <universe@uap-core.de>
parents: 199
diff changeset
274 * @return zero, if and only if an element has been removed
193
fb05d315a0ba defined AVL tree functional interface
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
275 */
204
4477987d40cd better and better and better AVL API
Mike Becker <universe@uap-core.de>
parents: 199
diff changeset
276 int ucx_avl_remove(UcxAVLTree *tree, intptr_t key);
4477987d40cd better and better and better AVL API
Mike Becker <universe@uap-core.de>
parents: 199
diff changeset
277
4477987d40cd better and better and better AVL API
Mike Becker <universe@uap-core.de>
parents: 199
diff changeset
278 /**
4477987d40cd better and better and better AVL API
Mike Becker <universe@uap-core.de>
parents: 199
diff changeset
279 * Removes an element from the AVL tree.
4477987d40cd better and better and better AVL API
Mike Becker <universe@uap-core.de>
parents: 199
diff changeset
280 *
4477987d40cd better and better and better AVL API
Mike Becker <universe@uap-core.de>
parents: 199
diff changeset
281 * This is a secure function which saves the old key and value data from node
4477987d40cd better and better and better AVL API
Mike Becker <universe@uap-core.de>
parents: 199
diff changeset
282 * to the variables at the location of oldkey and oldvalue (if specified), so
4477987d40cd better and better and better AVL API
Mike Becker <universe@uap-core.de>
parents: 199
diff changeset
283 * they can be freed afterwards (if necessary).
4477987d40cd better and better and better AVL API
Mike Becker <universe@uap-core.de>
parents: 199
diff changeset
284 *
4477987d40cd better and better and better AVL API
Mike Becker <universe@uap-core.de>
parents: 199
diff changeset
285 * Note: the returned key in oldkey is possibly not the same as the provided
4477987d40cd better and better and better AVL API
Mike Becker <universe@uap-core.de>
parents: 199
diff changeset
286 * key for the lookup (in terms of memory location).
4477987d40cd better and better and better AVL API
Mike Becker <universe@uap-core.de>
parents: 199
diff changeset
287 *
4477987d40cd better and better and better AVL API
Mike Becker <universe@uap-core.de>
parents: 199
diff changeset
288 * @param tree the UcxAVLTree
4477987d40cd better and better and better AVL API
Mike Becker <universe@uap-core.de>
parents: 199
diff changeset
289 * @param key the key of the element to remove
4477987d40cd better and better and better AVL API
Mike Becker <universe@uap-core.de>
parents: 199
diff changeset
290 * @param oldkey optional: a pointer to the location where the old key shall be
4477987d40cd better and better and better AVL API
Mike Becker <universe@uap-core.de>
parents: 199
diff changeset
291 * stored
4477987d40cd better and better and better AVL API
Mike Becker <universe@uap-core.de>
parents: 199
diff changeset
292 * @param oldvalue optional: a pointer to the location where the old value
4477987d40cd better and better and better AVL API
Mike Becker <universe@uap-core.de>
parents: 199
diff changeset
293 * shall be stored
4477987d40cd better and better and better AVL API
Mike Becker <universe@uap-core.de>
parents: 199
diff changeset
294 * @return zero, if and only if an element has been removed
4477987d40cd better and better and better AVL API
Mike Becker <universe@uap-core.de>
parents: 199
diff changeset
295 */
4477987d40cd better and better and better AVL API
Mike Becker <universe@uap-core.de>
parents: 199
diff changeset
296 int ucx_avl_remove_s(UcxAVLTree *tree, intptr_t key,
4477987d40cd better and better and better AVL API
Mike Becker <universe@uap-core.de>
parents: 199
diff changeset
297 intptr_t *oldkey, void **oldvalue);
192
1e51558b9d09 updated copyright notice + added files for upcoming AVL tree implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
298
199
e25dc68336ec added ucx_avl_count
Mike Becker <universe@uap-core.de>
parents: 196
diff changeset
299 /**
e25dc68336ec added ucx_avl_count
Mike Becker <universe@uap-core.de>
parents: 196
diff changeset
300 * Counts the nodes in the specified UcxAVLTree.
e25dc68336ec added ucx_avl_count
Mike Becker <universe@uap-core.de>
parents: 196
diff changeset
301 * @param tree the AVL tree
e25dc68336ec added ucx_avl_count
Mike Becker <universe@uap-core.de>
parents: 196
diff changeset
302 * @return the node count
e25dc68336ec added ucx_avl_count
Mike Becker <universe@uap-core.de>
parents: 196
diff changeset
303 */
e25dc68336ec added ucx_avl_count
Mike Becker <universe@uap-core.de>
parents: 196
diff changeset
304 size_t ucx_avl_count(UcxAVLTree *tree);
192
1e51558b9d09 updated copyright notice + added files for upcoming AVL tree implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
305
245
db732f8c083a adds AVL predecessor and successor functions
Mike Becker <universe@uap-core.de>
parents: 243
diff changeset
306 /**
db732f8c083a adds AVL predecessor and successor functions
Mike Becker <universe@uap-core.de>
parents: 243
diff changeset
307 * Finds the in-order predecessor of the given node.
db732f8c083a adds AVL predecessor and successor functions
Mike Becker <universe@uap-core.de>
parents: 243
diff changeset
308 * @param node an AVL node
db732f8c083a adds AVL predecessor and successor functions
Mike Becker <universe@uap-core.de>
parents: 243
diff changeset
309 * @return the in-order predecessor of the given node, or <code>NULL</code> if
db732f8c083a adds AVL predecessor and successor functions
Mike Becker <universe@uap-core.de>
parents: 243
diff changeset
310 * the given node is the in-order minimum
db732f8c083a adds AVL predecessor and successor functions
Mike Becker <universe@uap-core.de>
parents: 243
diff changeset
311 */
db732f8c083a adds AVL predecessor and successor functions
Mike Becker <universe@uap-core.de>
parents: 243
diff changeset
312 UcxAVLNode* ucx_avl_pred(UcxAVLNode* node);
db732f8c083a adds AVL predecessor and successor functions
Mike Becker <universe@uap-core.de>
parents: 243
diff changeset
313
db732f8c083a adds AVL predecessor and successor functions
Mike Becker <universe@uap-core.de>
parents: 243
diff changeset
314 /**
db732f8c083a adds AVL predecessor and successor functions
Mike Becker <universe@uap-core.de>
parents: 243
diff changeset
315 * Finds the in-order successor of the given node.
db732f8c083a adds AVL predecessor and successor functions
Mike Becker <universe@uap-core.de>
parents: 243
diff changeset
316 * @param node an AVL node
db732f8c083a adds AVL predecessor and successor functions
Mike Becker <universe@uap-core.de>
parents: 243
diff changeset
317 * @return the in-order successor of the given node, or <code>NULL</code> if
db732f8c083a adds AVL predecessor and successor functions
Mike Becker <universe@uap-core.de>
parents: 243
diff changeset
318 * the given node is the in-order maximum
db732f8c083a adds AVL predecessor and successor functions
Mike Becker <universe@uap-core.de>
parents: 243
diff changeset
319 */
db732f8c083a adds AVL predecessor and successor functions
Mike Becker <universe@uap-core.de>
parents: 243
diff changeset
320 UcxAVLNode* ucx_avl_succ(UcxAVLNode* node);
db732f8c083a adds AVL predecessor and successor functions
Mike Becker <universe@uap-core.de>
parents: 243
diff changeset
321
192
1e51558b9d09 updated copyright notice + added files for upcoming AVL tree implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
322 #ifdef __cplusplus
1e51558b9d09 updated copyright notice + added files for upcoming AVL tree implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
323 }
1e51558b9d09 updated copyright notice + added files for upcoming AVL tree implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
324 #endif
1e51558b9d09 updated copyright notice + added files for upcoming AVL tree implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
325
1e51558b9d09 updated copyright notice + added files for upcoming AVL tree implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
326 #endif /* UCX_AVL_H */
1e51558b9d09 updated copyright notice + added files for upcoming AVL tree implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
327

mercurial