document isl_map_plain_is_fixed
authorSven Verdoolaege <skimo@kotnet.org>
Sat, 6 Aug 2011 20:30:40 +0000 (22:30 +0200)
committerSven Verdoolaege <skimo@kotnet.org>
Sat, 6 Aug 2011 20:30:40 +0000 (22:30 +0200)
Signed-off-by: Sven Verdoolaege <skimo@kotnet.org>
doc/user.pod
include/isl/map.h

index 679d86a..243aaaa 100644 (file)
@@ -1448,6 +1448,19 @@ is already known to be empty.
        int isl_map_is_bijective(__isl_keep isl_map *map);
        int isl_union_map_is_bijective(__isl_keep isl_union_map *umap);
 
+=item * Position
+
+       int isl_basic_map_plain_is_fixed(
+               __isl_keep isl_basic_map *bmap,
+               enum isl_dim_type type, unsigned pos,
+               isl_int *val);
+       int isl_map_plain_is_fixed(__isl_keep isl_map *map,
+               enum isl_dim_type type, unsigned pos,
+               isl_int *val);
+
+Check if the relation obviously lies on a hyperplane where the given dimension
+has a fixed value and if so, return that value in C<*val>.
+
 =item * Wrapping
 
 The following functions check whether the domain of the given
index 6e075ca..95b7db6 100644 (file)
@@ -236,7 +236,7 @@ struct isl_basic_map *isl_map_copy_basic_map(struct isl_map *map);
 __isl_give isl_map *isl_map_drop_basic_map(__isl_take isl_map *map,
                                                __isl_keep isl_basic_map *bmap);
 
-int isl_basic_map_plain_is_fixed(struct isl_basic_map *bmap,
+int isl_basic_map_plain_is_fixed(__isl_keep isl_basic_map *bmap,
        enum isl_dim_type type, unsigned pos, isl_int *val);
 
 int isl_basic_map_image_is_bounded(__isl_keep isl_basic_map *bmap);
@@ -429,7 +429,7 @@ void isl_map_print_internal(__isl_keep isl_map *map, FILE *out, int indent);
 
 int isl_map_plain_input_is_fixed(__isl_keep isl_map *map,
                unsigned in, isl_int *val);
-int isl_map_plain_is_fixed(struct isl_map *map,
+int isl_map_plain_is_fixed(__isl_keep isl_map *map,
        enum isl_dim_type type, unsigned pos, isl_int *val);
 int isl_map_fast_is_fixed(__isl_keep isl_map *map,
        enum isl_dim_type type, unsigned pos, isl_int *val);