ucx: ucx/avl.h@fb05d315a0ba (annotated)

ucx/avl.h@fb05d315a0ba (annotated)

ucx/avl.h

Sun, 17 May 2015 17:59:07 +0200

author: Mike Becker <universe@uap-core.de>
date: Sun, 17 May 2015 17:59:07 +0200
changeset 193: fb05d315a0ba
parent 192: 1e51558b9d09
child 194: 0c1b7676e74c
permissions: -rw-r--r--

defined AVL tree functional interface

 /*
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
  *
  * Copyright 2015 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.
  */
 /**
  * @file avl.h
  *
  * AVL tree implementation.
  *
  * This binary search tree implementation allows average O(1) insertion and
  * removal of elements.
  *
  * @author Mike Becker
  * @author Olaf Wintermann
  */
 #ifndef UCX_AVL_H
 #define	UCX_AVL_H
 #include "ucx.h"
 #ifdef	__cplusplus
 extern "C" {
 #endif
 /**
  * UCX AVL Node type.
  *
  * @see UcxAVLNode
  */
 typedef struct UcxAVLNode UcxAVLNode;
 /**
  * UCX AVL Node.
  */
 struct UcxAVLNode {
     /**
      * The key for this node.
      */
     void *key;
     /**
      * Data contained by this node.
      */
     void *value;
     /**
      * The height of this (sub)-tree.
      */
     size_t height;
     /**
      * Parent node.
      */
     UcxAVLNode *parent;
     /**
      * Root node of left subtree.
      */
     UcxAVLNode *left;
     /**
      * Root node of right subtree.
      */
     UcxAVLNode *right;
 };
 /**
  * UCX AVL Tree.
  */
 typedef struct {
     /**
      * Root node of the tree.
      */
     UcxAVLNode *root;
     /**
      * Compare function that shall be used to compare the UcxAVLNode keys.
      * @see UcxAVLNode.key
      */
     cmp_func cmpfunc;
     /**
      * Custom user data.
      * This data will also be provided to the cmpfunc.
      */
     void *userdata;
 } UcxAVLTree;
 /**
  * Gets the value from the tree, that is associated with the specified key.
  * @param tree the UcxAVLTree
  * @param key the key
  * @return the value (or <code>NULL</code>, if the key is not present)
  */
 void *ucx_avl_get(UcxAVLTree *tree, void *key);
 /**
  * Puts a key/value pair into the tree.
  * @param tree the UcxAVLTree
  * @param key the key
  * @param value the new value
  * @return the replaced value (or <code>NULL</code>, if the key is new to the
  * tree)
  */
 void* ucx_avl_put(UcxAVLTree *tree, void *key, void *value);
 /**
  * Removes an element from the AVL tree.
  * @param tree the UcxAVLTree
  * @param key the key
  * @return the removed value (or <code>NULL</code>, if the key was not present)
  */
 void* ucx_avl_remove(UcxAVLTree *tree, void *key);
 #ifdef	__cplusplus
 }
 #endif
 #endif	/* UCX_AVL_H */

Mercurial > hg > ucx / annotate

ucx/avl.h@fb05d315a0ba (annotated)

ucx/avl.h