skip_list.h

Go to the documentation of this file.

/* Copyright (C) 2022 The University of Notre Dame
This software is distributed under the GNU General Public License.
See the file COPYING for details.
*/
 
#ifndef SKIP_LIST_H
#define SKIP_LIST_H
 
#include <stdint.h>
#include <stdbool.h>
 
struct skip_list;
struct skip_list_cursor;
 
struct skip_list *skip_list_create(unsigned priority_size, double probability);
 
bool skip_list_delete(struct skip_list *sl);
 
int skip_list_size(struct skip_list *sl);
 
const double *skip_list_peek_head_priority(struct skip_list *sl);
 
const void *skip_list_peek_head(struct skip_list *sl);
 
void *skip_list_pop_head(struct skip_list *sl);
 
struct skip_list_cursor *skip_list_cursor_create(struct skip_list *sl);
 
void skip_list_cursor_delete(struct skip_list_cursor *cur);
 
struct skip_list_cursor *skip_list_cursor_clone(struct skip_list_cursor *cur);
 
void skip_list_cursor_move(struct skip_list_cursor *to_move, struct skip_list_cursor *destination);
 
void skip_list_reset(struct skip_list_cursor *cur);
 
bool skip_list_seek(struct skip_list_cursor *cur, int index);
 
bool skip_list_tell(struct skip_list_cursor *cur, unsigned *index);
 
bool skip_list_next(struct skip_list_cursor *cur);
 
bool skip_list_prev(struct skip_list_cursor *cur);
 
bool skip_list_cursor_move_to_priority_arr(struct skip_list_cursor *cur, double *priority);
 
#define skip_list_cursor_move_to_priority(cur, ...) \
        skip_list_cursor_move_to_priority_arr(cur, (double[]){__VA_ARGS__})
 
bool skip_list_get(struct skip_list_cursor *cur, void **item);
 
const double *skip_list_get_priority(struct skip_list_cursor *cur);
 
bool skip_list_set(struct skip_list_cursor *cur, void *item);
 
bool skip_list_remove_here(struct skip_list_cursor *cur);
 
bool skip_list_remove(struct skip_list *sl, void *data);
 
bool skip_list_remove_by_priority_arr(struct skip_list *sl, double *priority);
 
#define skip_list_remove_by_priority(sl, ...) \
        skip_list_remove_by_priority_arr(sl, (double[]){__VA_ARGS__})
 
void skip_list_insert_arr(struct skip_list *lst, void *item, double *priority);
 
#define skip_list_insert(lst, item, ...) \
        skip_list_insert_arr(lst, item, (double[]){__VA_ARGS__})
 
 
#define SKIP_LIST_ITERATE(cursor, item) \
        for(; skip_list_get(cursor, (void **)&item); skip_list_next(cursor))
 
#endif