btree.h

Go to the documentation of this file.

/*
  Copyright 2011-2016 David Robillard <http://drobilla.net>
 
  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.
 
  THIS 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 ZIX_BTREE_H
#define ZIX_BTREE_H
 
#include <stddef.h>
 
#include "zix/common.h"
 
#ifdef __cplusplus
extern "C" {
#else
#    include <stdbool.h>
#endif


typedef struct ZixBTreeImpl ZixBTree;

typedef struct ZixBTreeNodeImpl ZixBTreeNode;

typedef struct ZixBTreeIterImpl ZixBTreeIter;

ZIX_API ZixBTree*
zix_btree_new(ZixComparator  cmp,
              void*          cmp_data,
              ZixDestroyFunc destroy);

ZIX_API void
zix_btree_free(ZixBTree* t);

ZIX_API size_t
zix_btree_size(const ZixBTree* t);

ZIX_API ZixStatus
zix_btree_insert(ZixBTree* t, void* e);

ZIX_API ZixStatus
zix_btree_remove(ZixBTree* t, const void* e, void** out, ZixBTreeIter** next);

ZIX_API ZixStatus
zix_btree_find(const ZixBTree* t, const void* e, ZixBTreeIter** ti);

ZIX_API ZixStatus
zix_btree_lower_bound(const ZixBTree* t, const void* e, ZixBTreeIter** ti);

ZIX_API void*
zix_btree_get(const ZixBTreeIter* ti);

ZIX_API ZixBTreeIter*
zix_btree_begin(const ZixBTree* t);

ZIX_API bool
zix_btree_iter_is_end(const ZixBTreeIter* i);

ZIX_API void
zix_btree_iter_increment(ZixBTreeIter* i);

ZIX_API void
zix_btree_iter_free(ZixBTreeIter* i);

 
#ifdef __cplusplus
}  /* extern "C" */
#endif
 
#endif  /* ZIX_BTREE_H */