Merge branch 'maint'

[platform/upstream/isl.git] / doc / user.pod

diff --git a/doc/user.pod b/doc/user.pod
index d0e41ae..e00ad5c 100644 (file)
--- a/doc/user.pod
+++ b/doc/user.pod
@@ -783,6 +783,9 @@ using the following functions.
                __isl_take isl_local_space *ls);
        __isl_give isl_local_space *isl_local_space_from_domain(
                __isl_take isl_local_space *ls);
+       __isl_give isl_local_space *isl_local_space_intersect(
+               __isl_take isl_local_space *ls1,
+               __isl_take isl_local_space *ls2);
        __isl_give isl_local_space *isl_local_space_add_dims(
                __isl_take isl_local_space *ls,
                enum isl_dim_type type, unsigned n);
@@ -2085,6 +2088,15 @@ existentially quantified variables.
        __isl_give isl_union_set *isl_union_set_lift(
                __isl_take isl_union_set *uset);
 
+Given a local space that contains the existentially quantified
+variables of a set, a basic relation that, when applied to
+a basic set, has essentially the same effect as C<isl_basic_set_lift>,
+can be constructed using the following function.
+
+       #include <isl/local_space.h>
+       __isl_give isl_basic_map *isl_local_space_lifting(
+               __isl_take isl_local_space *ls);
+
 =item * Internal Product
 
        __isl_give isl_basic_map *isl_basic_map_zip(
@@ -2465,6 +2477,36 @@ In case of union relations, the optimum is computed per space.
        __isl_give isl_union_map *isl_union_map_lexmax(
                __isl_take isl_union_map *umap);
 
+The following functions return their result in the form of
+a piecewise multi-affine expression
+(See L<"Piecewise Multiple Quasi Affine Expressions">),
+but are otherwise equivalent to the corresponding functions
+returning a basic set or relation.
+
+       __isl_give isl_pw_multi_aff *
+       isl_basic_map_lexmin_pw_multi_aff(
+               __isl_take isl_basic_map *bmap);
+       __isl_give isl_pw_multi_aff *
+       isl_basic_set_partial_lexmin_pw_multi_aff(
+               __isl_take isl_basic_set *bset,
+               __isl_take isl_basic_set *dom,
+               __isl_give isl_set **empty);
+       __isl_give isl_pw_multi_aff *
+       isl_basic_set_partial_lexmax_pw_multi_aff(
+               __isl_take isl_basic_set *bset,
+               __isl_take isl_basic_set *dom,
+               __isl_give isl_set **empty);
+       __isl_give isl_pw_multi_aff *
+       isl_basic_map_partial_lexmin_pw_multi_aff(
+               __isl_take isl_basic_map *bmap,
+               __isl_take isl_basic_set *dom,
+               __isl_give isl_set **empty);
+       __isl_give isl_pw_multi_aff *
+       isl_basic_map_partial_lexmax_pw_multi_aff(
+               __isl_take isl_basic_map *bmap,
+               __isl_take isl_basic_set *dom,
+               __isl_give isl_set **empty);
+
 =head2 Lists
 
 Lists are defined over several element types, including
@@ -2891,6 +2933,14 @@ the maximum of those of C<pwaff1> and C<pwaff2>.  If only one of
 C<pwaff1> or C<pwaff2> is defined on a given cell, then the
 associated expression is the defined one.
 
+An expression can be read from input using
+
+       #include <isl/aff.h>
+       __isl_give isl_aff *isl_aff_read_from_str(
+               isl_ctx *ctx, const char *str);
+       __isl_give isl_pw_aff *isl_pw_aff_read_from_str(
+               isl_ctx *ctx, const char *str);
+
 An expression can be printed using
 
        #include <isl/aff.h>
@@ -2925,6 +2975,15 @@ be created using the following functions.
                __isl_take isl_set *set,
                __isl_take isl_multi_aff *maff);
 
+A piecewise multiple quasi affine expression can also be initialized
+from an C<isl_set> or C<isl_map>, provided the C<isl_set> is a singleton
+and the C<isl_map> is single-valued.
+
+       __isl_give isl_pw_multi_aff *isl_pw_multi_aff_from_set(
+               __isl_take isl_set *set);
+       __isl_give isl_pw_multi_aff *isl_pw_multi_aff_from_map(
+               __isl_take isl_map *map);
+
 Multiple quasi affine expressions can be copied and freed using
 
        #include <isl/aff.h>
@@ -3010,10 +3069,25 @@ Operations include
        __isl_give isl_pw_multi_aff *isl_pw_multi_aff_intersect_domain(
                __isl_take isl_pw_multi_aff *pma,
                __isl_take isl_set *set);
+       __isl_give isl_multi_aff *isl_multi_aff_lift(
+               __isl_take isl_multi_aff *maff,
+               __isl_give isl_local_space **ls);
        __isl_give isl_multi_aff *isl_multi_aff_gist(
                __isl_take isl_multi_aff *maff,
                __isl_take isl_set *context);
 
+If the C<ls> argument of C<isl_multi_aff_lift> is not C<NULL>,
+then it is assigned the local space that lies at the basis of
+the lifting applied.
+
+An expression can be read from input using
+
+       #include <isl/aff.h>
+       __isl_give isl_multi_aff *isl_multi_aff_read_from_str(
+               isl_ctx *ctx, const char *str);
+       __isl_give isl_pw_multi_aff *isl_pw_multi_aff_read_from_str(
+               isl_ctx *ctx, const char *str);
+
 An expression can be printed using
 
        #include <isl/aff.h>
@@ -3134,7 +3208,13 @@ the number of points in the map
 
        [n] -> { [x] -> [y] : x,y >= 0 and 0 <= x + y <= n }
 
-=head3 Printing (Piecewise) Quasipolynomials
+=head3 Input and Output
+
+Piecewise quasipolynomials can be read from input using
+
+       __isl_give isl_union_pw_qpolynomial *
+       isl_union_pw_qpolynomial_read_from_str(
+               isl_ctx *ctx, const char *str);
 
 Quasipolynomials and piecewise quasipolynomials can be printed
 using the following functions.