aboutsummaryrefslogtreecommitdiff
path: root/collections/double_ended_queue.adoc
diff options
context:
space:
mode:
authorTucker Evans <tucker@tuckerevans.com>2020-06-11 14:42:06 -0400
committerTucker Evans <tucker@tuckerevans.com>2020-06-11 15:00:14 -0400
commit349c75c16a3713ee6f3ffd701f1c88ce31ecd8de (patch)
treed6aaeba8d124b4e9d760cc65ed2c94467035f831 /collections/double_ended_queue.adoc
parent277e14127bbe1a5080a2a88b6ee3ef94859bc3a5 (diff)
Add reserve function for double ended queue.
Diffstat (limited to 'collections/double_ended_queue.adoc')
-rw-r--r--collections/double_ended_queue.adoc19
1 files changed, 18 insertions, 1 deletions
diff --git a/collections/double_ended_queue.adoc b/collections/double_ended_queue.adoc
index 70cbbaf..9ecf9cb 100644
--- a/collections/double_ended_queue.adoc
+++ b/collections/double_ended_queue.adoc
@@ -1,7 +1,7 @@
Double Ended Queue
==================
Tucker Evans
-v0.2, 2020-06-10
+v0.3, 2020-06-10
A double ended queue implemented in a circular buffer.
@@ -440,6 +440,23 @@ deq_truncate(queue, 1);
assert(deq_size == 1);
----
++void deq_reserve(deq *self, int additional)+
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Reserves space for +additional+ items. May reserve more memory to avoid too
+many reallocations.
+
+Examples
+^^^^^^^^
+[source,c]
+----
+#include "double_ended_queue.h"
+
+deq *queue = deq_with_capacity(16);
+
+deq_reserve(queue, 20);
+assert(deq_capacity(queue) >= 20);
+----
+
+void deq_remove(deq *self, int index)+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Element at position +index+ of +self+ is removed from queue and the remaining