X-Git-Url: http://erislabs.net/gitweb/?a=blobdiff_plain;f=lib%2Fgl_oset.h;h=5a681eefd5479f995f837d916d58557c8926135d;hb=a74dcd0c2df4149148181beea2a8b5190619dbbe;hp=6c5d5eb42041a0983aacfe4bdb7d72206e5b126f;hpb=f0216ef8e9e0726edbb361c5d275380ca312870f;p=gnulib.git

diff --git a/lib/gl_oset.h b/lib/gl_oset.h
index 6c5d5eb42..5a681eefd 100644
--- a/lib/gl_oset.h
+++ b/lib/gl_oset.h
@@ -1,5 +1,5 @@
 /* Abstract ordered set data type.
-   Copyright (C) 2006 Free Software Foundation, Inc.
+   Copyright (C) 2006-2007 Free Software Foundation, Inc.
    Written by Bruno Haible <bruno@clisp.org>, 2006.
 
    This program is free software; you can redistribute it and/or modify
@@ -59,6 +59,7 @@ extern "C" {
    gl_oset_add                 O(n)   O(log n)
    gl_oset_remove              O(n)   O(log n)
    gl_oset_search            O(log n) O(log n)
+   gl_oset_search_atleast    O(log n) O(log n)
    gl_oset_iterator            O(1)   O(log n)
    gl_oset_iterator_next       O(1)   O(log n)
  */
@@ -69,6 +70,14 @@ extern "C" {
    NULL denotes pointer comparison.  */
 typedef int (*gl_setelement_compar_fn) (const void *elt1, const void *elt2);
 
+/* Type of function used to dispose an element once it's removed from a set.
+   NULL denotes a no-op.  */
+typedef void (*gl_setelement_dispose_fn) (const void *elt);
+
+/* Type of function used to compare an element with a threshold.
+   Return true if the element is greater or equal than the threshold.  */
+typedef bool (*gl_setelement_threshold_fn) (const void *elt, const void *threshold);
+
 struct gl_oset_impl;
 /* Type representing an entire ordered set.  */
 typedef struct gl_oset_impl * gl_oset_t;
@@ -79,9 +88,11 @@ typedef const struct gl_oset_implementation * gl_oset_implementation_t;
 
 /* Create an empty set.
    IMPLEMENTATION is one of GL_ARRAY_OSET, GL_AVLTREE_OSET, GL_RBTREE_OSET.
-   COMPAR_FN is an element comparison function or NULL.  */
+   COMPAR_FN is an element comparison function or NULL.
+   DISPOSE_FN is an element disposal function or NULL.  */
 extern gl_oset_t gl_oset_create_empty (gl_oset_implementation_t implementation,
-				       gl_setelement_compar_fn compar_fn);
+				       gl_setelement_compar_fn compar_fn,
+				       gl_setelement_dispose_fn dispose_fn);
 
 /* Return the current number of elements in an ordered set.  */
 extern size_t gl_oset_size (gl_oset_t set);
@@ -90,6 +101,16 @@ extern size_t gl_oset_size (gl_oset_t set);
    Return true if found, or false if not present in the set.  */
 extern bool gl_oset_search (gl_oset_t set, const void *elt);
 
+/* Search the least element in the ordered set that compares greater or equal
+   to the given THRESHOLD.  The representation of the THRESHOLD is defined
+   by the THRESHOLD_FN.
+   Return true and store the found element in *ELTP if found, otherwise return
+   false.  */
+extern bool gl_oset_search_atleast (gl_oset_t set,
+				    gl_setelement_threshold_fn threshold_fn,
+				    const void *threshold,
+				    const void **eltp);
+
 /* Add an element to an ordered set.
    Return true if it was not already in the set and added.  */
 extern bool gl_oset_add (gl_oset_t set, const void *elt);
@@ -138,15 +159,19 @@ extern void gl_oset_iterator_free (gl_oset_iterator_t *iterator);
 
 struct gl_oset_implementation
 {
-  // gl_oset_t functions.
+  /* gl_oset_t functions.  */
   gl_oset_t (*create_empty) (gl_oset_implementation_t implementation,
-			     gl_setelement_compar_fn compar_fn);
+			     gl_setelement_compar_fn compar_fn,
+			     gl_setelement_dispose_fn dispose_fn);
   size_t (*size) (gl_oset_t set);
   bool (*search) (gl_oset_t set, const void *elt);
+  bool (*search_atleast) (gl_oset_t set,
+			  gl_setelement_threshold_fn threshold_fn,
+			  const void *threshold, const void **eltp);
   bool (*add) (gl_oset_t set, const void *elt);
   bool (*remove) (gl_oset_t set, const void *elt);
   void (*oset_free) (gl_oset_t set);
-  // gl_oset_iterator_t functions.
+  /* gl_oset_iterator_t functions.  */
   gl_oset_iterator_t (*iterator) (gl_oset_t set);
   bool (*iterator_next) (gl_oset_iterator_t *iterator, const void **eltp);
   void (*iterator_free) (gl_oset_iterator_t *iterator);
@@ -156,6 +181,7 @@ struct gl_oset_impl_base
 {
   const struct gl_oset_implementation *vtable;
   gl_setelement_compar_fn compar_fn;
+  gl_setelement_dispose_fn dispose_fn;
 };
 
 #if HAVE_INLINE
@@ -167,9 +193,10 @@ struct gl_oset_impl_base
 # define gl_oset_create_empty gl_oset_create_empty_inline
 static inline gl_oset_t
 gl_oset_create_empty (gl_oset_implementation_t implementation,
-		      gl_setelement_compar_fn compar_fn)
+		      gl_setelement_compar_fn compar_fn,
+		      gl_setelement_dispose_fn dispose_fn)
 {
-  return implementation->create_empty (implementation, compar_fn);
+  return implementation->create_empty (implementation, compar_fn, dispose_fn);
 }
 
 # define gl_oset_size gl_oset_size_inline
@@ -186,6 +213,16 @@ gl_oset_search (gl_oset_t set, const void *elt)
   return ((const struct gl_oset_impl_base *) set)->vtable->search (set, elt);
 }
 
+# define gl_oset_search_atleast gl_oset_search_atleast_inline
+static inline bool
+gl_oset_search_atleast (gl_oset_t set,
+			gl_setelement_threshold_fn threshold_fn,
+			const void *threshold, const void **eltp)
+{
+  return ((const struct gl_oset_impl_base *) set)->vtable
+	 ->search_atleast (set, threshold_fn, threshold, eltp);
+}
+
 # define gl_oset_add gl_oset_add_inline
 static inline bool
 gl_oset_add (gl_oset_t set, const void *elt)