src/include/utils/avltree.h

   1 /*
   2  * SysDB - src/include/utils/avltree.h
   3  * Copyright (C) 2014 Sebastian 'tokkee' Harl <sh@tokkee.org>
   4  * All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   9  * 1. Redistributions of source code must retain the above copyright
  10  *    notice, this list of conditions and the following disclaimer.
  11  * 2. Redistributions in binary form must reproduce the above copyright
  12  *    notice, this list of conditions and the following disclaimer in the
  13  *    documentation and/or other materials provided with the distribution.
  14  *
  15  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  16  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  17  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  18  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR
  19  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  20  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  21  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
  22  * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  23  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
  24  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
  25  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26  */
  27
  28 #ifndef SDB_UTILS_AVLTREE_H
  29 #define SDB_UTILS_AVLTREE_H 1
  30
  31 #include "core/object.h"
  32
  33 #ifdef __cplusplus
  34 extern "C" {
  35 #endif
  36
  37 /*
  38  * An AVL tree implements Adelson-Velskii and Landis' self-balancing search
  39  * tree. It supports search, insert, and delete operations in average and
  40  * worst-case time-complexity O(log n).
  41  */
  42 struct sdb_avltree;
  43 typedef struct sdb_avltree sdb_avltree_t;
  44
  45 struct sdb_avltree_iter;
  46 typedef struct sdb_avltree_iter sdb_avltree_iter_t;
  47
  48 sdb_avltree_t *
  49 sdb_avltree_create(sdb_object_cmp_cb cmp);
  50
  51 void
  52 sdb_avltree_destroy(sdb_avltree_t *tree);
  53
  54 void
  55 sdb_avltree_clear(sdb_avltree_t *tree);
  56
  57 int
  58 sdb_avltree_insert(sdb_avltree_t *tree, sdb_object_t *obj);
  59
  60 sdb_avltree_iter_t *
  61 sdb_avltree_get_iter(sdb_avltree_t *tree);
  62
  63 void
  64 sdb_avltree_iter_destroy(sdb_avltree_iter_t *iter);
  65
  66 _Bool
  67 sdb_avltree_iter_has_next(sdb_avltree_iter_t *iter);
  68 sdb_object_t *
  69 sdb_avltree_iter_get_next(sdb_avltree_iter_t *iter);
  70
  71 size_t
  72 sdb_avltree_size(sdb_avltree_t *tree);
  73
  74 _Bool
  75 sdb_avltree_valid(sdb_avltree_t *tree);
  76
  77 #ifdef __cplusplus
  78 } /* extern "C" */
  79 #endif
  80
  81 #endif /* ! SDB_UTILS_AVLTREE_H */
  82
  83 /* vim: set tw=78 sw=4 ts=4 noexpandtab : */
  84