X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~mdw/git/disorder/blobdiff_plain/033fd4e36c4cceab309b15253194999ab8dddfa2..287ad384814351a195696f91e83388c12b265f90:/lib/heap.h

diff --git a/lib/heap.h b/lib/heap.h
index 4603942..b5a8930 100644
--- a/lib/heap.h
+++ b/lib/heap.h
@@ -1,27 +1,27 @@
 /*
  * This file is part of DisOrder.
- * Copyright (C) 2007 Richard Kettlewell
+ * Copyright (C) 2007, 2008 Richard Kettlewell
  *
- * This program is free software; you can redistribute it and/or modify
+ * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2 of the License, or
+ * the Free Software Foundation, either version 3 of the License, or
  * (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful, but
- * WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
- * General Public License for more details.
- *
+ * 
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ * 
  * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
- * USA
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 /** @file lib/heap.h @brief Binary heap template */
 
 #ifndef HEAP_H
 #define HEAP_H
 
+#include "vector.h"
+
 /** @brief Binary heap template.
  * @param NAME name of type to define
  * @param ETYPE element type
@@ -76,20 +76,27 @@
  * \f$N\f$ and \f$A\f$ are exchanged, so now \f$A\f$ has children \f$N\f$ and
  * \f$B\f$.  \f$A < N\f$ and \f$A \le B\f$.
  */
-#define HEAP_TYPE(NAME, ETYPE, LT)                              \
-  typedef ETYPE NAME##_element;                                 \
-  VECTOR_TYPE(NAME, NAME##_element, xrealloc)                   \
-                                                                \
-  static inline int NAME##_count(struct NAME *heap) {                  \
-    return heap->nvec;                                          \
-  }                                                             \
-                                                                \
-  static inline NAME##_element NAME##_first(struct NAME *heap) {       \
-    assert(heap->nvec > 0);                                     \
-    return heap->vec[0];                                        \
-  }                                                             \
-                                                                \
-  static void NAME##_insert(struct NAME *heap, NAME##_element elt) {   \
+#define HEAP_TYPE(NAME, ETYPE, LT)                                      \
+  typedef ETYPE NAME##_element;                                         \
+  VECTOR_TYPE(NAME, NAME##_element, xrealloc);                          \
+                                                                        \
+  static inline int NAME##_count(struct NAME *heap) {                   \
+    return heap->nvec;                                                  \
+  }                                                                     \
+                                                                        \
+  static inline NAME##_element NAME##_first(struct NAME *heap) {        \
+    assert(heap->nvec > 0 && "_first");                                 \
+    return heap->vec[0];                                                \
+  }                                                                     \
+                                                                        \
+  void NAME##_insert(struct NAME *heap, NAME##_element elt);            \
+  NAME##_element NAME##_remove(struct NAME *heap);                      \
+                                                                        \
+  struct heap_swallow_semicolon
+
+/** @brief External-linkage definitions for @ref HEAP_TYPE */
+#define HEAP_DEFINE(NAME, ETYPE, LT)                            \
+  void NAME##_insert(struct NAME *heap, NAME##_element elt) {   \
     int n = heap->nvec;                                         \
     NAME##_append(heap, elt);                                   \
     while(n > 0) {                                              \
@@ -97,7 +104,7 @@
       if(!LT(heap->vec[n],heap->vec[p]))                        \
         break;                                                  \
       else {                                                    \
-        const NAME##_element t = heap->vec[n];                    \
+        const NAME##_element t = heap->vec[n];                  \
         heap->vec[n] = heap->vec[p];                            \
         heap->vec[p] = t;                                       \
         n = p;                                                  \
@@ -105,11 +112,11 @@
     }                                                           \
   }                                                             \
                                                                 \
-  static NAME##_element NAME##_remove(struct NAME *heap) {             \
+  NAME##_element NAME##_remove(struct NAME *heap) {             \
     int n = 0;                                                  \
     NAME##_element r;                                           \
                                                                 \
-    assert(heap->nvec > 0);                                     \
+    assert(heap->nvec > 0 && "_remove");                        \
     r = heap->vec[0];                                           \
     heap->vec[0] = heap->vec[--heap->nvec];                     \
     while(2 * n + 1 < heap->nvec) {                             \
@@ -125,13 +132,13 @@
         heap->vec[n] = heap->vec[a];                            \
         heap->vec[a] = t;                                       \
         n = a;                                                  \
-      } else \
+      } else                                                    \
         break;                                                  \
     }                                                           \
     return r;                                                   \
   }                                                             \
                                                                 \
-  struct heap_swallow_semicolon
+  struct heap_swallow_semicolon                                 \
   
 
 #endif /* PQUEUE_H */