avl.h

Go to the documentation of this file.

/*
 * 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 */