gl/lib/heap.h

   1 /* Barebones heap implementation supporting only insert and pop.
   2
   3    Copyright (C) 2010-2024 Free Software Foundation, Inc.
   4
   5    This program is free software: you can redistribute it and/or modify
   6    it under the terms of the GNU General Public License as published by
   7    the Free Software Foundation; either version 3 of the License, or
   8    (at your option) any later version.
   9
  10    This program is distributed in the hope that it will be useful,
  11    but WITHOUT ANY WARRANTY; without even the implied warranty of
  12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13    GNU General Public License for more details.
  14
  15    You should have received a copy of the GNU General Public License
  16    along with this program.  If not, see <https://www.gnu.org/licenses/>.  */
  17
  18 /* Full implementation: GDSL (http://gna.org/projects/gdsl/) by Nicolas
  19    Darnis <ndarnis@free.fr>. Adapted by Gene Auyeung. */
  20
  21 #include "idx.h"
  22
  23 #include <stddef.h>
  24
  25 struct heap;
  26
  27 void heap_free (struct heap *) _GL_ATTRIBUTE_NONNULL ();
  28
  29 struct heap *heap_alloc (int (*) (void const *, void const *), idx_t)
  30   _GL_ATTRIBUTE_MALLOC _GL_ATTRIBUTE_DEALLOC (heap_free, 1)
  31   _GL_ATTRIBUTE_RETURNS_NONNULL;
  32
  33 int heap_insert (struct heap *heap, void *item) _GL_ATTRIBUTE_NONNULL ();
  34 void *heap_remove_top (struct heap *heap) _GL_ATTRIBUTE_NONNULL ();