docs/api-2.1/avl_8h_source.html

 /*
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
  *
  * Copyright 2017 Mike Becker, Olaf Wintermann All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions are met:
  *
  *   1. Redistributions of source code must retain the above copyright
  *      notice, this list of conditions and the following disclaimer.
  *
  *   2. Redistributions in binary form must reproduce the above copyright
  *      notice, this list of conditions and the following disclaimer in the
  *      documentation and/or other materials provided with the distribution.
  *
  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  * POSSIBILITY OF SUCH DAMAGE.
  */


 #ifndef UCX_AVL_H
 #define UCX_AVL_H

 #include "ucx.h"
 #include "allocator.h"
 #include <inttypes.h>

 #ifdef  __cplusplus
 extern "C" {
 #endif

 typedef struct UcxAVLNode UcxAVLNode;

 struct UcxAVLNode {
     intptr_t key;
     void *value;
     size_t height;
     UcxAVLNode *parent;
     UcxAVLNode *left;
     UcxAVLNode *right;
 };

 typedef struct {
     UcxAllocator *allocator;
     UcxAVLNode *root;
     cmp_func cmpfunc;
     void *userdata;
 } UcxAVLTree;

 UcxAVLTree *ucx_avl_new(cmp_func cmpfunc);

 UcxAVLTree *ucx_avl_new_a(cmp_func cmpfunc, UcxAllocator *allocator);

 void ucx_avl_free(UcxAVLTree *tree);

 void ucx_avl_free_content(UcxAVLTree *tree, ucx_destructor destr);

 #define ucx_avl_default_new() \
     ucx_avl_new_a(ucx_cmp_ptr, ucx_default_allocator())

 UcxAVLNode *ucx_avl_get_node(UcxAVLTree *tree, intptr_t key);

 void *ucx_avl_get(UcxAVLTree *tree, intptr_t key);

 #define UCX_AVL_FIND_EXACT         0

 #define UCX_AVL_FIND_LOWER_BOUNDED 1

 #define UCX_AVL_FIND_UPPER_BOUNDED 2

 #define UCX_AVL_FIND_CLOSEST       3

 UcxAVLNode *ucx_avl_find_node(UcxAVLTree *tree, intptr_t key,
         distance_func dfnc, int mode);

 void *ucx_avl_find(UcxAVLTree *tree, intptr_t key,
         distance_func dfnc, int mode);

 int ucx_avl_put(UcxAVLTree *tree, intptr_t key, void *value);

 int ucx_avl_put_s(UcxAVLTree *tree, intptr_t key, void *value, void **oldvalue);

 int ucx_avl_remove_node(UcxAVLTree *tree, UcxAVLNode *node);

 int ucx_avl_remove(UcxAVLTree *tree, intptr_t key);

 int ucx_avl_remove_s(UcxAVLTree *tree, intptr_t key,
         intptr_t *oldkey, void **oldvalue);

 size_t ucx_avl_count(UcxAVLTree *tree);

 UcxAVLNode* ucx_avl_pred(UcxAVLNode* node);

 UcxAVLNode* ucx_avl_succ(UcxAVLNode* node);

 #ifdef  __cplusplus
 }
 #endif

 #endif  /* UCX_AVL_H */

ucx_avl_new
UcxAVLTree * ucx_avl_new(cmp_func cmpfunc)
Initializes a new UcxAVLTree with a default allocator.
Definition: avl.c:109

+ucx_avl_remove
int ucx_avl_remove(UcxAVLTree *tree, intptr_t key)
Removes an element from the AVL tree.
Definition: avl.c:266

+UcxAVLNode
UCX AVL Node.
Definition: avl.h:63

+cmp_func
int(* cmp_func)(const void *, const void *, void *)
Function pointer to a compare function.
Definition: ucx.h:84

+UcxAVLNode::parent
UcxAVLNode * parent
Parent node.
Definition: avl.h:79

+ucx_avl_pred
UcxAVLNode * ucx_avl_pred(UcxAVLNode *node)
Finds the in-order predecessor of the given node.
Definition: avl.c:335

