doc: document isl_constraint_is_equality
authorSven Verdoolaege <skimo@kotnet.org>
Fri, 4 Jun 2010 18:41:00 +0000 (20:41 +0200)
committerSven Verdoolaege <skimo@kotnet.org>
Fri, 4 Jun 2010 18:41:00 +0000 (20:41 +0200)
doc/user.pod
include/isl_constraint.h

index 8925fc0..2833ef9 100644 (file)
@@ -772,6 +772,12 @@ To iterate over the constraints of a basic set or map, use
 Again, the callback function C<fn> should return 0 if successful and
 -1 if an error occurs.  In the latter case, or if any other error
 occurs, the above functions will return -1.
+The constraint C<c> represents either an equality or an inequality.
+Use the following function to find out whether a constraint
+represents an equality.  If not, it represents an inequality.
+
+       int isl_constraint_is_equality(
+               __isl_keep isl_constraint *constraint);
 
 The coefficients of the constraints can be inspected using
 the following functions.
index e190066..f7ee563 100644 (file)
@@ -85,7 +85,7 @@ struct isl_constraint *isl_constraint_add_div(struct isl_constraint *constraint,
 void isl_constraint_clear(struct isl_constraint *constraint);
 struct isl_constraint *isl_constraint_negate(struct isl_constraint *constraint);
 
-int isl_constraint_is_equality(struct isl_constraint *constraint);
+int isl_constraint_is_equality(__isl_keep isl_constraint *constraint);
 
 __isl_give isl_basic_map *isl_basic_map_from_constraint(
        __isl_take isl_constraint *constraint);