avl-tree.h

Go to the documentation of this file.

// The MIT License (MIT)
// Copyright (c) 2018 Maksim Andrianov
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to
// deal in the Software without restriction, including without limitation the
// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
// sell copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
// IN THE SOFTWARE.
#ifndef CDCONTAINERS_INCLUDE_CDCONTAINERS_avl_tree_H
#define CDCONTAINERS_INCLUDE_CDCONTAINERS_avl_tree_H

#include <cdcontainers/common.h>
#include <cdcontainers/status.h>

#include <assert.h>
#include <stdarg.h>
#include <stdbool.h>

struct cdc_avl_tree_node {
  struct cdc_avl_tree_node *parent;
  struct cdc_avl_tree_node *left;
  struct cdc_avl_tree_node *right;
  void *key;
  void *value;
  unsigned char height;
};

struct cdc_avl_tree {
  struct cdc_avl_tree_node *root;
  size_t size;
  struct cdc_data_info *dinfo;
};

struct cdc_avl_tree_iter {
  struct cdc_avl_tree *container;
  struct cdc_avl_tree_node *prev;
  struct cdc_avl_tree_node *current;
};

struct cdc_pair_avl_tree_iter {
  struct cdc_avl_tree_iter first;
  struct cdc_avl_tree_iter second;
};

struct cdc_pair_avl_tree_iter_bool {
  struct cdc_avl_tree_iter first;
  bool second;
};

// Base
enum cdc_stat cdc_avl_tree_ctor(struct cdc_avl_tree **t,
                                struct cdc_data_info *info);

enum cdc_stat cdc_avl_tree_ctorl(struct cdc_avl_tree **t,
                                 struct cdc_data_info *info, ...);

enum cdc_stat cdc_avl_tree_ctorv(struct cdc_avl_tree **t,
                                 struct cdc_data_info *info, va_list args);

void cdc_avl_tree_dtor(struct cdc_avl_tree *t);
// Lookup
enum cdc_stat cdc_avl_tree_get(struct cdc_avl_tree *t, void *key, void **value);

size_t cdc_avl_tree_count(struct cdc_avl_tree *t, void *key);

void cdc_avl_tree_find(struct cdc_avl_tree *t, void *key,
                       struct cdc_avl_tree_iter *it);
// Capacity
static inline size_t cdc_avl_tree_size(struct cdc_avl_tree *t)
{
  assert(t != NULL);

  return t->size;
}

static inline bool cdc_avl_tree_empty(struct cdc_avl_tree *t)
{
  assert(t != NULL);

  return t->size == 0;
}
// Modifiers
void cdc_avl_tree_clear(struct cdc_avl_tree *t);

enum cdc_stat cdc_avl_tree_insert(struct cdc_avl_tree *t, void *key,
                                  void *value,
                                  struct cdc_pair_avl_tree_iter_bool *ret);

enum cdc_stat cdc_avl_tree_insert1(struct cdc_avl_tree *t, void *key,
                                   void *value, struct cdc_avl_tree_iter *it,
                                   bool *inserted);

enum cdc_stat cdc_avl_tree_insert_or_assign(
    struct cdc_avl_tree *t, void *key, void *value,
    struct cdc_pair_avl_tree_iter_bool *ret);

enum cdc_stat cdc_avl_tree_insert_or_assign1(struct cdc_avl_tree *t, void *key,
                                             void *value,
                                             struct cdc_avl_tree_iter *it,
                                             bool *inserted);

size_t cdc_avl_tree_erase(struct cdc_avl_tree *t, void *key);

void cdc_avl_tree_swap(struct cdc_avl_tree *a, struct cdc_avl_tree *b);
// Iterators
void cdc_avl_tree_begin(struct cdc_avl_tree *t, struct cdc_avl_tree_iter *it);

void cdc_avl_tree_end(struct cdc_avl_tree *t, struct cdc_avl_tree_iter *it);
// Iterators
void cdc_avl_tree_iter_next(struct cdc_avl_tree_iter *it);

void cdc_avl_tree_iter_prev(struct cdc_avl_tree_iter *it);

