Add function comments.
[pspp-builds.git] / src / algorithm.h
index f8f2b84d877dd8c43ea5a01055ce587a71aefe2c..5482de1532ae094a896eb94abaa96e7d15532853 100644 (file)
@@ -1,5 +1,5 @@
-#ifndef SORT_ALGO_H
-#define SORT_ALGO_H 1
+#ifndef ALGORITHM_H
+#define ALGORITHM_H 1
 
 #include <stddef.h>
 
@@ -95,6 +95,18 @@ size_t copy_if (const void *array, size_t count, size_t size,
                 void *result,
                 algo_predicate_func *predicate, void *aux);
 
+/* Removes N elements starting at IDX from ARRAY, which consists
+   of COUNT elements of SIZE bytes each, by shifting the elements
+   following them, if any, into its position. */
+void remove_range (void *array, size_t count, size_t size,
+                   size_t idx, size_t n);
+
+/* Removes element IDX from ARRAY, which consists of COUNT
+   elements of SIZE bytes each, by shifting the elements
+   following it, if any, into its position. */
+void remove_element (void *array, size_t count, size_t size,
+                     size_t idx);
+
 /* Removes elements equal to ELEMENT from ARRAY, which consists
    of COUNT elements of SIZE bytes each.  Returns the number of
    remaining elements.  AUX is passed to COMPARE as auxiliary
@@ -190,4 +202,4 @@ int is_heap (const void *array, size_t count, size_t size,
              algo_compare_func *compare, void *aux);
 
 
-#endif /* sort-algo.h */
+#endif /* algorithm.h */