doc: document isl_space_is_equal

Signed-off-by: Sven Verdoolaege <skimo@kotnet.org>

diff --git a/doc/user.pod b/doc/user.pod
index c2bfe06..af31a03 100644 (file)
--- a/doc/user.pod
+++ b/doc/user.pod
@@ -616,6 +616,12 @@ or whether it is a parameter space, use these functions:
        int isl_space_is_set(__isl_keep isl_space *space);
        int isl_space_is_map(__isl_keep isl_space *space);
 
+Spaces can be compared using the following function:
+
+       #include <isl/space.h>
+       int isl_space_is_equal(__isl_keep isl_space *space1,
+               __isl_keep isl_space *space2);
+
 It is often useful to create objects that live in the
 same space as some other object.  This can be accomplished
 by creating the new objects

diff --git a/include/isl/space.h b/include/isl/space.h
index e786442..e3d7e04 100644 (file)
--- a/include/isl/space.h
+++ b/include/isl/space.h
@@ -125,7 +125,8 @@ __isl_give isl_space *isl_space_zip(__isl_take isl_space *dim);
 int isl_space_can_curry(__isl_keep isl_space *space);
 __isl_give isl_space *isl_space_curry(__isl_take isl_space *space);
 
-int isl_space_is_equal(__isl_keep isl_space *dim1, __isl_keep isl_space *dim2);
+int isl_space_is_equal(__isl_keep isl_space *space1,
+       __isl_keep isl_space *space2);
 int isl_space_match(__isl_keep isl_space *dim1, enum isl_dim_type dim1_type,
        __isl_keep isl_space *dim2, enum isl_dim_type dim2_type);
 int isl_space_tuple_match(__isl_keep isl_space *dim1, enum isl_dim_type dim1_type,

diff --git a/isl_space.c b/isl_space.c
index 539be86..3ec09d2 100644 (file)
--- a/isl_space.c
+++ b/isl_space.c
@@ -1459,6 +1459,8 @@ __isl_give isl_space *isl_space_underlying(__isl_take isl_space *dim,
        return dim;
 }
 
+/* Are the two spaces the same, including positions and names of parameters?
+ */
 int isl_space_is_equal(__isl_keep isl_space *dim1, __isl_keep isl_space *dim2)
 {
        if (!dim1 || !dim2)