From a1d4279c40612e6f98564db43192929b41c59d40 Mon Sep 17 00:00:00 2001
From: Tucker Evans <tucker@tuckerevans.com>
Date: Fri, 3 Jul 2020 23:57:45 -0400
Subject: Add remove function for vectors

Removes element at an index.
---
 collections/vector/vector.adoc | 31 ++++++++++++++++++++++++++++++-
 1 file changed, 30 insertions(+), 1 deletion(-)

(limited to 'collections/vector/vector.adoc')

diff --git a/collections/vector/vector.adoc b/collections/vector/vector.adoc
index 9e61a43..d423c37 100644
--- a/collections/vector/vector.adoc
+++ b/collections/vector/vector.adoc
@@ -1,7 +1,7 @@
 Vector
 ======
 Tucker Evans
-v0.13, 2020-07-03
+v0.14, 2020-07-03
 
 A basic vector, that hold pointers to your data structures.
 
@@ -284,6 +284,35 @@ assert(str_cmp(vec_index(vector, 1), str3) == 0);
 assert(str_cmp(vec_index(vector, 2), str2) == 0);
 ----
 
+[[vec_remove]]
++void vec_remove(vec *self, int index)+
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Element at position +index+ of +self+ is removed from vector and the remaining
+items are shifted towards the front.
+
+Examples
+^^^^^^^^
+[source,c]
+----
+#include "vector.h"
+#include <string.h>
+
+char *str1 = "ONE";
+char *str2 = "TWO";
+char *str3 = "THREE";
+
+vec *vector = vec_new();
+vec_push(vector, str_dup(str1));
+vec_push(vector, str_dup(str2));
+vec_push(vector, str_dup(str3));
+
+vec_remove(vector, 1);
+
+assert(vec_size == 2);
+assert(strcmp(vec_pop(vector), str3) == 0);
+assert(strcmp(vec_pop(vector), str1) == 0);
+----
+
 [[vec_swap]]
 +void vec_swap(vec *self, int i, int j)+
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-- 
cgit v1.1

