avl-tree.h

Go to the documentation of this file.

/*
 
Copyright (c) 2005-2008, Simon Howard
 
Permission to use, copy, modify, and/or distribute this software 
for any purpose with or without fee is hereby granted, provided 
that the above copyright notice and this permission notice appear 
in all copies. 
 
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL 
WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED 
WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE 
AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR 
CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM 
LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, 
NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN      
CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. 
 
 */
 
#ifndef ALGORITHM_AVLTREE_H
#define ALGORITHM_AVLTREE_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef struct _AVLTree AVLTree;
 
typedef void *AVLTreeKey;
 
typedef void *AVLTreeValue;
 
#define AVL_TREE_NULL ((void *) 0)
 
typedef struct _AVLTreeNode AVLTreeNode;
 
typedef enum {
    AVL_TREE_NODE_LEFT = 0,
    AVL_TREE_NODE_RIGHT = 1
} AVLTreeNodeSide;
 
typedef int (*AVLTreeCompareFunc)(AVLTreeValue value1, AVLTreeValue value2);
 
AVLTree *avl_tree_new(AVLTreeCompareFunc compare_func);
 
void avl_tree_free(AVLTree *tree);
 
AVLTreeNode *avl_tree_insert(AVLTree *tree, AVLTreeKey key, AVLTreeValue value);
 
void avl_tree_remove_node(AVLTree *tree, AVLTreeNode *node);
 
int avl_tree_remove(AVLTree *tree, AVLTreeKey key);
 
AVLTreeNode *avl_tree_lookup_node(AVLTree *tree, AVLTreeKey key);
 
AVLTreeValue avl_tree_lookup(AVLTree *tree, AVLTreeKey key);
 
AVLTreeNode *avl_tree_root_node(AVLTree *tree);
 
AVLTreeKey avl_tree_node_key(AVLTreeNode *node);
 
AVLTreeValue avl_tree_node_value(AVLTreeNode *node);
 
AVLTreeNode *avl_tree_node_child(AVLTreeNode *node, AVLTreeNodeSide side);
 
AVLTreeNode *avl_tree_node_parent(AVLTreeNode *node);
 
int avl_tree_subtree_height(AVLTreeNode *node);
 
AVLTreeValue *avl_tree_to_array(AVLTree *tree);
 
int avl_tree_num_entries(AVLTree *tree);
 
#ifdef __cplusplus
}
#endif
 
#endif /* #ifndef ALGORITHM_AVLTREE_H */