From: David Herrmann <dh.herrmann@gmail.com>
Date: Tue, 29 Sep 2015 10:48:14 +0000 (+0200)
Subject: prioq: add introduction comment
X-Git-Tag: v227~65^2
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=refs%2Fpull%2F1403%2Fhead;p=thirdparty%2Fsystemd.git

prioq: add introduction comment

Add comment to prioq.c explaining what it does. And more importantly,
mention that we implement a Heap. It's more than annoying having to
figure out what the code actually does, without ever mentioning the word
'heap'.
---

diff --git a/src/basic/prioq.c b/src/basic/prioq.c
index b89888be0e8..69ec45d97e0 100644
--- a/src/basic/prioq.c
+++ b/src/basic/prioq.c
@@ -19,6 +19,16 @@
   along with systemd; If not, see <http://www.gnu.org/licenses/>.
 ***/
 
+/*
+ * Priority Queue
+ * The prioq object implements a priority queue. That is, it orders objects by
+ * their priority and allows O(1) access to the object with the highest
+ * priority. Insertion and removal are Θ(log n). Optionally, the caller can
+ * provide a pointer to an index which will be kept up-to-date by the prioq.
+ *
+ * The underlying algorithm used in this implementation is a Heap.
+ */
+
 #include "util.h"
 #include "prioq.h"