docs

[pspp] / src / libpspp / range-set.h

diff --git a/src/libpspp/range-set.h b/src/libpspp/range-set.h
index 3b7d04f4883710530b894a0f03e48fe7e60be39a..636fba8166c1b146cb1ed246352cdba1f30a9d24 100644 (file)
--- a/src/libpspp/range-set.h
+++ b/src/libpspp/range-set.h
@@ -1,5 +1,5 @@
 /* PSPP - a program for statistical analysis.
-   Copyright (C) 2007, 2009 Free Software Foundation, Inc.
+   Copyright (C) 2007, 2009, 2011 Free Software Foundation, Inc.
 
    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
@@ -25,7 +25,8 @@
 #define LIBPSPP_RANGE_SET_H
 
 #include <stdbool.h>
-#include <libpspp/bt.h>
+#include "libpspp/bt.h"
+#include "libpspp/cast.h"
 
 /* A set of ranges. */
 struct range_set
@@ -52,10 +53,10 @@ struct range_set *range_set_create_pool (struct pool *);
 struct range_set *range_set_clone (const struct range_set *, struct pool *);
 void range_set_destroy (struct range_set *);
 
-void range_set_insert (struct range_set *,
-                       unsigned long int start, unsigned long int width);
-void range_set_delete (struct range_set *,
-                       unsigned long int start, unsigned long int width);
+void range_set_set1 (struct range_set *,
+                     unsigned long int start, unsigned long int width);
+void range_set_set0 (struct range_set *,
+                     unsigned long int start, unsigned long int width);
 bool range_set_allocate (struct range_set *, unsigned long int request,
                          unsigned long int *start, unsigned long int *width);
 bool range_set_allocate_fully (struct range_set *, unsigned long int request,
@@ -66,10 +67,19 @@ unsigned long int range_set_scan (const struct range_set *,
 
 static inline bool range_set_is_empty (const struct range_set *);
 
+#define RANGE_SET_FOR_EACH(NODE, RANGE_SET)             \
+        for ((NODE) = range_set_first (RANGE_SET);      \
+             (NODE) != NULL;                            \
+             (NODE) = range_set_next (RANGE_SET, NODE))
+
 static inline const struct range_set_node *range_set_first (
   const struct range_set *);
 static inline const struct range_set_node *range_set_next (
   const struct range_set *, const struct range_set_node *);
+static inline const struct range_set_node *range_set_last (
+  const struct range_set *);
+static inline const struct range_set_node *range_set_prev (
+  const struct range_set *, const struct range_set_node *);
 static inline unsigned long int range_set_node_get_start (
   const struct range_set_node *);
 static inline unsigned long int range_set_node_get_end (
@@ -85,6 +95,10 @@ static inline struct range_set_node *range_set_next__ (
   const struct range_set *, const struct range_set_node *);
 static inline struct range_set_node *range_set_first__ (
   const struct range_set *);
+static inline struct range_set_node *range_set_prev__ (
+  const struct range_set *, const struct range_set_node *);
+static inline struct range_set_node *range_set_last__ (
+  const struct range_set *);
 
 /* Returns true if RS contains no 1-bits, false otherwise. */
 static inline bool
@@ -95,7 +109,7 @@ range_set_is_empty (const struct range_set *rs)
 
 /* Returns the node representing the first contiguous region of
    1-bits in RS, or a null pointer if RS is empty.
-   Any call to range_set_insert, range_set_delete, or
+   Any call to range_set_set1, range_set_set0, or
    range_set_allocate invalidates the returned node. */
 static inline const struct range_set_node *
 range_set_first (const struct range_set *rs)
@@ -108,16 +122,41 @@ range_set_first (const struct range_set *rs)
    pointer if NODE is the last region in RS.
    If NODE is null, returns the first region in RS, as for
    range_set_first.
-   Any call to range_set_insert, range_set_delete, or
+   Any call to range_set_set1, range_set_set0, or
    range_set_allocate invalidates the returned node. */
 static inline const struct range_set_node *
 range_set_next (const struct range_set *rs, const struct range_set_node *node)
 {
   return (node != NULL
-          ? range_set_next__ (rs, (struct range_set_node *) node)
+          ? range_set_next__ (rs, CONST_CAST (struct range_set_node *, node))
           : range_set_first__ (rs));
 }
 
+/* Returns the node representing the last contiguous region of
+   1-bits in RS, or a null pointer if RS is empty.
+   Any call to range_set_set1, range_set_set0, or
+   range_set_allocate invalidates the returned node. */
+static inline const struct range_set_node *
+range_set_last (const struct range_set *rs)
+{
+  return range_set_last__ (rs);
+}
+
+/* If NODE is nonnull, returns the node representing the previous
+   contiguous region of 1-bits in RS following NODE, or a null
+   pointer if NODE is the first region in RS.
+   If NODE is null, returns the last region in RS, as for
+   range_set_last.
+   Any call to range_set_set1, range_set_set0, or
+   range_set_allocate invalidates the returned node. */
+static inline const struct range_set_node *
+range_set_prev (const struct range_set *rs, const struct range_set_node *node)
+{
+  return (node != NULL
+          ? range_set_prev__ (rs, CONST_CAST (struct range_set_node *, node))
+          : range_set_last__ (rs));
+}
+
 /* Returns the position of the first 1-bit in NODE. */
 static inline unsigned long int
 range_set_node_get_start (const struct range_set_node *node)
@@ -146,7 +185,7 @@ range_set_node_get_width (const struct range_set_node *node)
 static inline struct range_set_node *
 range_set_node_from_bt__ (const struct bt_node *bt_node)
 {
-  return bt_node ? bt_data (bt_node, struct range_set_node, bt_node) : NULL;
+  return bt_node ? BT_DATA (bt_node, struct range_set_node, bt_node) : NULL;
 }
 
 /* Returns the next range_set_node in RS after NODE,
@@ -166,4 +205,21 @@ range_set_first__ (const struct range_set *rs)
   return range_set_node_from_bt__ (bt_first (&rs->bt));
 }
 
+/* Returns the previous range_set_node in RS after NODE,
+   or a null pointer if NODE is the first node in RS. */
+static inline struct range_set_node *
+range_set_prev__ (const struct range_set *rs,
+                  const struct range_set_node *node)
+{
+  return range_set_node_from_bt__ (bt_prev (&rs->bt, &node->bt_node));
+}
+
+/* Returns the last range_set_node in RS,
+   or a null pointer if RS is empty. */
+static inline struct range_set_node *
+range_set_last__ (const struct range_set *rs)
+{
+  return range_set_node_from_bt__ (bt_last (&rs->bt));
+}
+
 #endif /* libpspp/range-set.h */