+ucx_avl_put
int ucx_avl_put(UcxAVLTree *tree, intptr_t key, void *value)
Puts a key/value pair into the tree.
Definition: avl.c:211

+ucx.h
Main UCX Header providing most common definitions.

+UcxAVLTree
UCX AVL Tree.
Definition: avl.h:93

+ucx_avl_count
size_t ucx_avl_count(UcxAVLTree *tree)
Counts the nodes in the specified UcxAVLTree.
Definition: avl.c:331

+ucx_avl_new_a
UcxAVLTree * ucx_avl_new_a(cmp_func cmpfunc, UcxAllocator *allocator)
Initializes a new UcxAVLTree with the specified allocator.
Definition: avl.c:113

+UcxAVLTree::userdata
void * userdata
Custom user data.
Definition: avl.h:111

+ucx_avl_remove_node
int ucx_avl_remove_node(UcxAVLTree *tree, UcxAVLNode *node)
Removes a node from the AVL tree.
Definition: avl.c:270

+UcxAVLTree::cmpfunc
cmp_func cmpfunc
Compare function that shall be used to compare the UcxAVLNode keys.
Definition: avl.h:106

+ucx_avl_succ
UcxAVLNode * ucx_avl_succ(UcxAVLNode *node)
Finds the in-order successor of the given node.
Definition: avl.c:355

+ucx_avl_free_content
void ucx_avl_free_content(UcxAVLTree *tree, ucx_destructor destr)
Frees the contents of a UcxAVLTree.
Definition: avl.c:152

+UcxAVLTree::allocator
UcxAllocator * allocator
The UcxAllocator that shall be used to manage the memory for node data.
Definition: avl.h:97

+ucx_avl_remove_s
int ucx_avl_remove_s(UcxAVLTree *tree, intptr_t key, intptr_t *oldkey, void **oldvalue)
Removes an element from the AVL tree.
Definition: avl.c:274

+ucx_avl_find
void * ucx_avl_find(UcxAVLTree *tree, intptr_t key, distance_func dfnc, int mode)
Finds a value within the tree.
Definition: avl.c:205

+UcxAllocator
UCX allocator data structure containing memory management functions.
Definition: allocator.h:88

+ucx_avl_put_s
int ucx_avl_put_s(UcxAVLTree *tree, intptr_t key, void *value, void **oldvalue)
Puts a key/value pair into the tree.
Definition: avl.c:215

+UcxAVLTree::root
UcxAVLNode * root
Root node of the tree.
Definition: avl.h:101

+distance_func
intmax_t(* distance_func)(const void *, const void *, void *)
Function pointer to a distance function.
Definition: ucx.h:93

+allocator.h
Allocator for custom memory management.

+ucx_avl_get
void * ucx_avl_get(UcxAVLTree *tree, intptr_t key)
Gets the value from the tree, that is associated with the specified key.
Definition: avl.c:166

+UcxAVLNode::left
UcxAVLNode * left
Root node of left subtree.
Definition: avl.h:83

+ucx_avl_free
void ucx_avl_free(UcxAVLTree *tree)
Destroys a UcxAVLTree.
Definition: avl.c:133

+UcxAVLNode::value
void * value
Data contained by this node.
Definition: avl.h:71

+ucx_avl_find_node
UcxAVLNode * ucx_avl_find_node(UcxAVLTree *tree, intptr_t key, distance_func dfnc, int mode)
Finds a node within the tree.
Definition: avl.c:171

+UcxAVLNode::key
intptr_t key
The key for this node.
Definition: avl.h:67

+UcxAVLNode::right
UcxAVLNode * right
Root node of right subtree.
Definition: avl.h:87

+ucx_avl_get_node
UcxAVLNode * ucx_avl_get_node(UcxAVLTree *tree, intptr_t key)
Gets the node from the tree, that is associated with the specified key.
Definition: avl.c:156

+UcxAVLNode::height
size_t height
The height of this (sub)-tree.
Definition: avl.h:75

+ucx_destructor
void(* ucx_destructor)(void *)
A function pointer to a destructor function.
Definition: ucx.h:72

+