static inline bool cdc_avl_tree_iter_has_next(struct cdc_avl_tree_iter *it)
{
  assert(it != NULL);

  return it->current != NULL;
}

static inline bool cdc_avl_tree_iter_has_prev(struct cdc_avl_tree_iter *it)
{
  assert(it != NULL);

  return it->prev != NULL;
}

static inline void *cdc_avl_tree_iter_key(struct cdc_avl_tree_iter *it)
{
  assert(it != NULL);

  return it->current->key;
}

static inline void *cdc_avl_tree_iter_value(struct cdc_avl_tree_iter *it)
{
  assert(it != NULL);

  return it->current->value;
}

static inline struct cdc_pair cdc_avl_tree_iter_key_value(
    struct cdc_avl_tree_iter *it)
{
  assert(it != NULL);

  struct cdc_pair pair = {it->prev->key, it->prev->value};
  return pair;
}

static inline bool cdc_avl_tree_iter_is_eq(struct cdc_avl_tree_iter *it1,
                                           struct cdc_avl_tree_iter *it2)
{
  assert(it1 != NULL);
  assert(it2 != NULL);

  return it1->container == it2->container && it1->prev == it2->prev &&
         it1->current == it2->current;
}
// Short names
#ifdef CDC_USE_SHORT_NAMES
typedef struct cdc_avl_tree avl_tree_t;
typedef struct cdc_avl_tree_iter avl_tree_iter_t;
typedef struct cdc_pair_avl_tree_iter pair_avl_tree_iter_t;
typedef struct cdc_pair_avl_tree_iter_bool pair_avl_tree_iter_bool_t;

// Base
#define avl_tree_ctor(...) cdc_avl_tree_ctor(__VA_ARGS__)
#define avl_tree_ctorv(...) cdc_avl_tree_ctorv(__VA_ARGS__)
#define avl_tree_ctorl(...) cdc_avl_tree_ctorl(__VA_ARGS__)
#define avl_tree_dtor(...) cdc_avl_tree_dtor(__VA_ARGS__)

// Lookup
#define avl_tree_get(...) cdc_avl_tree_get(__VA_ARGS__)
#define avl_tree_count(...) cdc_avl_tree_count(__VA_ARGS__)
#define avl_tree_find(...) cdc_avl_tree_find(__VA_ARGS__)

// Capacity
#define avl_tree_size(...) cdc_avl_tree_size(__VA_ARGS__)
#define avl_tree_empty(...) cdc_avl_tree_empty(__VA_ARGS__)

// Modifiers
#define avl_tree_clear(...) cdc_avl_tree_clear(__VA_ARGS__)
#define avl_tree_insert(...) cdc_avl_tree_insert(__VA_ARGS__)
#define avl_tree_insert1(...) cdc_avl_tree_insert1(__VA_ARGS__)
#define avl_tree_insert_or_assign(...) \
  cdc_avl_tree_insert_or_assign(__VA_ARGS__)
#define avl_tree_insert_or_assign1(...) \
  cdc_avl_tree_insert_or_assign1(__VA_ARGS__)
#define avl_tree_erase(...) cdc_avl_tree_erase(__VA_ARGS__)
#define avl_tree_swap(...) cdc_avl_tree_swap(__VA_ARGS__)

// Iterators
#define avl_tree_begin(...) cdc_avl_tree_begin(__VA_ARGS__)
#define avl_tree_end(...) cdc_avl_tree_end(__VA_ARGS__)

// Iterators
#define avl_tree_iter_next(...) cdc_avl_tree_iter_next(__VA_ARGS__)
#define avl_tree_iter_has_next(...) cdc_avl_tree_iter_has_next(__VA_ARGS__)
#define avl_tree_iter_key(...) cdc_avl_tree_iter_key(__VA_ARGS__)
#define avl_tree_iter_value(...) cdc_avl_tree_iter_value(__VA_ARGS__)
#define avl_tree_iter_key_value(...) cdc_avl_tree_iter_key_value(__VA_ARGS__)
#define avl_tree_iter_is_eq(...) cdc_avl_tree_iter_is_eq(__VA_ARGS__)
#endif

#endif  // CDCONTAINERS_INCLUDE_CDCONTAINERS_avl_tree_H