346 lines
23 KiB
C
346 lines
23 KiB
C
/*
|
|
* M*LIB - dynamic priority queue module
|
|
*
|
|
* Copyright (c) 2017-2018, Patrick Pelissier
|
|
* All rights reserved.
|
|
* Redistribution and use in source and binary forms, with or without
|
|
* modification, are permitted provided that the following conditions are met:
|
|
* + Redistributions of source code must retain the above copyright
|
|
* notice, this list of conditions and the following disclaimer.
|
|
* + 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 REGENTS 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 REGENTS AND 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.
|
|
*/
|
|
#ifndef MSTARLIB_PRIOQUEUE_H
|
|
#define MSTARLIB_PRIOQUEUE_H
|
|
|
|
#include "m-core.h"
|
|
#include "m-array.h"
|
|
|
|
/* Priority queue based on binary heap implementation */
|
|
|
|
/* Define a prioqueue of a given type and its associated functions.
|
|
USAGE: PRIOQUEUE_DEF(name, type [, oplist_of_the_type]) */
|
|
#define PRIOQUEUE_DEF(name, ...) \
|
|
PRIOQUEUEI_DEF(M_IF_NARGS_EQ1(__VA_ARGS__) \
|
|
((name, __VA_ARGS__, M_GLOBAL_OPLIST_OR_DEF(__VA_ARGS__), M_C(name,_t), M_C(name,_it_t) ), \
|
|
(name, __VA_ARGS__, M_C(name,_t), M_C(name,_it_t))))
|
|
|
|
/* Define the oplist of a prioqueue of type.
|
|
USAGE: PRIOQUEUE_OPLIST(name[, oplist of the type]) */
|
|
#define PRIOQUEUE_OPLIST(...) \
|
|
PRIOQUEUEI_OPLIST(M_IF_NARGS_EQ1(__VA_ARGS__) \
|
|
((__VA_ARGS__, M_GLOBAL_OPLIST_OR_DEF(__VA_ARGS__) ), \
|
|
(__VA_ARGS__ )))
|
|
|
|
|
|
/********************************** INTERNAL ************************************/
|
|
|
|
#define PRIOQUEUEI_OPLIST(arg) PRIOQUEUEI_OPLIST2 arg
|
|
#define PRIOQUEUEI_DEF(arg) PRIOQUEUEI_DEF2 arg
|
|
|
|
#define PRIOQUEUEI_OPLIST2(name, oplist) \
|
|
(INIT(M_C(name, _init)) \
|
|
,INIT_SET(M_C(name, _init_set)) \
|
|
,INIT_WITH(API_1(M_INIT_VAI)) \
|
|
,SET(M_C(name, _set)) \
|
|
,CLEAR(M_C(name, _clear)) \
|
|
,INIT_MOVE(M_C(name, _init_move)) \
|
|
,MOVE(M_C(name, _move)) \
|
|
,SWAP(M_C(name, _swap)) \
|
|
,TYPE(M_C(name,_t)) \
|
|
,SUBTYPE(M_C(name, _type_t)) \
|
|
,CLEAN(M_C(name,_clean)) \
|
|
,PUSH(M_C(name,_push)) \
|
|
,POP(M_C(name,_pop)) \
|
|
,OPLIST(oplist) \
|
|
)
|
|
|
|
#define PRIOQUEUEI_DEF2(name, type, oplist, prioqueue_t, it_t) \
|
|
ARRAY_DEF(M_C(name, _array), type, oplist) \
|
|
\
|
|
typedef type M_C(name, _type_t); \
|
|
\
|
|
typedef struct M_C(name, _s) { \
|
|
M_C(name, _array_t) array; \
|
|
} prioqueue_t[1]; \
|
|
typedef struct M_C(name, _s) *M_C(name, _ptr); \
|
|
typedef const struct M_C(name, _s) *M_C(name, _srcptr); \
|
|
\
|
|
typedef M_C(name, _array_it_t) it_t; \
|
|
\
|
|
static inline void \
|
|
M_C(name, _init)(prioqueue_t p) \
|
|
{ \
|
|
M_C(name, _array_init)(p->array); \
|
|
} \
|
|
\
|
|
static inline void \
|
|
M_C(name, _init_set)(prioqueue_t p, prioqueue_t o) \
|
|
{ \
|
|
M_C(name, _array_init_set)(p->array, o->array); \
|
|
} \
|
|
\
|
|
static inline void \
|
|
M_C(name, _set)(prioqueue_t p, prioqueue_t o) \
|
|
{ \
|
|
M_C(name, _array_set)(p->array, o->array); \
|
|
} \
|
|
\
|
|
static inline void \
|
|
M_C(name, _clear)(prioqueue_t p) \
|
|
{ \
|
|
M_C(name, _array_clear)(p->array); \
|
|
} \
|
|
\
|
|
static inline void \
|
|
M_C(name, _init_move)(prioqueue_t p, prioqueue_t o) \
|
|
{ \
|
|
M_C(name, _array_init_move)(p->array, o->array); \
|
|
} \
|
|
\
|
|
static inline void \
|
|
M_C(name, _move)(prioqueue_t p, prioqueue_t o) \
|
|
{ \
|
|
M_C(name, _array_move)(p->array, o->array); \
|
|
} \
|
|
\
|
|
static inline void \
|
|
M_C(name, _swap)(prioqueue_t p, prioqueue_t o) \
|
|
{ \
|
|
M_C(name, _array_swap)(p->array, o->array); \
|
|
} \
|
|
\
|
|
static inline void \
|
|
M_C(name, _clean)(prioqueue_t p) \
|
|
{ \
|
|
M_C(name, _array_clean)(p->array); \
|
|
} \
|
|
\
|
|
static inline size_t \
|
|
M_C(name, _i_parent)(size_t i) \
|
|
{ \
|
|
assert (i > 0); \
|
|
return (i - 1) / 2; \
|
|
} \
|
|
\
|
|
static inline size_t \
|
|
M_C(name, _i_lchild)(size_t i) \
|
|
{ \
|
|
assert(i <= ((-(size_t)1)-2)/2); \
|
|
return 2*i + 1; \
|
|
} \
|
|
\
|
|
static inline size_t \
|
|
M_C(name, _i_rchild)(size_t i) \
|
|
{ \
|
|
assert(i <= ((-(size_t)1)-2)/2); \
|
|
return 2*i + 2; \
|
|
} \
|
|
\
|
|
static inline int \
|
|
M_C(name, _i_cmp)(const prioqueue_t p, size_t i, size_t j) \
|
|
{ \
|
|
return M_CALL_CMP(oplist, *M_C(name, _array_cget)(p->array, i), \
|
|
*M_C(name, _array_cget)(p->array, j)); \
|
|
} \
|
|
\
|
|
static inline bool \
|
|
M_C(name, _empty_p)(const prioqueue_t p) \
|
|
{ \
|
|
return M_C(name, _array_empty_p)(p->array); \
|
|
} \
|
|
\
|
|
static inline size_t \
|
|
M_C(name, _size)(const prioqueue_t p) \
|
|
{ \
|
|
return M_C(name, _array_size)(p->array); \
|
|
} \
|
|
\
|
|
static inline void \
|
|
M_C(name, _push)(prioqueue_t p, type const x) \
|
|
{ \
|
|
M_C(name, _array_push_back)(p->array, x); \
|
|
\
|
|
size_t i = M_C(name, _array_size)(p->array)-1; \
|
|
while (i > 0) { \
|
|
size_t j = M_C(name, _i_parent)(i); \
|
|
if (M_C(name, _i_cmp)(p, j, i) <= 0) \
|
|
break; \
|
|
M_C(name, _array_swap_at) (p->array, i, j); \
|
|
i = j; \
|
|
} \
|
|
} \
|
|
\
|
|
static inline type const * \
|
|
M_C(name, _front)(prioqueue_t p) \
|
|
{ \
|
|
return M_C(name, _array_cget)(p->array, 0); \
|
|
} \
|
|
\
|
|
static inline void \
|
|
M_C(name, _pop)(type *x, prioqueue_t p) \
|
|
{ \
|
|
size_t size = M_C(name, _array_size)(p->array)-1; \
|
|
M_C(name, _array_swap_at) (p->array, 0, size); \
|
|
M_C(name, _array_pop_back)(x, p->array); \
|
|
\
|
|
size_t i = 0; \
|
|
while (true) { \
|
|
size_t child = M_C(name, _i_lchild)(i); \
|
|
if (child >= size) break; \
|
|
size_t otherChild = M_C(name, _i_rchild)(i); \
|
|
if (otherChild < size \
|
|
&& M_C(name, _i_cmp)(p, otherChild, child) < 0 ) { \
|
|
child = otherChild; \
|
|
} \
|
|
if (M_C(name, _i_cmp)(p, i, child) <= 0) break; \
|
|
M_C(name, _array_swap_at) (p->array, i, child); \
|
|
i = child; \
|
|
} \
|
|
} \
|
|
\
|
|
static inline void \
|
|
M_C(name, _it)(it_t it, const prioqueue_t v) \
|
|
{ \
|
|
M_C(name, _array_it)(it, v->array); \
|
|
} \
|
|
\
|
|
static inline void \
|
|
M_C(name, _it_last)(it_t it, const prioqueue_t v) \
|
|
{ \
|
|
M_C(name, _array_it_last)(it, v->array); \
|
|
} \
|
|
\
|
|
static inline void \
|
|
M_C(name, _it_end)(it_t it, const prioqueue_t v) \
|
|
{ \
|
|
M_C(name, _array_it_end)(it, v->array); \
|
|
} \
|
|
\
|
|
static inline void \
|
|
M_C(name, _it_set)(it_t it, const it_t org) \
|
|
{ \
|
|
M_C(name, _array_it_set)(it, org); \
|
|
} \
|
|
\
|
|
static inline bool \
|
|
M_C(name, _end_p)(const it_t it) \
|
|
{ \
|
|
return M_C(name, _array_end_p)(it); \
|
|
} \
|
|
\
|
|
static inline bool \
|
|
M_C(name, _last_p)(const it_t it) \
|
|
{ \
|
|
return M_C(name, _array_last_p)(it); \
|
|
} \
|
|
\
|
|
static inline bool \
|
|
M_C(name, _it_equal_p)(const it_t it1, \
|
|
const it_t it2) \
|
|
{ \
|
|
return M_C(name, _array_it_equal_p)(it1, it2); \
|
|
} \
|
|
\
|
|
static inline void \
|
|
M_C(name, _next)(it_t it) \
|
|
{ \
|
|
M_C(name, _array_next)(it); \
|
|
} \
|
|
\
|
|
static inline void \
|
|
M_C(name, _previous)(it_t it) \
|
|
{ \
|
|
M_C(name, _array_previous)(it); \
|
|
} \
|
|
\
|
|
static inline type const * \
|
|
M_C(name, _cref)(const it_t it) \
|
|
{ \
|
|
return M_C(name, _array_cref)(it); \
|
|
} \
|
|
\
|
|
M_IF_METHOD(EQUAL, oplist) \
|
|
( \
|
|
/* EQUAL & CMP may be uncorrelated */ \
|
|
static inline void \
|
|
M_C(name, _erase)(prioqueue_t p, type x) \
|
|
{ \
|
|
/* First pass: search for an item EQUAL to x */ \
|
|
size_t size = M_C(name, _array_size)(p->array); \
|
|
size_t i = 0; \
|
|
for(i = 0; i < size; i++) { \
|
|
if (M_CALL_EQUAL(oplist, *M_C(name, _array_cget)(p->array, i), x)) \
|
|
break; \
|
|
} \
|
|
/* If x is not found, then stop */ \
|
|
if (i >= size) \
|
|
return; \
|
|
/* Swap the found item and the last element */ \
|
|
size--; \
|
|
M_C(name, _array_swap_at) (p->array, i, size); \
|
|
M_C(name, _array_pop_back)(NULL, p->array); \
|
|
/* Move back the last swapped element to its right position in the heap */ \
|
|
while (true) { \
|
|
size_t child = M_C(name, _i_lchild)(i); \
|
|
if (child >= size) break; \
|
|
size_t otherChild = M_C(name, _i_rchild)(i); \
|
|
if (otherChild < size \
|
|
&& M_C(name, _i_cmp)(p, otherChild, child) < 0 ) { \
|
|
child = otherChild; \
|
|
} \
|
|
if (M_C(name, _i_cmp)(p, i, child) <= 0) break; \
|
|
M_C(name, _array_swap_at) (p->array, i, child); \
|
|
i = child; \
|
|
} \
|
|
} \
|
|
\
|
|
static inline void \
|
|
M_C(name, _update_further)(prioqueue_t p, type xold, type xnew) \
|
|
{ \
|
|
/* This update assumes that the new position is further in the heap */ \
|
|
assert (M_CALL_CMP(oplist, xold, xnew) > 0); \
|
|
/* First pass: search for an item EQUAL to x */ \
|
|
size_t size = M_C(name, _array_size)(p->array); \
|
|
size_t i = 0; \
|
|
for(i = 0; i < size; i++) { \
|
|
if (M_CALL_EQUAL(oplist, *M_C(name, _array_cget)(p->array, i), xold)) \
|
|
break; \
|
|
} \
|
|
/* We shall have found the item */ \
|
|
assert (i < size); \
|
|
/* Set the found item to the new element */ \
|
|
M_C(name, _array_set_at) (p->array, i, xnew); \
|
|
/* Move back the updated element to its right position in the heap */ \
|
|
while (true) { \
|
|
size_t child = M_C(name, _i_lchild)(i); \
|
|
if (child >= size) break; \
|
|
size_t otherChild = M_C(name, _i_rchild)(i); \
|
|
if (otherChild < size \
|
|
&& M_C(name, _i_cmp)(p, otherChild, child) < 0 ) { \
|
|
child = otherChild; \
|
|
} \
|
|
if (M_C(name, _i_cmp)(p, i, child) <= 0) break; \
|
|
M_C(name, _array_swap_at) (p->array, i, child); \
|
|
i = child; \
|
|
} \
|
|
} \
|
|
\
|
|
, /* No EQUAL */ \) \
|
|
|
|
|
|
|
|
#endif
|